license:validate

Full name:

com.puresoltechnologies.maven.plugins:license-maven-plugin:1.2.0:validate

Description:

This class is a Maven Mojo to check the validity of licenses specified in the dependencies of a maven module. Used to configure injection of Plexus components by MavenPluginManager.getConfiguredMojo(...) and special Maven objects as well: mojoExecution org.apache.maven.plugin.MojoExecution project org.apache.maven.project.MavenProject session org.apache.maven.execution.MavenSession settings org.apache.maven.settings.Settings plugin (Maven-3 only) org.apache.maven.plugin.descriptor.PluginDescriptor

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile+runtime.
  • Requires dependency collection of artifacts in scope: compile+runtime.
  • The goal is thread-safe and supports parallel builds.
  • Invokes the execution of the lifecycle phase validate prior to executing itself.
  • Invokes the execution of this plugin's goal validate prior to executing itself.

Required Parameters

Name Type Since Description
knownLicenses Set - (no description)

Optional Parameters

Name Type Since Description
failFast boolean - This parameter contains whether this Mojo shall fail fast (with first occurrence of an invalid license) or should do all the work first before failing. Default value is false.
Default value is: false.
outputDirectory File - (no description)
Default value is: ${project.build.directory}/licenses.
recursive boolean - This parameter contains whether or not the dependency should be checked recursively or not. Default is true.
Default value is: true.
skipOptionals boolean - Specified whether or not to skip archetypes with optional flag.
Default value is: true.
skipProvidedScope boolean - Specifies whether or not the dependencies in provided scope should be skipped. Default is false.
Default value is: true.
skipTestScope boolean - Specifies whether or not the dependencies in test scope should be skipped. Default is false.
Default value is: true.

Parameter Details

failFast:

This parameter contains whether this Mojo shall fail fast (with first occurrence of an invalid license) or should do all the work first before failing. Default value is false.
  • Type: boolean
  • Required: No
  • Default: false

knownLicenses:

(no description)
  • Type: java.util.Set
  • Required: Yes

outputDirectory:

(no description)
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/licenses

recursive:

This parameter contains whether or not the dependency should be checked recursively or not. Default is true.
  • Type: boolean
  • Required: No
  • Default: true

skipOptionals:

Specified whether or not to skip archetypes with optional flag.
  • Type: boolean
  • Required: No
  • Default: true

skipProvidedScope:

Specifies whether or not the dependencies in provided scope should be skipped. Default is false.
  • Type: boolean
  • Required: No
  • Default: true

skipTestScope:

Specifies whether or not the dependencies in test scope should be skipped. Default is false.
  • Type: boolean
  • Required: No
  • Default: true