Built by Maven

dependency:copy

Full name:

org.apache.maven.plugins:maven-dependency-plugin:3.9.0:copy

Description:

Goal that copies a list of artifacts from the repository to defined locations.

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 copy 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.
<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.
<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
<prependGroupId> boolean 2.7 Prepend artifact groupId during copy.
Default: false
User Property: mdep.prependGroupId
<silent> boolean 2.0
Deprecated.
to be removed in 4.0; use -q command line option instead

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
<stripClassifier> boolean - Strip artifact classifier during copy.
Default: false
User Property: mdep.stripClassifier
<stripVersion> boolean - Strip artifact version during copy.
Default: false
User Property: mdep.stripVersion
<useBaseVersion> boolean 2.7 Use artifact baseVersion during copy.
Default: false
User Property: mdep.useBaseVersion

Parameter Details

<artifact>

The artifact to copy 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.

<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

<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

<prependGroupId>

Prepend artifact groupId during copy.
  • Type: boolean
  • Since: 2.7
  • Required: No
  • User Property: mdep.prependGroupId
  • Default: false

<silent>

Deprecated.
to be removed in 4.0; use -q command line option instead

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

<stripClassifier>

Strip artifact classifier during copy.
  • Type: boolean
  • Required: No
  • User Property: mdep.stripClassifier
  • Default: false

<stripVersion>

Strip artifact version during copy.
  • Type: boolean
  • Required: No
  • User Property: mdep.stripVersion
  • Default: false

<useBaseVersion>

Use artifact baseVersion during copy.
  • Type: boolean
  • Since: 2.7
  • Required: No
  • User Property: mdep.useBaseVersion
  • Default: false