dependency:sources

Full name:

org.apache.maven.plugins:maven-dependency-plugin:2.4:sources

Description:

Goal that resolves the project source dependencies from the repository.

Attributes:

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

Optional Parameters

Name Type Since Description
appendOutput boolean 2.2 Whether to append outputs into the output file or overwrite it.
Default value is: false.
classifier String 2.0 Specify classifier to look for. Example: sources
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).
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).
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 If specified, this parameter will cause the dependencies to be written to the path specified, instead of writing to the console.
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.
prependGroupId boolean 2.2 Prepend the groupId during copy.
Default value is: false.
silent boolean 2.0 If the plugin should be silent.
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

appendOutput:

Whether to append outputs into the output file or overwrite it.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${appendOutput}
  • Default: false

classifier:

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

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}

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}

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:

If specified, this parameter will cause the dependencies to be written to the path specified, instead of writing to the console.
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • Expression: ${outputFile}

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

prependGroupId:

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

silent:

If the plugin should be silent.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${silent}
  • 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