ShadeMojo (Mule Extensions Maven Shade Plugin 1.0.3 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugins.shade.mojo.ShadeMojo

All Implemented Interfaces:

ContextEnabled, Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Direct Known Subclasses:

ExtensionShadeMojo
```
public class ShadeMojo
extends AbstractMojo
implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
```
Mojo that performs shading delegating to the Shader component.

Author:

Jason van Zyl, Mauro Talevi, David Blevins, Hiram Chirino

Field Summary

Fields
Modifier and Type	Field and Description
`protected ArtifactResolver`	`artifactResolver` Artifact resolver, needed to download source jars for inclusion in classpath.
`protected ArtifactSet`	`artifactSet` Artifacts to include/exclude from the final artifact.
`protected boolean`	`createDependencyReducedPom` Flag whether to generate a simplified POM for the shaded artifact.
`protected boolean`	`createSourcesJar` When true, it will attempt to create a sources jar as well
`protected boolean`	`createTestSourcesJar` When true, it will attempt to create a test sources jar.
`protected DependencyGraphBuilder`	`dependencyGraphBuilder` The dependency graph builder to use.
`protected File`	`dependencyReducedPomLocation` Where to put the dependency reduced pom.
`protected ArchiveFilter[]`	`filters` Archive Filters to be used.
`protected String`	`finalName` The name of the shaded artifactId.
`protected boolean`	`generateUniqueDependencyReducedPom` Create a dependency-reduced POM in ${basedir}/drp-UNIQUE.pom.
`protected boolean`	`keepDependenciesWithProvidedScope` When true, dependencies are kept in the pom but with scope 'provided'; when false, the dependency is removed.
`protected ArtifactRepository`	`localRepository` Local maven repository.
`protected boolean`	`minimizeJar` When true, dependencies will be stripped down on the class level to only the transitive hull required for the artifact.
`protected File`	`outputDirectory` The destination directory for the shaded artifact.
`protected File`	`outputFile` The path to the output file for the shaded artifact.
`protected org.codehaus.plexus.PlexusContainer`	`plexusContainer`
`protected MavenProject`	`project` The current Maven project.
`protected ProjectBuilder`	`projectBuilder` ProjectBuilder, needed to create projects from the artifacts.
`protected MavenProjectHelper`	`projectHelper`
`protected boolean`	`promoteTransitiveDependencies` When true, transitive deps of removed dependencies are promoted to direct dependencies.
`protected PackageRelocation[]`	`relocations` Packages to be relocated.
`protected List<ArtifactRepository>`	`remoteArtifactRepositories` Remote repositories which will be searched for source attachments.
`protected MavenSession`	`session` The current Maven session.
`protected boolean`	`shadedArtifactAttached` Defines whether the shaded artifact should be attached as classifier to the original artifact.
`protected String`	`shadedArtifactId` The name of the shaded artifactId.
`protected String`	`shadedClassifierName` The name of the classifier used in case the shaded artifact is attached.
`protected String`	`shadedGroupFilter` If specified, this will include only artifacts which have groupIds which start with this.
`protected Shader`	`shader`
`protected String`	`shaderHint` You can pass here the roleHint about your own Shader implementation plexus component.
`protected boolean`	`shadeSourcesContent` When true, it will attempt to shade the contents of the java source files when creating the sources jar.
`protected boolean`	`shadeTestJar` When true, creates a shaded test-jar artifact as well.
`protected boolean`	`skipShade` When true, skips shading all artifacts.
`protected ResourceTransformer[]`	`transformers` Resource transformers to be used.
`protected boolean`	`useBaseVersion` When true, the version of each dependency of the reduced pom will be based on the baseVersion of the original dependency instead of its resolved version.

Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE

Constructor Summary

Constructors
Constructor and Description

ShadeMojo()

Constructors
Constructor and Description
`ShadeMojo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addSystemScopedDependencyFromNonInterpolatedPom(List<Dependency> dependencies, List<Dependency> originalDependencies)`
`void`	`contextualize(org.codehaus.plexus.context.Context context)`
`protected void`	`copyFiles(File source, File target)`
`protected Dependency`	`createDependency(Artifact artifact)`
`protected void`	`createDependencyReducedPom(Set<String> artifactsToRemove)`
`protected void`	`createErrorOutput()`
`protected ShadeRequest`	`createShadeSourcesRequest(String shade, Set<File> testArtifacts, File testJar, List<Filter> filters, List<Relocator> relocators, List<ResourceTransformer> resourceTransformers)`
`void`	`execute()`
`protected List<Filter>`	`getFilters()`
`protected String`	`getId(Artifact artifact)`
`protected String`	`getId(Dependency dependency)`
`protected String`	`getId(String groupId, String artifactId, String type, String classifier)`
`protected List<Relocator>`	`getRelocators()`
`protected List<ResourceTransformer>`	`getResourceTransformers()`
`protected boolean`	`invalidMainArtifact()`
`protected void`	`processArtifactSelectors(Set<File> artifacts, Set<String> artifactIds, Set<File> sourceArtifacts, Set<File> testArtifacts, Set<File> testSourceArtifacts, org.apache.maven.plugins.shade.mojo.ArtifactSelector artifactSelector)`
`protected void`	`removeSystemScopedDependencies(Set<String> artifactsToRemove, List<Dependency> originalDependencies)`
`protected void`	`replaceFile(File oldFile, File newFile)`
`protected File`	`resolveArtifactForClassifier(Artifact artifact, String classifier)`
`protected void`	`rewriteDependencyReducedPomIfWeHaveReduction(List<Dependency> dependencies, boolean modified, List<Dependency> transitiveDeps, Model model)`
`protected void`	`setupHintedShader()`
`protected File`	`shadedArtifactFile(String classifier)`
`protected File`	`shadedArtifactFileWithClassifier()`
`protected File`	`shadedArtifactFileWithClassifier(String classifier)`
`protected File`	`shadedSourceArtifactFileWithClassifier()`
`protected File`	`shadedSourcesArtifactFile()`
`protected File`	`shadedTestArtifactFile()`
`protected File`	`shadedTestArtifactFileWithClassifier()`
`protected File`	`shadedTestSourceArtifactFileWithClassifier()`
`protected File`	`shadedTestSourcesArtifactFile()`
`protected ShadeRequest`	`shadeRequest(String shade, Set<File> artifacts, File outputJar, List<Filter> filters, List<Relocator> relocators, List<ResourceTransformer> resourceTransformers)`
`protected List<ResourceTransformer>`	`toResourceTransformers(String shade, List<ResourceTransformer> resourceTransformers)`
`boolean`	`updateExcludesInDeps(MavenProject project, List<Dependency> dependencies, List<Dependency> transitiveDeps)`

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- session
```
@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected MavenSession session
```
  The current Maven session.
- project
```
@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected MavenProject project
```
  The current Maven project.
- projectHelper
```
@Component
protected MavenProjectHelper projectHelper
```
- shader
```
@Component(hint="default",
           role=Shader.class)
protected Shader shader
```
- dependencyGraphBuilder
```
@Component
protected DependencyGraphBuilder dependencyGraphBuilder
```
  The dependency graph builder to use.
- projectBuilder
```
@Component
protected ProjectBuilder projectBuilder
```
  ProjectBuilder, needed to create projects from the artifacts.
- remoteArtifactRepositories
```
@Parameter(readonly=true,
           required=true,
           defaultValue="${project.remoteArtifactRepositories}")
protected List<ArtifactRepository> remoteArtifactRepositories
```
  Remote repositories which will be searched for source attachments.
- localRepository
```
@Parameter(readonly=true,
           required=true,
           defaultValue="${localRepository}")
protected ArtifactRepository localRepository
```
  Local maven repository.
- artifactResolver
```
@Component
protected ArtifactResolver artifactResolver
```
  Artifact resolver, needed to download source jars for inclusion in classpath.
- artifactSet
```
@Parameter
protected ArtifactSet artifactSet
```
  Artifacts to include/exclude from the final artifact. Artifacts are denoted by composite identifiers of the general form groupId:artifactId:type:classifier. Since version 1.3, the wildcard characters '*' and '?' can be used within the sub parts of those composite identifiers to do pattern matching. For convenience, the syntax groupId is equivalent to groupId:*:*:*, groupId:artifactId is equivalent to groupId:artifactId:*:* and groupId:artifactId:classifier is equivalent to groupId:artifactId:*:classifier. For example:
```
 <artifactSet>
   <includes>
     <include>org.apache.maven:*</include>
   </includes>
   <excludes>
     <exclude>*:maven-core</exclude>
   </excludes>
 </artifactSet>
 
```
- relocations
```
@Parameter
protected PackageRelocation[] relocations
```
  Packages to be relocated. For example:
```
 <relocations>
   <relocation>
     <pattern>org.apache</pattern>
     <shadedPattern>hidden.org.apache</shadedPattern>
     <includes>
       <include>org.apache.maven.*</include>
     </includes>
     <excludes>
       <exclude>org.apache.maven.Public*</exclude>
     </excludes>
   </relocation>
 </relocations>
 
```
  Note: Support for includes exists only since version 1.4.
- transformers
```
@Parameter
protected ResourceTransformer[] transformers
```
  Resource transformers to be used. Please see the "Examples" section for more information on available transformers and their configuration.
- filters
```
@Parameter
protected ArchiveFilter[] filters
```
  Archive Filters to be used. Allows you to specify an artifact in the form of a composite identifier as used by artifactSet and a set of include/exclude file patterns for filtering which contents of the archive are added to the shaded jar. From a logical perspective, includes are processed before excludes, thus it's possible to use an include to collect a set of files from the archive then use excludes to further reduce the set. By default, all files are included and no files are excluded. If multiple filters apply to an artifact, the intersection of the matched files will be included in the final JAR. For example:
```
 <filters>
   <filter>
     <artifact>junit:junit</artifact>
     <includes>
       <include>org/junit/**</include>
     </includes>
     <excludes>
       <exclude>org/junit/experimental/**</exclude>
     </excludes>
   </filter>
 </filters>
 
```
- outputDirectory
```
@Parameter(defaultValue="${project.build.directory}")
protected File outputDirectory
```
  The destination directory for the shaded artifact.
- finalName
```
@Parameter
protected String finalName
```
  The name of the shaded artifactId.
  If you like to change the name of the native artifact, you may use the <build><finalName> setting. If this is set to something different than <build><finalName>, no file replacement will be performed, even if shadedArtifactAttached is being used.
- shadedArtifactId
```
@Parameter(defaultValue="${project.artifactId}")
protected String shadedArtifactId
```
  The name of the shaded artifactId. So you may want to use a different artifactId and keep the standard version. If the original artifactId was "foo" then the final artifact would be something like foo-1.0.jar. So if you change the artifactId you might have something like foo-special-1.0.jar.
- shadedGroupFilter
```
@Parameter
protected String shadedGroupFilter
```
  If specified, this will include only artifacts which have groupIds which start with this.
- shadedArtifactAttached
```
@Parameter
protected boolean shadedArtifactAttached
```
  Defines whether the shaded artifact should be attached as classifier to the original artifact. If false, the shaded jar will be the main artifact of the project
- createDependencyReducedPom
```
@Parameter(defaultValue="true")
protected boolean createDependencyReducedPom
```
  Flag whether to generate a simplified POM for the shaded artifact. If set to true, dependencies that have been included into the uber JAR will be removed from the <dependencies> section of the generated POM. The reduced POM will be named dependency-reduced-pom.xml and is stored into the same directory as the shaded artifact. Unless you also specify dependencyReducedPomLocation, the plugin will create a temporary file named dependency-reduced-pom.xml in the project basedir.
- dependencyReducedPomLocation
```
@Parameter(defaultValue="${basedir}/dependency-reduced-pom.xml")
protected File dependencyReducedPomLocation
```
  Where to put the dependency reduced pom. Note: setting a value for this parameter with a directory other than ${basedir} will change the value of ${basedir} for all executions that come after the shade execution. This is often not what you want. This is considered an open issue with this plugin.
  
  Since:
  
  1.7
- generateUniqueDependencyReducedPom
```
@Parameter(defaultValue="false")
protected boolean generateUniqueDependencyReducedPom
```
  Create a dependency-reduced POM in ${basedir}/drp-UNIQUE.pom. This avoids build collisions of parallel builds without moving the dependency-reduced POM to a different directory. The property maven.shade.dependency-reduced-pom is set to the generated filename.
  
  Since:
  
  1.7.2
- keepDependenciesWithProvidedScope
```
@Parameter
protected boolean keepDependenciesWithProvidedScope
```
  When true, dependencies are kept in the pom but with scope 'provided'; when false, the dependency is removed.
- promoteTransitiveDependencies
```
@Parameter
protected boolean promoteTransitiveDependencies
```
  When true, transitive deps of removed dependencies are promoted to direct dependencies. This should allow the drop in replacement of the removed deps with the new shaded jar and everything should still work.
- shadedClassifierName
```
@Parameter(defaultValue="shaded")
protected String shadedClassifierName
```
  The name of the classifier used in case the shaded artifact is attached.
- createSourcesJar
```
@Parameter
protected boolean createSourcesJar
```
  When true, it will attempt to create a sources jar as well
- createTestSourcesJar
```
@Parameter
protected boolean createTestSourcesJar
```
  When true, it will attempt to create a test sources jar.
- shadeSourcesContent
```
@Parameter(property="shadeSourcesContent",
           defaultValue="false")
protected boolean shadeSourcesContent
```
  When true, it will attempt to shade the contents of the java source files when creating the sources jar. When false, it will just relocate the java source files to the shaded paths, but will not modify the actual contents of the java source files.
- minimizeJar
```
@Parameter
protected boolean minimizeJar
```
  When true, dependencies will be stripped down on the class level to only the transitive hull required for the artifact. Note: Usage of this feature requires Java 1.5 or higher.
  
  Since:
  
  1.4
- outputFile
```
@Parameter
protected File outputFile
```
  The path to the output file for the shaded artifact. When this parameter is set, the created archive will neither replace the project's main artifact nor will it be attached. Hence, this parameter causes the parameters finalName, shadedArtifactAttached, shadedClassifierName and createDependencyReducedPom to be ignored when used.
  
  Since:
  
  1.3
- shaderHint
```
@Parameter
protected String shaderHint
```
  You can pass here the roleHint about your own Shader implementation plexus component.
  
  Since:
  
  1.6
- useBaseVersion
```
@Parameter(defaultValue="false")
protected boolean useBaseVersion
```
  When true, the version of each dependency of the reduced pom will be based on the baseVersion of the original dependency instead of its resolved version. For example, if the original pom (transitively) depends on a:a:2.7-SNAPSHOT, if useBaseVersion is set to false, the reduced pom will depend on a:a:2.7-20130312.222222-12 whereas if useBaseVersion is set to true, the reduced pom will depend on a:a:2.7-SNAPSHOT
  
  Since:
  
  3.0
- shadeTestJar
```
@Parameter(defaultValue="false")
protected boolean shadeTestJar
```
  When true, creates a shaded test-jar artifact as well.
- skipShade
```
@Parameter(defaultValue="false")
protected boolean skipShade
```
  When true, skips shading all artifacts.
  
  Since:
  
  1.0.3
- plexusContainer
```
protected org.codehaus.plexus.PlexusContainer plexusContainer
```
  Since:
  
  1.6

Constructor Detail
- ShadeMojo
```
public ShadeMojo()
```

Method Detail

contextualize
```
public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException
```
Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException

execute
```
public void execute()
             throws MojoExecutionException
```
Specified by:

execute in interface Mojo

Throws:

MojoExecutionException - in case of an error.

createErrorOutput
```
protected void createErrorOutput()
```

shadeRequest

protected ShadeRequest shadeRequest(String shade,
                                    Set<File> artifacts,
                                    File outputJar,
                                    List<Filter> filters,
                                    List<Relocator> relocators,
                                    List<ResourceTransformer> resourceTransformers)

createShadeSourcesRequest

protected ShadeRequest createShadeSourcesRequest(String shade,
                                                 Set<File> testArtifacts,
                                                 File testJar,
                                                 List<Filter> filters,
                                                 List<Relocator> relocators,
                                                 List<ResourceTransformer> resourceTransformers)

setupHintedShader

protected void setupHintedShader()
                          throws MojoExecutionException

Throws:: MojoExecutionException

processArtifactSelectors

protected void processArtifactSelectors(Set<File> artifacts,
                                        Set<String> artifactIds,
                                        Set<File> sourceArtifacts,
                                        Set<File> testArtifacts,
                                        Set<File> testSourceArtifacts,
                                        org.apache.maven.plugins.shade.mojo.ArtifactSelector artifactSelector)

invalidMainArtifact

protected boolean invalidMainArtifact()

replaceFile

protected void replaceFile(File oldFile,
                           File newFile)
                    throws MojoExecutionException

Throws:: MojoExecutionException

copyFiles

protected void copyFiles(File source,
                         File target)
                  throws IOException

Throws:: IOException

resolveArtifactForClassifier

protected File resolveArtifactForClassifier(Artifact artifact,
                                            String classifier)

getRelocators

protected List<Relocator> getRelocators()

getResourceTransformers

protected List<ResourceTransformer> getResourceTransformers()

getFilters

protected List<Filter> getFilters()
                           throws MojoExecutionException

Throws:: MojoExecutionException

shadedArtifactFileWithClassifier

protected File shadedArtifactFileWithClassifier()

shadedSourceArtifactFileWithClassifier

protected File shadedSourceArtifactFileWithClassifier()

shadedTestSourceArtifactFileWithClassifier

protected File shadedTestSourceArtifactFileWithClassifier()

shadedArtifactFileWithClassifier

protected File shadedArtifactFileWithClassifier(String classifier)

shadedTestArtifactFileWithClassifier

protected File shadedTestArtifactFileWithClassifier()

shadedSourcesArtifactFile

protected File shadedSourcesArtifactFile()

shadedTestSourcesArtifactFile

protected File shadedTestSourcesArtifactFile()

shadedArtifactFile

protected File shadedArtifactFile(String classifier)

shadedTestArtifactFile

protected File shadedTestArtifactFile()

createDependencyReducedPom

protected void createDependencyReducedPom(Set<String> artifactsToRemove)
                                   throws IOException,
                                          DependencyGraphBuilderException,
                                          ProjectBuildingException

Throws:: IOException; DependencyGraphBuilderException; ProjectBuildingException

rewriteDependencyReducedPomIfWeHaveReduction

protected void rewriteDependencyReducedPomIfWeHaveReduction(List<Dependency> dependencies,
                                                            boolean modified,
                                                            List<Dependency> transitiveDeps,
                                                            Model model)
                                                     throws IOException,
                                                            ProjectBuildingException,
                                                            DependencyGraphBuilderException

Throws:: IOException; ProjectBuildingException; DependencyGraphBuilderException

removeSystemScopedDependencies

protected void removeSystemScopedDependencies(Set<String> artifactsToRemove,
                                              List<Dependency> originalDependencies)

addSystemScopedDependencyFromNonInterpolatedPom

protected void addSystemScopedDependencyFromNonInterpolatedPom(List<Dependency> dependencies,
                                                               List<Dependency> originalDependencies)

createDependency

protected Dependency createDependency(Artifact artifact)

getId

protected String getId(Artifact artifact)

getId

protected String getId(Dependency dependency)

getId

protected String getId(String groupId,
                       String artifactId,
                       String type,
                       String classifier)

updateExcludesInDeps

public boolean updateExcludesInDeps(MavenProject project,
                                    List<Dependency> dependencies,
                                    List<Dependency> transitiveDeps)
                             throws DependencyGraphBuilderException

Throws:: DependencyGraphBuilderException

toResourceTransformers

protected List<ResourceTransformer> toResourceTransformers(String shade,
                                                           List<ResourceTransformer> resourceTransformers)

Class ShadeMojo

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Field Detail

session

project

projectHelper

shader

dependencyGraphBuilder

projectBuilder

remoteArtifactRepositories

localRepository

artifactResolver

artifactSet

relocations

transformers

filters

outputDirectory

finalName

shadedArtifactId

shadedGroupFilter

shadedArtifactAttached

createDependencyReducedPom

dependencyReducedPomLocation

generateUniqueDependencyReducedPom

keepDependenciesWithProvidedScope

promoteTransitiveDependencies

shadedClassifierName

createSourcesJar

createTestSourcesJar

shadeSourcesContent

minimizeJar

outputFile

shaderHint

useBaseVersion

shadeTestJar

skipShade

plexusContainer

Constructor Detail

ShadeMojo

Method Detail

contextualize

execute

createErrorOutput

shadeRequest

createShadeSourcesRequest

setupHintedShader

processArtifactSelectors

invalidMainArtifact

replaceFile

copyFiles

resolveArtifactForClassifier

getRelocators

getResourceTransformers

getFilters

shadedArtifactFileWithClassifier

shadedSourceArtifactFileWithClassifier

shadedTestSourceArtifactFileWithClassifier

shadedArtifactFileWithClassifier

shadedTestArtifactFileWithClassifier

shadedSourcesArtifactFile

shadedTestSourcesArtifactFile

shadedArtifactFile

shadedTestArtifactFile

createDependencyReducedPom

rewriteDependencyReducedPomIfWeHaveReduction

removeSystemScopedDependencies

addSystemScopedDependencyFromNonInterpolatedPom

createDependency

getId

getId

getId

updateExcludesInDeps

toResourceTransformers