cxx:scm-dependencies

Full name:

org.codehaus.mojo:cxx-maven-plugin:0.0.6-SNAPSHOT:scm-dependencies

Description:

Goal that retrieve source dependencies from the SCM.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 0.0.6.
  • Binds by default to the lifecycle phase: validate.

Optional Parameters

Name Type Since Description
classifier String 2.0 Specify classifier to look for. Example: sources
User property is: classifier.
connectionType String 0.0.6 SCM connection information to use
Default value is: connection.
User property is: connectionType.
excludeArtifactIds String 2.0 Comma separated list of Artifact names to exclude.
User property is: excludeArtifactIds.
excludeClassifiers String 2.0 Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
User property is: excludeClassifiers.
excludeGroupIds String 2.0 Comma separated list of GroupId Names to exclude.
User property is: excludeGroupIds.
excludeRegexClassifiers String 0.0.6 Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
User property is: excludeRegexClassifiers.
excludeScope String 2.0 Scope to exclude. An Empty string indicates no scopes (default).
User property is: excludeScope.
excludeTransitive boolean 2.0 If we should exclude transitive dependencies
Default value is: false.
User property is: excludeTransitive.
excludeTypes String 2.0 Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
User property is: excludeTypes.
ignorePermissions boolean 2.7 ignore to set file permissions when unpacking a dependency
Default value is: false.
User property is: dependency.ignorePermissions.
includeArtifactIds String 2.0 Comma separated list of Artifact names to include. Empty String indicates include everything (default).
User property is: includeArtifactIds.
includeClassifiers String 2.0 Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
User property is: includeClassifiers.
includeGroupIds String 2.0 Comma separated list of GroupIds to include. Empty String indicates include everything (default).
User property is: includeGroupIds.
includeRegexClassifiers String 0.0.6 Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
User property is: includeRegexClassifiers.
includeScope String 2.0 Scope to include. An Empty string indicates all scopes (default). The scopes being interpreted are the scopes as Maven sees them, not as specified in the pom. In summary:
  • runtime scope gives runtime and compile dependencies,
  • compile scope gives compile, provided, and system dependencies,
  • test (default) scope gives all dependencies,
  • provided scope just gives provided dependencies,
  • system scope just gives system dependencies.

User property is: includeScope.
includeTypes String 2.0 Comma Separated list of Types to include. Empty String indicates include everything (default).
User property is: includeTypes.
markersDirectory File 2.0 Directory to store flag files
Default value is: ${project.build.directory}/dependency-maven-plugin-markers.
User property is: markersDirectory.
outputAbsoluteArtifactFilename boolean 2.0 Output absolute filename for resolved artifacts
Default value is: false.
User property is: outputAbsoluteArtifactFilename.
overWriteIfNewer boolean 2.0 Overwrite artifacts that don't exist or are older than the source.
Default value is: true.
User property is: overWriteIfNewer.
overWriteReleases boolean 1.0 Overwrite release artifacts
Default value is: false.
User property is: overWriteReleases.
overWriteSnapshots boolean 1.0 Overwrite snapshot artifacts
Default value is: false.
User property is: overWriteSnapshots.
password String 0.0.6 The user password (used by svn). You may use maven setting to store encrypted password. See http://maven.apache.org/guides/mini/guide-encryption.html
User property is: password.
prependGroupId boolean 2.2 Prepend the groupId during copy.
Default value is: false.
User property is: mdep.prependGroupId.
settingsServerId String 0.0.6 The server id to use in maven settings to retrieve credential. Optionnal, by defaut each scm url "hostname[:port]" is taken as server id to search potential credentials in maven settings See http://maven.apache.org/guides/mini/guide-encryption.html
User property is: settingsServerId.
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.
sourceFreezeRevision boolean 0.0.6 svn:externals shall use precise svn revisions retrieved from scm info at execution time
Default value is: false.
User property is: sourceFreezeRevision.
sourceSubdir String 0.0.6 Optional source dependencies sub-directory holder
Default value is: ..
User property is: sourceSubdir.
sourceTargetDirRemovePrefixes String[] 0.0.6 List of String prefix to remove when creating dependencies target dirs Example : 

<sourceTargetDirRemovePrefixes>
 <sourceRemoveTargetPrefixe>fr/neticoa</sourceRemoveTargetPrefixe>
 <sourceRemoveTargetPrefixe>module</sourceRemoveTargetPrefixe>
</sourceTargetDirRemovePrefixes>

sourceTargets SourceTarget[] 0.0.6 Provide explicit target path for each source dependency Exemple : 

