dependency:unpack

Full name:

org.apache.maven.plugins:maven-dependency-plugin:2.3:unpack

Description:

Goal that retrieves a list of artifacts from the repository and unpacks them in a defined location.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: process-sources.

Required Parameters

Name Type Since Description
artifactItems List 1.0 Collection of ArtifactItems to work on. (ArtifactItem contains groupId, artifactId, version, type, classifier, location, destFileName, markerFile and overwrite.) See Usage for details.

Optional Parameters

Name Type Since Description
excludes String 2.0-alpha-5 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 );)
includes String 2.0-alpha-5 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 );)
localRepositoryDirectory File 2.2 Path to override default local repository during plugin's execution. To remove all downloaded artifacts as part of the build, set this value to a location under your project's target directory
markersDirectory File 1.0 Directory to store flag files after unpack
outputAbsoluteArtifactFilename boolean 2.0 Output absolute filename for resolved artifacts
Default value is: false.
outputDirectory File 1.0 Default location used for mojo unless overridden in ArtifactItem
Default value is: ${project.build.directory}/dependency.
overWriteIfNewer boolean 2.0 Overwrite if newer
Default value is: true.
overWriteReleases boolean 1.0 Overwrite release artifacts
Default value is: false.
overWriteSnapshots boolean 1.0 Overwrite snapshot artifacts
Default value is: false.
silent boolean 2.0 If the plugin should be silent.
Default value is: false.
skip boolean 2.2 Skip the execution
Default value is: false.

Parameter Details

artifactItems:

Collection of ArtifactItems to work on. (ArtifactItem contains groupId, artifactId, version, type, classifier, location, destFileName, markerFile and overwrite.) See Usage for details.
  • Type: java.util.List
  • Since: 1.0
  • Required: Yes

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 );)
  • Type: java.lang.String
  • Since: 2.0-alpha-5
  • Required: No
  • Expression: ${mdep.unpack.excludes}

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 );)
  • Type: java.lang.String
  • Since: 2.0-alpha-5
  • Required: No
  • Expression: ${mdep.unpack.includes}

localRepositoryDirectory:

Path to override default local repository during plugin's execution. To remove all downloaded artifacts as part of the build, set this value to a location under your project's target directory
  • Type: java.io.File
  • Since: 2.2
  • Required: No

markersDirectory:

Directory to store flag files after unpack
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Expression: ${project.build.directory}/dependency-maven-plugin-markers

outputAbsoluteArtifactFilename:

Output absolute filename for resolved artifacts
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${outputAbsoluteArtifactFilename}
  • Default: false

outputDirectory:

Default location used for mojo unless overridden in ArtifactItem
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Expression: ${outputDirectory}
  • Default: ${project.build.directory}/dependency

overWriteIfNewer:

Overwrite if newer
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${mdep.overIfNewer}
  • Default: true

overWriteReleases:

Overwrite release artifacts
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${mdep.overWriteReleases}
  • Default: false

overWriteSnapshots:

Overwrite snapshot artifacts
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${mdep.overWriteSnapshots}
  • Default: false

silent:

If the plugin should be silent.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${silent}
  • Default: false

skip:

Skip the execution
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${mdep.skip}
  • Default: false