Apache Maven Dependency Plugin – dependency:unpack

dependency:unpack

Full name:

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

Description:

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

Attributes:

The goal is thread-safe and supports parallel builds.
Since version: 1.0.
Binds by default to the lifecycle phase: process-sources.

Optional Parameters

Name	Type	Since	Description
`<artifact>`	`String`	`-`	The artifact to unpack from command line. A string of the form `groupId:artifactId:version[:packaging[:classifier]]`. Use `artifactItems` within the POM configuration. User property is: `artifact`.
`<artifactItems>`	`List<ArtifactItem>`	`1.0`	Collection of ArtifactItems to work on. (ArtifactItem contains groupId, artifactId, version, type, classifier, outputDirectory, destFileName, overWrite and encoding.) See Usage for details.
`<excludes>`	`String`	`2.0-alpha-5`	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 );`) User property is: `mdep.unpack.excludes`.
`<fileMappers>`	`FileMapper[]`	`3.1.2`	`org.codehaus.plexus.components.io.filemappers.FileMapper` to be used for rewriting each target path, or `null` if no rewriting shall happen. User property is: `mdep.unpack.filemappers`.
`<ignorePermissions>`	`boolean`	`2.7`	ignore to set file permissions when unpacking a dependency Default value is: `false`. User property is: `dependency.ignorePermissions`.
`<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 );`) User property is: `mdep.unpack.includes`.
`<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`	`-`	Directory to store flag files after unpack Default value is: `${project.build.directory}/dependency-maven-plugin-markers`.
`<outputAbsoluteArtifactFilename>`	`boolean`	`2.0`	Output absolute filename for resolved artifacts Default value is: `false`. User property is: `outputAbsoluteArtifactFilename`.
`<outputDirectory>`	`File`	`1.0`	Default output location used for mojo, unless overridden in ArtifactItem. Default value is: `${project.build.directory}/dependency`. User property is: `outputDirectory`.
`<overWriteIfNewer>`	`boolean`	`2.0`	Overwrite if newer Default value is: `true`. User property is: `mdep.overIfNewer`.
`<overWriteReleases>`	`boolean`	`1.0`	Overwrite release artifacts Default value is: `false`. User property is: `mdep.overWriteReleases`.
`<overWriteSnapshots>`	`boolean`	`1.0`	Overwrite snapshot artifacts Default value is: `false`. User property is: `mdep.overWriteSnapshots`.
`<silent>`	`boolean`	`2.0`	If the plugin should be silent. Default value is: `false`. User property is: `silent`.
`<skip>`	`boolean`	`2.7`	Skip plugin execution completely. Default value is: `false`. User property is: `mdep.skip`.
`<skipDuringIncrementalBuild>`	`boolean`	`3.4.0`	Skip plugin execution only during incremental builds (e.g. triggered from M2E). See also: org.apache.maven.plugins.dependency.AbstractDependencyMojo.skip Default value is: `false`.

Parameter Details

<artifact>

The artifact to unpack from command line. A string of the form groupId:artifactId:version[:packaging[:classifier]]. Use artifactItems within the POM configuration.

Type: java.lang.String
Required: No
User Property: artifact

<artifactItems>

Collection of ArtifactItems to work on. (ArtifactItem contains groupId, artifactId, version, type, classifier, outputDirectory, destFileName, overWrite and encoding.) See Usage for details.

Type: java.util.List<org.apache.maven.plugins.dependency.fromConfiguration.ArtifactItem>
Since: 1.0
Required: No

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 );)

Type: java.lang.String
Since: 2.0-alpha-5
Required: No
User Property: mdep.unpack.excludes

<fileMappers>

org.codehaus.plexus.components.io.filemappers.FileMapper to be used for rewriting each target path, or null if no rewriting shall happen.

Type: org.codehaus.plexus.components.io.filemappers.FileMapper[]
Since: 3.1.2
Required: No
User Property: mdep.unpack.filemappers

<ignorePermissions>

ignore to set file permissions when unpacking a dependency

Type: boolean
Since: 2.7
Required: No
User Property: dependency.ignorePermissions
Default: false

<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
User Property: 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