Built by Maven

dependency:unpack

Full name:

org.apache.maven.plugins:maven-dependency-plugin:3.7.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: 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: 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: mdep.unpack.filemappers
<ignorePermissions> boolean 2.7 ignore to set file permissions when unpacking a dependency
Default: false
User Property: 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: 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: ${project.build.directory}/dependency-maven-plugin-markers
<outputDirectory> File 1.0 Default output location used for mojo, unless overridden in ArtifactItem.
Default: ${project.build.directory}/dependency
User Property: outputDirectory
<overIfNewer> boolean 2.0
Deprecated.
Use 'overWriteIfNewer' or 'mdep.overWriteIfNewer' as this does nothing now.

Overwrite if newer
Default: true
User Property: mdep.overIfNewer
<overWriteIfNewer> boolean 3.7.0 Overwrite if newer
Default: true
User Property: mdep.overWriteIfNewer
<overWriteReleases> boolean 1.0 Overwrite release artifacts
Default: false
User Property: mdep.overWriteReleases
<overWriteSnapshots> boolean 1.0 Overwrite snapshot artifacts
Default: false
User Property: mdep.overWriteSnapshots
<silent> boolean 2.0 If the plugin should be silent.
Default: false
User Property: silent
<skip> boolean 2.7 Skip plugin execution completely.
Default: false
User Property: 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: 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.

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

<markersDirectory>

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

<outputDirectory>

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

<overIfNewer>

Deprecated.
Use 'overWriteIfNewer' or 'mdep.overWriteIfNewer' as this does nothing now.

Overwrite if newer
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: mdep.overIfNewer
  • Default: true

<overWriteIfNewer>

Overwrite if newer
  • Type: boolean
  • Since: 3.7.0
  • Required: No
  • User Property: mdep.overWriteIfNewer
  • Default: true

<overWriteReleases>

Overwrite release artifacts
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: mdep.overWriteReleases
  • Default: false

<overWriteSnapshots>

Overwrite snapshot artifacts
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: mdep.overWriteSnapshots
  • Default: false

<silent>

If the plugin should be silent.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: silent
  • Default: false

<skip>

Skip plugin execution completely.
  • Type: boolean
  • Since: 2.7
  • Required: No
  • User Property: mdep.skip
  • Default: false

<skipDuringIncrementalBuild>

Skip plugin execution only during incremental builds (e.g. triggered from M2E).
See also: org.apache.maven.plugins.dependency.AbstractDependencyMojo.skip
  • Type: boolean
  • Since: 3.4.0
  • Required: No
  • Default: false