java.lang.Object
org.apache.maven.plugin.AbstractMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="unpack", defaultPhase=PROCESS_SOURCES, requiresProject=false, threadSafe=true) public class UnpackMojo extends AbstractFromConfigurationMojo
Goal that retrieves a list of artifacts from the repository and unpacks them in a defined location.
Since:
1.0
  • Field Details

    • markersDirectory

      @Parameter(defaultValue="${project.build.directory}/dependency-maven-plugin-markers") private File markersDirectory
      Directory to store flag files after unpack
    • includes

      @Parameter(property="mdep.unpack.includes") private 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-alpha-5
    • excludes

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

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

      @Parameter(property="artifact") private String artifact
      The artifact to unpack from command line. A string of the form groupId:artifactId:version[:packaging[:classifier]]. Use AbstractFromConfigurationMojo.artifactItems within the POM configuration.
  • Constructor Details

    • UnpackMojo

      public UnpackMojo()
  • Method Details

    • doExecute

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

      private void unpackArtifact(ArtifactItem artifactItem) throws org.apache.maven.plugin.MojoExecutionException
      This method gets the Artifact object and calls DependencyUtil.unpackFile.
      Parameters:
      artifactItem - containing the information about the Artifact to unpack.
      Throws:
      org.apache.maven.plugin.MojoExecutionException - with a message if an error occurs.
      See Also:
    • getMarkedArtifactFilter

      ArtifactItemFilter getMarkedArtifactFilter(ArtifactItem item)
      Specified by:
      getMarkedArtifactFilter in class AbstractFromConfigurationMojo
    • getProcessedArtifactItems

      protected List<ArtifactItem> getProcessedArtifactItems(boolean removeVersion) throws org.apache.maven.plugin.MojoExecutionException
      Parameters:
      removeVersion - removeVersion.
      Returns:
      list of ArtifactItem
      Throws:
      org.apache.maven.plugin.MojoExecutionException - in case of an error.
    • getMarkersDirectory

      public File getMarkersDirectory()
      Returns:
      Returns the markersDirectory.
    • setMarkersDirectory

      public void setMarkersDirectory(File theMarkersDirectory)
      Parameters:
      theMarkersDirectory - The markersDirectory to set.
    • getExcludes

      public String getExcludes()
      Returns:
      Returns a comma separated list of excluded items
    • setExcludes

      public void setExcludes(String excludes)
      Parameters:
      excludes - A comma separated list of items to exclude i.e. **\/*.xml, **\/*.properties
    • getIncludes

      public String getIncludes()
      Returns:
      Returns a comma separated list of included items
    • setIncludes

      public void setIncludes(String includes)
      Parameters:
      includes - A comma separated list of items to include i.e. **\/*.xml, **\/*.properties
    • 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