dependency:build-classpath

Full name:

org.apache.maven.plugins:maven-dependency-plugin:2.3:build-classpath

Description:

This goal will output a classpath string of dependencies from the local repository to a file or log.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 2.0-alpha-2.
  • Binds by default to the lifecycle phase: generate-sources.

Optional Parameters

Name Type Since Description
attach boolean 2.0 Attach the classpath file to the main artifact so it can be installed and deployed.
Default value is: false.
classifier String 2.0 Specify classifier to look for. Example: sources
cpFile File 2.0 Deprecated. use outputFile instead
excludeArtifactIds String 2.0 Comma separated list of Artifact names too exclude.
excludeClassifiers String 2.0 Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
excludeGroupIds String 2.0 Comma separated list of GroupId Names to exclude.
excludeScope String 2.0 Scope to exclude. An Empty string indicates no scopes (default).
excludeTransitive boolean 2.0 If we should exclude transitive dependencies
Default value is: false.
excludeTypes String 2.0 Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
fileSeparator String 2.0 Override the char used between the paths. This field is initialized to contain the first character of the value of the system property file.separator. On UNIX systems the value of this field is '/'; on Microsoft Windows systems it is '\'. The default is File.separator
includeArtifactIds String 2.0 Comma separated list of Artifact names to include.
includeClassifiers String 2.0 Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
includeGroupIds String 2.0 Comma separated list of GroupIds to include.
includeScope String 2.0 Scope to include. An Empty string indicates all scopes (default).
includeTypes String 2.0 Comma Separated list of Types to include. Empty String indicates include everything (default).
localRepoProperty String 2.0 Replace the absolute path to the local repo with this property. This field is ignored it prefix is declared. The value will be forced to "${M2_REPO}" if no value is provided AND the attach flag is true.
markersDirectory File 2.0 Directory to store flag files
Default value is: ${project.build.directory}/dependency-maven-plugin-markers.
outputAbsoluteArtifactFilename boolean 2.0 Output absolute filename for resolved artifacts
Default value is: false.
outputFile File 2.0-alpha-2 The file to write the classpath string. If undefined, it just prints the classpath as [INFO].
outputFilterFile boolean 2.0 Write out the classpath in a format compatible with filtering (classpath=xxxxx)
Default value is: false.
overWriteIfNewer boolean 2.0 Overwrite artifacts that don't exist or are older than the source.
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.
pathSeparator String 2.0 Override the char used between path folders. The system-dependent path-separator character. This field is initialized to contain the first character of the value of the system property path.separator. This character is used to separate filenames in a sequence of files given as a path list. On UNIX systems, this character is ':'; on Microsoft Windows systems it is ';'.
prefix String 2.0-alpha-2 The prefix to prepend on each dependent artifact. If undefined, the paths refer to the actual files store in the local repository (the stipVersion parameter does nothing then).
prependGroupId boolean 2.2 Prepend the groupId during copy.
Default value is: false.
regenerateFile boolean 2.0-alpha-2 If 'true', it skips the up-to-date-check, and always regenerates the classpath file.
Default value is: false.
silent boolean 2.0 If the plugin should be silent.
Default value is: false.
stripVersion boolean 2.0-alpha-2 Strip artifact version during copy (only works if prefix is set)
Default value is: false.
type String 2.0 Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war
Default value is: java-source.

Parameter Details

attach:

Attach the classpath file to the main artifact so it can be installed and deployed.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Default: false

classifier:

Specify classifier to look for. Example: sources
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${classifier}

cpFile:

Deprecated. use outputFile instead
The file to write the classpath string. If undefined, it just prints the classpath as [INFO]. This parameter is deprecated. Use outputFile instead.
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • Expression: ${mdep.cpFile}

excludeArtifactIds:

Comma separated list of Artifact names too exclude.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${excludeArtifactIds}

excludeClassifiers:

Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${excludeClassifiers}

excludeGroupIds:

Comma separated list of GroupId Names to exclude.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${excludeGroupIds}

excludeScope:

Scope to exclude. An Empty string indicates no scopes (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${excludeScope}

excludeTransitive:

If we should exclude transitive dependencies
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${excludeTransitive}
  • Default: false

excludeTypes:

Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${excludeTypes}

fileSeparator:

Override the char used between the paths. This field is initialized to contain the first character of the value of the system property file.separator. On UNIX systems the value of this field is '/'; on Microsoft Windows systems it is '\'. The default is File.separator
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${mdep.fileSeparator}

includeArtifactIds:

Comma separated list of Artifact names to include.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${includeArtifactIds}

includeClassifiers:

Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${includeClassifiers}

includeGroupIds:

Comma separated list of GroupIds to include.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${includeGroupIds}

includeScope:

Scope to include. An Empty string indicates all scopes (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${includeScope}

includeTypes:

Comma Separated list of Types to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${includeTypes}

localRepoProperty:

Replace the absolute path to the local repo with this property. This field is ignored it prefix is declared. The value will be forced to "${M2_REPO}" if no value is provided AND the attach flag is true.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${mdep.localRepoProperty}

markersDirectory:

Directory to store flag files
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • Expression: ${markersDirectory}
  • Default: ${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

outputFile:

The file to write the classpath string. If undefined, it just prints the classpath as [INFO].
  • Type: java.io.File
  • Since: 2.0-alpha-2
  • Required: No
  • Expression: ${mdep.outputFile}

outputFilterFile:

Write out the classpath in a format compatible with filtering (classpath=xxxxx)
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${mdep.outputFilterFile}
  • Default: false

overWriteIfNewer:

Overwrite artifacts that don't exist or are older than the source.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${overWriteIfNewer}
  • Default: true

overWriteReleases:

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

overWriteSnapshots:

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

pathSeparator:

Override the char used between path folders. The system-dependent path-separator character. This field is initialized to contain the first character of the value of the system property path.separator. This character is used to separate filenames in a sequence of files given as a path list. On UNIX systems, this character is ':'; on Microsoft Windows systems it is ';'.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${mdep.pathSeparator}

prefix:

The prefix to prepend on each dependent artifact. If undefined, the paths refer to the actual files store in the local repository (the stipVersion parameter does nothing then).
  • Type: java.lang.String
  • Since: 2.0-alpha-2
  • Required: No
  • Expression: ${mdep.prefix}

prependGroupId:

Prepend the groupId during copy.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${mdep.prependGroupId}
  • Default: false

regenerateFile:

If 'true', it skips the up-to-date-check, and always regenerates the classpath file.
  • Type: boolean
  • Since: 2.0-alpha-2
  • Required: No
  • Expression: ${mdep.regenerateFile}
  • Default: false

silent:

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

stripVersion:

Strip artifact version during copy (only works if prefix is set)
  • Type: boolean
  • Since: 2.0-alpha-2
  • Required: No
  • Expression: ${mdep.stripVersion}
  • Default: false

type:

Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${type}
  • Default: java-source