<sourceTargets>
 <sourceTarget>
   <dependency>
     <groupId>fr.neticoa</groupId>
     <artifactId>module</artifactId>
   </dependency>
   <targetDir>src/module</targetDir>
 </sourceTarget>
</sourceTargets>

type String 2.0 Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war
User property is: type.
useJvmChmod boolean 2.5.1

will use the jvm chmod, this is available for user and all level group level will be ignored

since 2.6 is on by default
Default value is: true.
User property is: dependency.useJvmChmod.
username String 0.0.6 The user name (used by svn). You may use maven setting to store username. See http://maven.apache.org/guides/mini/guide-encryption.html
User property is: username.

Parameter Details

classifier:

Specify classifier to look for. Example: sources
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: classifier

connectionType:

SCM connection information to use
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: connectionType
  • Default: connection

excludeArtifactIds:

Comma separated list of Artifact names to exclude.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: 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
  • User Property: excludeClassifiers

excludeGroupIds:

Comma separated list of GroupId Names to exclude.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: excludeGroupIds

excludeRegexClassifiers:

Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: excludeRegexClassifiers

excludeScope:

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

excludeTransitive:

If we should exclude transitive dependencies
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: 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
  • User Property: excludeTypes

ignorePermissions:

ignore to set file permissions when unpacking a dependency
  • Type: boolean
  • Since: 2.7
  • Required: No
  • User Property: dependency.ignorePermissions
  • Default: false

includeArtifactIds:

Comma separated list of Artifact names to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: includeArtifactIds

includeClassifiers:

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

includeGroupIds:

Comma separated list of GroupIds to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: includeGroupIds

includeRegexClassifiers:

Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: includeRegexClassifiers

includeScope:

Scope to include. An Empty string indicates all scopes (default). The scopes being interpreted are the scopes as Maven sees them, not as specified in the pom. In summary:
  • runtime scope gives runtime and compile dependencies,
  • compile scope gives compile, provided, and system dependencies,
  • test (default) scope gives all dependencies,
  • provided scope just gives provided dependencies,
  • system scope just gives system dependencies.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: includeScope

includeTypes:

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

markersDirectory:

Directory to store flag files
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • User Property: markersDirectory
  • Default: ${project.build.directory}/dependency-maven-plugin-markers

outputAbsoluteArtifactFilename:

Output absolute filename for resolved artifacts
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: outputAbsoluteArtifactFilename
  • Default: false

overWriteIfNewer:

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

overWriteReleases:

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

overWriteSnapshots:

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

password:

The user password (used by svn). You may use maven setting to store encrypted password. See http://maven.apache.org/guides/mini/guide-encryption.html
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: password

prependGroupId:

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

settingsServerId:

The server id to use in maven settings to retrieve credential. Optionnal, by defaut each scm url "hostname[:port]" is taken as server id to search potential credentials in maven settings See http://maven.apache.org/guides/mini/guide-encryption.html
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: settingsServerId

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

sourceFreezeRevision:

svn:externals shall use precise svn revisions retrieved from scm info at execution time
  • Type: boolean
  • Since: 0.0.6
  • Required: No
  • User Property: sourceFreezeRevision
  • Default: false

sourceSubdir:

Optional source dependencies sub-directory holder
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: sourceSubdir
  • Default: .

sourceTargetDirRemovePrefixes:

List of String prefix to remove when creating dependencies target dirs Example : 

<sourceTargetDirRemovePrefixes>
 <sourceRemoveTargetPrefixe>fr/neticoa</sourceRemoveTargetPrefixe>
 <sourceRemoveTargetPrefixe>module</sourceRemoveTargetPrefixe>
</sourceTargetDirRemovePrefixes>
  • Type: java.lang.String[]
  • Since: 0.0.6
  • Required: No

sourceTargets:

Provide explicit target path for each source dependency Exemple : 

<sourceTargets>
 <sourceTarget>
   <dependency>
     <groupId>fr.neticoa</groupId>
     <artifactId>module</artifactId>
   </dependency>
   <targetDir>src/module</targetDir>
 </sourceTarget>
</sourceTargets>
  • Type: org.apache.maven.plugin.cxx.utils.SourceTarget[]
  • Since: 0.0.6
  • Required: No

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

useJvmChmod:

will use the jvm chmod, this is available for user and all level group level will be ignored

since 2.6 is on by default
  • Type: boolean
  • Since: 2.5.1
  • Required: No
  • User Property: dependency.useJvmChmod
  • Default: true

username:

The user name (used by svn). You may use maven setting to store username. See http://maven.apache.org/guides/mini/guide-encryption.html
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: username