Package org.apache.maven.plugins.dependency.fromDependencies

Class UnpackDependenciesMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="unpack-dependencies",
      requiresDependencyResolution=TEST,
      defaultPhase=PROCESS_SOURCES,
      threadSafe=true)
public class UnpackDependenciesMojo
extends AbstractFromDependenciesMojo
    Goal that unpacks the project dependencies from the repository to a defined location.
    Since:
    1.0

    • Field Detail

      • includes

        @Parameter(property="mdep.unpack.includes")
private java.lang.String includes
        A comma separated list of file patterns to include when unpacking the artifact. i.e. **/*.xml,**/*.properties NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name );)
        Since:
        2.0

      • excludes

        @Parameter(property="mdep.unpack.excludes")
private java.lang.String excludes
        A comma separated list of file patterns to exclude when unpacking the artifact. i.e. **/*.xml,**/*.properties NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name );)
        Since:
        2.0

      • ignorePermissions

        @Parameter(property="dependency.ignorePermissions",
           defaultValue="false")
private boolean ignorePermissions
        Ignore to set file permissions when unpacking a dependency.
        Since:
        2.7

      • encoding

        @Parameter(property="mdep.unpack.encoding")
private java.lang.String encoding
        Encoding of artifacts.
        Since:
        3.0

      • fileMappers

        @Parameter(property="mdep.unpack.filemappers")
private org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers
        FileMappers to be used for rewriting each target path, or null if no rewriting shall happen.
        Since:
        3.1.2

    • Constructor Detail

      • UnpackDependenciesMojo

        @Inject
public UnpackDependenciesMojo​(org.apache.maven.execution.MavenSession session,
                              org.sonatype.plexus.build.incremental.BuildContext buildContext,
                              org.apache.maven.project.MavenProject project,
                              ResolverUtil resolverUtil,
                              org.apache.maven.project.ProjectBuilder projectBuilder,
                              org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager,
                              UnpackUtil unpackUtil)

    • Method Detail

      • doExecute

        protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException
        Main entry into mojo. This method gets the dependencies and iterates through each one passing it to DependencyUtil.unpackFile().
        Specified by:
        doExecute in class AbstractDependencyMojo
        Throws:
        org.apache.maven.plugin.MojoExecutionException - with a message if an error occurs
        See Also:
        AbstractDependencyFilterMojo.getDependencySets(boolean)

      • getMarkedArtifactFilter

        protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter getMarkedArtifactFilter()
        Description copied from class: AbstractDependencyFilterMojo
        Return an ArtifactsFilter indicating which artifacts must be filtered out.
        Specified by:
        getMarkedArtifactFilter in class AbstractDependencyFilterMojo
        Returns:
        an ArtifactsFilter indicating which artifacts must be filtered out

      • getExcludes

        public java.lang.String getExcludes()
        Returns:
        returns a comma separated list of excluded items

      • setExcludes

        public void setExcludes​(java.lang.String excludes)
        Parameters:
        excludes - a comma separated list of items to exclude i.e. **\/*.xml, **\/*.properties

      • getIncludes

        public java.lang.String getIncludes()
        Returns:
        returns a comma separated list of included items

      • setIncludes

        public void setIncludes​(java.lang.String includes)
        Parameters:
        includes - a comma separated list of items to include i.e. **\/*.xml, **\/*.properties

      • setEncoding

        public void setEncoding​(java.lang.String encoding)
        Parameters:
        encoding - the encoding to set
        Since:
        3.0

      • getEncoding

        public java.lang.String getEncoding()
        Returns:
        returns the encoding
        Since:
        3.0

      • getFileMappers

        public org.codehaus.plexus.components.io.filemappers.FileMapper[] getFileMappers()
        Returns:
        FileMappers to be used for rewriting each target path, or null if no rewriting shall happen
        Since:
        3.1.2

      • setFileMappers

        public void setFileMappers​(org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers)
        Parameters:
        fileMappers - FileMappers to be used for rewriting each target path, or null if no rewriting shall happen
        Since:
        3.1.2