dependency-check:generate-poms

Full name:

org.jboss.maven.plugins:dependency-check-maven-plugin:1.0.4-SNAPSHOT:generate-poms

Description:

Goal of 'dependency-check:generate-poms' will generate each test pom file for each BOM module. It can be used to check against whether the BOM declared correct dependencies versions using the generated pom files.

Attributes:

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

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.
User property is: appendOutput.
bomVersion String - Specify the version of the BOM to be tested in the generated POM file. Usually, the version is what the current BOM definition is, but sometime that version is not available in the maven repository yet, it is better to give an alternative version in the generated pom file. The version will be in the dependency of <dependencyManagement> section with import scope. For example: 
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>org.jboss.bom.eap</groupId>
        <artifactId>jboss-javaee-6.0-with-hibernate3</artifactId>
        <version>6.2.0-build-SNAPSHOT</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

User property is: bomVersion.
classifier String 2.0 Specify classifier to look for. Example: sources
User property is: classifier.
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.
excludeReactor boolean 2.7 Don't resolve plugins that are in the current reactor. Only works for plugins at the moment.
Default value is: true.
User property is: excludeReactor.
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.
excludedArtifacts List - Excluded Artifacts, specify the GroupId[:ArtifactId][:version] to filter the artifacts out from the missing artifacts. If artifactId is specified, then only that artifact of the same groupId will be filtered, otherwise, all artifactIds of that groupId will be filtered. If version is specified, then only that version of artifact will be filtered, otherwise, all version of that artifact will be filtered.
User property is: excludedArtifacts.
excludedPoms List - Excluded poms, where plugins/dependencies are defined in their <pluginManagement> and <dependencyManagement> section. Specifies using their URLs, and splits using comma: ','. All defined dependencies in the poms will be skipped during missing artifacts collection.
User property is: excludedPoms.
ignorePermissions boolean - not used in this goal
includeArtifactIds String 2.0 Comma separated list of Artifact names to include.
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.
User property is: includeGroupIds.
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.
includeVersion boolean - Whether include version string during the artifacts collection. If not, only groupId:artifactId, if yes, will be groupId:artifactId:version
User property is: includeVersion.
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.
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.
User property is: outputFile.
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.
prependGroupId boolean 2.2 Prepend the groupId during copy.
Default value is: false.
User property is: mdep.prependGroupId.
profile String - Specify which profile will be active.
User property is: profile.
scope String - Specify the scope in which the artifacts will be excluded.
User property is: scope.
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.
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 - not used in this goal

Parameter Details

appendOutput:

Whether to append outputs into the output file or overwrite it.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • User Property: appendOutput
  • Default: false

bomVersion:

Specify the version of the BOM to be tested in the generated POM file. Usually, the version is what the current BOM definition is, but sometime that version is not available in the maven repository yet, it is better to give an alternative version in the generated pom file. The version will be in the dependency of <dependencyManagement> section with import scope. For example: 
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>org.jboss.bom.eap</groupId>
        <artifactId>jboss-javaee-6.0-with-hibernate3</artifactId>
        <version>6.2.0-build-SNAPSHOT</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
  • Type: java.lang.String
  • Required: No
  • User Property: bomVersion

classifier:

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

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

excludeReactor:

Don't resolve plugins that are in the current reactor. Only works for plugins at the moment.
  • Type: boolean
  • Since: 2.7
  • Required: No
  • User Property: excludeReactor
  • Default: true

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

excludedArtifacts:

Excluded Artifacts, specify the GroupId[:ArtifactId][:version] to filter the artifacts out from the missing artifacts. If artifactId is specified, then only that artifact of the same groupId will be filtered, otherwise, all artifactIds of that groupId will be filtered. If version is specified, then only that version of artifact will be filtered, otherwise, all version of that artifact will be filtered.
  • Type: java.util.List
  • Required: No
  • User Property: excludedArtifacts

excludedPoms:

Excluded poms, where plugins/dependencies are defined in their <pluginManagement> and <dependencyManagement> section. Specifies using their URLs, and splits using comma: ','. All defined dependencies in the poms will be skipped during missing artifacts collection.
  • Type: java.util.List
  • Required: No
  • User Property: excludedPoms

ignorePermissions:

not used in this goal
  • Type: boolean
  • Required: No

includeArtifactIds:

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

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

includeVersion:

Whether include version string during the artifacts collection. If not, only groupId:artifactId, if yes, will be groupId:artifactId:version
  • Type: boolean
  • Required: No
  • User Property: includeVersion

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

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

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

prependGroupId:

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

profile:

Specify which profile will be active.
  • Type: java.lang.String
  • Required: No
  • User Property: profile

scope:

Specify the scope in which the artifacts will be excluded.
  • Type: java.lang.String
  • Required: No
  • User Property: scope

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

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:

not used in this goal
  • Type: boolean
  • Required: No