Fork me on GitHub

license:aggregate-add-third-party

Full name:

org.codehaus.mojo:license-maven-plugin:2.0.0:aggregate-add-third-party

Description:

This goal forks executions of the add-third-party goal for all the leaf projects of the tree of modules below the point where it is executed. Note that this plugin sets a specific name, 'add-third-party', for the forked executions in the individual projects. From command level, then even though the execution of this goal is named 'default-cli', the forked executions have the name 'add-third-party'. Thus, to use the pluginManagement element of the POM to set options, you have to name the execution 'add-third-party', not 'default-cli'.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
<outputDirectory> File 1.0 Directory where to generate files.
Default value is: ${project.build.directory}/generated-sources/license.
User property is: license.outputDirectory.
<thirdPartyFilename> String 1.0 File where to write the third-party file.
Default value is: THIRD-PARTY.txt.
User property is: license.thirdPartyFilename.

Optional Parameters

Name Type Since Description
<acceptPomPackaging> boolean 1.1 If true the mojo will be executed for reactor projects having any packaging (including pom); otherwise the mojo will be executed only for projects that do not have packaging pom.

Since 1.18, when acceptPomPackaging is true, aggregate-add-third-party mojo is executed also for the Maven session root project - i.e. the one out whose directory the mojo was executed. Before 1.18, when acceptPomPackaging was true, aggregate-add-third-party mojo was iterating over all modules in the reactor but the Maven session root project was skipped.


Default value is: false.
User property is: license.acceptPomPackaging.
<aggregateMissingLicensesFile> File 1.11 Deprecated. since 1.14, please use now missingFile.
User property is: license.aggregateMissingLicensesFile.
<aggregateMissingLicensesFileArtifact> String 1.11 Deprecated. since 1.14, please use now missingLicensesFileArtifact
User property is: license.aggregateMissingLicensesFileArtifact.
<artifactFiltersUrl> String 1.18 A URL returning a plain text file that contains include/exclude artifact filters in the following format:

# this is a comment
include gaPattern org\.my-org:my-artifact
include gaPattern org\.other-org:other-artifact
exclude gaPattern org\.yet-anther-org:.*
include scope compile
include scope test
exclude scope system
include type jar
exclude type war


User property is: license.artifactFiltersUrl.
<bundleThirdPartyPath> String 1.0 The path of the bundled third party file to produce when generateBundle is on.

Note: This option is not available for pom module types.


Default value is: META-INF/${project.artifactId}-THIRD-PARTY.txt.
User property is: license.bundleThirdPartyPath.
<deployMissingFile> boolean 1.0 Attach the 'missing' file as an additional artifact so that it is deployed in the deploy phase.
Default value is: true.
User property is: license.deployMissingFile.
<encoding> String 1.0 Encoding used to read and writes files. Note: If nothing is filled here, we will use the system property file.encoding.
Default value is: ${project.build.sourceEncoding}.
User property is: license.encoding.
<excludeTransitiveDependencies> boolean 1.13 If true enforces excluding transitive dependencies of the excluded artifacts in the reactor; otherwise only artifacts that match exclude filters are excluded.
Default value is: false.
User property is: license.excludeTransitiveDependencies.
<excludedArtifacts> String 1.1 A regular expression (not glob pattern) used as filter to exclude artifacts that have matching artifactId. Match could be also partial for example ^org\.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is excluded its transitive dependencies are not automatically excluded. To enforce this behavior refer to excludeTransitiveDependencies.


User property is: license.excludedArtifacts.
<excludedGroups> String 1.1 A regular expression (not glob pattern) used as filter to exclude artifacts that have matching groupId. Match could be also partial for example ^org\.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is excluded its transitive dependencies are not automatically excluded. To enforce this behavior refer to excludeTransitiveDependencies.


User property is: license.excludedGroups.
<excludedLicenses> AbstractAddThirdPartyMojo$ExcludedLicenses 1.1 To specify some licenses to exclude.

If a such license is found then build will fail when property failOnBlacklist is true.

Since version 1.4, there are three ways to fill this parameter :

  • A simple string (separated by |), the way to use by property configuration:
    <excludedLicenses>licenseA|licenseB</excludedLicenses>
    
    or
    -Dlicense.excludedLicenses=licenseA|licenseB
    
  • A list of string (can only be used in plugin configuration, not via property configuration)
    <excludedLicenses>
      <excludedLicense>licenseA</excludedLicense>
      <excludedLicense>licenseB</excludedLicense>
    </excludedLicenses>
    
  • Since version 1.15
    a URL that contains a set of license names at the target source (only a single URL is accepted as parameter)
     <includedLicenses>http://my.license.host.com/my-blacklist</includedLicenses>
    
    the license-list on the given URL is expected to be list with a line-break after every entry e.g.:
    • The Apache Software License, Version 2.0
    • Apache License, Version 2.0
    • Bouncy Castle Licence
    • MIT License
    empty lines will be ignored.

User property is: license.excludedLicenses.
<excludedScopes> String 1.1 A comma separated list of scopes to exclude: e.g. <excludedScopes>test,provided</excludedScopes> or -Dlicense.excludedScopes=test,provided.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is excluded its transitive dependencies are not automatically excluded. To enforce this behavior refer to excludeTransitiveDependencies.


Default value is: system.
User property is: license.excludedScopes.
<excludedTypes> String 1.15 A comma separated list of types to exclude: e.g. <excludedTypes>war,pom</excludedTypes> or -Dlicense.excludedTypes=was,pom.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is excluded its transitive dependencies are not automatically excluded. To enforce this behavior refer to excludeTransitiveDependencies.


User property is: license.excludedTypes.
<failIfWarning> boolean 1.0 Deprecated. since 1.14, use now failOnMissing or failOnBlacklist.
Default value is: false.
User property is: license.failIfWarning.
<failOnBlacklist> boolean 1.14 A flag to fail the build if at least one dependency was blacklisted.
Default value is: false.
User property is: license.failOnBlacklist.
<failOnMissing> boolean 1.14 A flag to fail the build if at least one dependency was detected without a license.
Default value is: false.
User property is: license.failOnMissing.
<fileTemplate> String 1.1 Template used to build the third-party file.

(This template uses freemarker).

Note: This property can either point to a file or a resource on the classpath. In case it points to a file and this plugin is used within a sub-module as part of a multi-module build, you need to make this path resolvable, e.g. by prepending basedir.


Default value is: /org/codehaus/mojo/license/third-party-file.ftl.
User property is: license.fileTemplate.
<force> boolean 1.0 To force generation of the third-party file even if everything is up to date.
Default value is: false.
User property is: license.force.
<generateBundle> boolean 1.0 A flag to copy a bundled version of the third-party file. This is useful to avoid for a final application collision name of third party file.

The file will be copied at the bundleThirdPartyPath location.


Default value is: false.
User property is: license.generateBundle.
<includeOptional> boolean 1.19 If true both optional and non-optional dependencies will be included in the list of artifacts for creating the license report; otherwise only non-optional dependencies will be considered.
Default value is: true.
User property is: license.includeOptional.
<includeTransitiveDependencies> boolean 1.1 If true enforces including transitive dependencies of the projects in the reactor; otherwise only direct dependencies of the reactor projects are considered.
Default value is: true.
User property is: license.includeTransitiveDependencies.
<includedArtifacts> String 1.1 A regular expression (not glob pattern) used as filter to include only artifacts that have matching artifactId.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is included also its transitive dependencies are included. To suppress this behavior refer to includeTransitiveDependencies.


User property is: license.includedArtifacts.
<includedGroups> String 1.1 A regular expression (not glob pattern) used as filter to include only artifacts that have matching groupId.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is included also its transitive dependencies are included. To suppress this behavior refer to includeTransitiveDependencies.


User property is: license.includedGroups.
<includedLicenses> AbstractAddThirdPartyMojo$IncludedLicenses 1.1 To specify some licenses to include.

If this parameter is filled and a license is not in this whitelist then build will fail when property failOnBlacklist is true.

Since version 1.4, there are three ways to fill this parameter :

  • A simple string (separated by |), the way to use by property configuration:
    <includedLicenses>licenseA|licenseB</includedLicenses>
    
    or
    -Dlicense.includedLicenses=licenseA|licenseB
    
  • A list of string (can only be used in plugin configuration, not via property configuration)
    <includedLicenses>
      <includedLicense>licenseA</includedLicense>
      <includedLicenses>licenseB</includedLicense>
    </includedLicenses>
    
  • Since version 1.15
    a URL that contains a set of license names at the target source (only a single URL is accepted as parameter)
       <includedLicenses>http://my.license.host.com/my-whitelist</includedLicenses>
    
    the license-list on the given URL is expected to be list with a line-break after every entry e.g.:
    • The Apache Software License, Version 2.0
    • Apache License, Version 2.0
    • Bouncy Castle Licence
    • MIT License
    empty lines will be ignored.

User property is: license.includedLicenses.
<includedScopes> String 1.1 A comma separated list of scopes to include: e.g. <includedScopes>test,provided</includedScopes> or -Dlicense.includedScopes=test,provided.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is included also its transitive dependencies are included. To suppress this behavior refer to includeTransitiveDependencies.


User property is: license.includedScopes.
<includedTypes> String 1.15 A comma separated list of types to include.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is included also its transitive dependencies are included. To suppress this behavior refer to includeTransitiveDependencies.


User property is: license.includedTypes.
<licenseMerges> List 1.0 To merge licenses in final file.

Each entry represents a merge (first license is main license to keep), licenses are separated by |.

Example :

<licenseMerges>
<licenseMerge>The Apache Software License|Version 2.0,Apache License, Version 2.0</licenseMerge>
</licenseMerges>
</pre>


Note: This option will be overridden by 
licenseMergesUrl if it is used by command line.

<licenseMergesFile> String 1.15 Deprecated. prefer use now licenseMergesUrl
User property is: license.licenseMergesFile.
<licenseMergesUrl> String 1.17 Location of file with the merge licenses in order to be used by command line. Note: This option overrides licenseMerges.
User property is: license.licenseMergesUrl.
<missingFile> File 1.0 The file to write with a license information template for dependencies with unknown license.
Default value is: src/license/THIRD-PARTY.properties.
User property is: license.missingFile.
<missingFileUrl> String 1.15 The Url that holds the missing license dependency entries. This is an extension to missingFile. If set then the entries that will be found at this URL will be added additionally to the entries of the missing file.

NOTE:
the response of the URL endpoint must return content that matches the THIRD-PARTY.properties file!
User property is: license.missingFileUrl.
<missingLicensesFileArtifact> String 1.14 To resolve third party licenses from an artifact.
User property is: license.missingLicensesFileArtifact.
<overrideFile> File 1.12 Deprecated. Use overrideUrl instead
User property is: license.overrideFile.
<overrideUrl> String 1.17 A URL pointing at a property file with the override license information for dependencies. Note: Specify either overrideUrl (preferred) or overrideFile. If none of these is specified, then LicenseMojoUtils.DEFAULT_OVERRIDE_THIRD_PARTY resolved against ${basedir} will be used if it exists.

An example of the file content:

org.jboss.xnio--xnio-api--3.3.6.Final=The Apache Software License, Version 2.0

User property is: license.overrideUrl.
<skipAggregateAddThirdParty> boolean 1.5 To skip execution of this mojo.
Default value is: false.
User property is: license.skipAggregateAddThirdParty.
<sortArtifactByName> boolean 1.6 A flag to sort artifact by name in the generated third-party file.

If not then artifacts are sorted by

groupId:artifactId:version

Default value is: false.
User property is: license.sortArtifactByName.
<useMissingFile> boolean 1.0 A flag to use the missing licenses file to consolidate the THID-PARTY file.
Default value is: false.
User property is: license.useMissingFile.
<useRepositoryMissingFiles> boolean 1.0 Load files supplying information for missing third party licenses from repositories. The plugin looks for Maven artifacts with coordinates of the form G:A:V:properties:third-party, where the group, artifact, and version are those for dependencies of your project, while the type is 'properties' and the classifier is 'third-party'.
Default value is: true.
User property is: license.useRepositoryMissingFiles.
<verbose> boolean 1.0 Flag to activate verbose mode. Note: Verbose mode is always on if you starts a debug maven instance (says via -X).
Default value is: ${maven.verbose}.
User property is: license.verbose.

Parameter Details

<acceptPomPackaging>

If true the mojo will be executed for reactor projects having any packaging (including pom); otherwise the mojo will be executed only for projects that do not have packaging pom.

Since 1.18, when acceptPomPackaging is true, aggregate-add-third-party mojo is executed also for the Maven session root project - i.e. the one out whose directory the mojo was executed. Before 1.18, when acceptPomPackaging was true, aggregate-add-third-party mojo was iterating over all modules in the reactor but the Maven session root project was skipped.

  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: license.acceptPomPackaging
  • Default: false

<aggregateMissingLicensesFile>

Deprecated. since 1.14, please use now missingFile.
To resolve third party licenses from a file.
  • Type: java.io.File
  • Since: 1.11
  • Required: No
  • User Property: license.aggregateMissingLicensesFile

<aggregateMissingLicensesFileArtifact>

Deprecated. since 1.14, please use now missingLicensesFileArtifact
To resolve third party licenses from an artifact.
  • Type: java.lang.String
  • Since: 1.11
  • Required: No
  • User Property: license.aggregateMissingLicensesFileArtifact

<artifactFiltersUrl>

A URL returning a plain text file that contains include/exclude artifact filters in the following format:

# this is a comment
include gaPattern org\.my-org:my-artifact
include gaPattern org\.other-org:other-artifact
exclude gaPattern org\.yet-anther-org:.*
include scope compile
include scope test
exclude scope system
include type jar
exclude type war

  • Type: java.lang.String
  • Since: 1.18
  • Required: No
  • User Property: license.artifactFiltersUrl

<bundleThirdPartyPath>

The path of the bundled third party file to produce when generateBundle is on.

Note: This option is not available for pom module types.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: license.bundleThirdPartyPath
  • Default: META-INF/${project.artifactId}-THIRD-PARTY.txt

<deployMissingFile>

Attach the 'missing' file as an additional artifact so that it is deployed in the deploy phase.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: license.deployMissingFile
  • Default: true

<encoding>

Encoding used to read and writes files. Note: If nothing is filled here, we will use the system property file.encoding.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: license.encoding
  • Default: ${project.build.sourceEncoding}

<excludeTransitiveDependencies>

If true enforces excluding transitive dependencies of the excluded artifacts in the reactor; otherwise only artifacts that match exclude filters are excluded.
  • Type: boolean
  • Since: 1.13
  • Required: No
  • User Property: license.excludeTransitiveDependencies
  • Default: false

<excludedArtifacts>

A regular expression (not glob pattern) used as filter to exclude artifacts that have matching artifactId. Match could be also partial for example ^org\.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is excluded its transitive dependencies are not automatically excluded. To enforce this behavior refer to excludeTransitiveDependencies.

  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: license.excludedArtifacts

<excludedGroups>

A regular expression (not glob pattern) used as filter to exclude artifacts that have matching groupId. Match could be also partial for example ^org\.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is excluded its transitive dependencies are not automatically excluded. To enforce this behavior refer to excludeTransitiveDependencies.

  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: license.excludedGroups

<excludedLicenses>

To specify some licenses to exclude.

If a such license is found then build will fail when property failOnBlacklist is true.

Since version 1.4, there are three ways to fill this parameter :

  • A simple string (separated by |), the way to use by property configuration:
    <excludedLicenses>licenseA|licenseB</excludedLicenses>
    
    or
    -Dlicense.excludedLicenses=licenseA|licenseB
    
  • A list of string (can only be used in plugin configuration, not via property configuration)
    <excludedLicenses>
      <excludedLicense>licenseA</excludedLicense>
      <excludedLicense>licenseB</excludedLicense>
    </excludedLicenses>
    
  • Since version 1.15
    a URL that contains a set of license names at the target source (only a single URL is accepted as parameter)
     <includedLicenses>http://my.license.host.com/my-blacklist</includedLicenses>
    
    the license-list on the given URL is expected to be list with a line-break after every entry e.g.:
    • The Apache Software License, Version 2.0
    • Apache License, Version 2.0
    • Bouncy Castle Licence
    • MIT License
    empty lines will be ignored.
  • Type: org.codehaus.mojo.license.AbstractAddThirdPartyMojo$ExcludedLicenses
  • Since: 1.1
  • Required: No
  • User Property: license.excludedLicenses

<excludedScopes>

A comma separated list of scopes to exclude: e.g. <excludedScopes>test,provided</excludedScopes> or -Dlicense.excludedScopes=test,provided.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is excluded its transitive dependencies are not automatically excluded. To enforce this behavior refer to excludeTransitiveDependencies.

  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: license.excludedScopes
  • Default: system

<excludedTypes>

A comma separated list of types to exclude: e.g. <excludedTypes>war,pom</excludedTypes> or -Dlicense.excludedTypes=was,pom.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is excluded its transitive dependencies are not automatically excluded. To enforce this behavior refer to excludeTransitiveDependencies.

  • Type: java.lang.String
  • Since: 1.15
  • Required: No
  • User Property: license.excludedTypes

<failIfWarning>

Deprecated. since 1.14, use now failOnMissing or failOnBlacklist.
A flag to fail the build if at least one dependency was detected without a license.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: license.failIfWarning
  • Default: false

<failOnBlacklist>

A flag to fail the build if at least one dependency was blacklisted.
  • Type: boolean
  • Since: 1.14
  • Required: No
  • User Property: license.failOnBlacklist
  • Default: false

<failOnMissing>

A flag to fail the build if at least one dependency was detected without a license.
  • Type: boolean
  • Since: 1.14
  • Required: No
  • User Property: license.failOnMissing
  • Default: false

<fileTemplate>

Template used to build the third-party file.

(This template uses freemarker).

Note: This property can either point to a file or a resource on the classpath. In case it points to a file and this plugin is used within a sub-module as part of a multi-module build, you need to make this path resolvable, e.g. by prepending basedir.

  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: license.fileTemplate
  • Default: /org/codehaus/mojo/license/third-party-file.ftl

<force>

To force generation of the third-party file even if everything is up to date.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: license.force
  • Default: false

<generateBundle>

A flag to copy a bundled version of the third-party file. This is useful to avoid for a final application collision name of third party file.

The file will be copied at the bundleThirdPartyPath location.

  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: license.generateBundle
  • Default: false

<includeOptional>

If true both optional and non-optional dependencies will be included in the list of artifacts for creating the license report; otherwise only non-optional dependencies will be considered.
  • Type: boolean
  • Since: 1.19
  • Required: No
  • User Property: license.includeOptional
  • Default: true

<includeTransitiveDependencies>

If true enforces including transitive dependencies of the projects in the reactor; otherwise only direct dependencies of the reactor projects are considered.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: license.includeTransitiveDependencies
  • Default: true

<includedArtifacts>

A regular expression (not glob pattern) used as filter to include only artifacts that have matching artifactId.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is included also its transitive dependencies are included. To suppress this behavior refer to includeTransitiveDependencies.

  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: license.includedArtifacts

<includedGroups>

A regular expression (not glob pattern) used as filter to include only artifacts that have matching groupId.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is included also its transitive dependencies are included. To suppress this behavior refer to includeTransitiveDependencies.

  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: license.includedGroups

<includedLicenses>

To specify some licenses to include.

If this parameter is filled and a license is not in this whitelist then build will fail when property failOnBlacklist is true.

Since version 1.4, there are three ways to fill this parameter :

  • A simple string (separated by |), the way to use by property configuration:
    <includedLicenses>licenseA|licenseB</includedLicenses>
    
    or
    -Dlicense.includedLicenses=licenseA|licenseB
    
  • A list of string (can only be used in plugin configuration, not via property configuration)
    <includedLicenses>
      <includedLicense>licenseA</includedLicense>
      <includedLicenses>licenseB</includedLicense>
    </includedLicenses>
    
  • Since version 1.15
    a URL that contains a set of license names at the target source (only a single URL is accepted as parameter)
       <includedLicenses>http://my.license.host.com/my-whitelist</includedLicenses>
    
    the license-list on the given URL is expected to be list with a line-break after every entry e.g.:
    • The Apache Software License, Version 2.0
    • Apache License, Version 2.0
    • Bouncy Castle Licence
    • MIT License
    empty lines will be ignored.
  • Type: org.codehaus.mojo.license.AbstractAddThirdPartyMojo$IncludedLicenses
  • Since: 1.1
  • Required: No
  • User Property: license.includedLicenses

<includedScopes>

A comma separated list of scopes to include: e.g. <includedScopes>test,provided</includedScopes> or -Dlicense.includedScopes=test,provided.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is included also its transitive dependencies are included. To suppress this behavior refer to includeTransitiveDependencies.

  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: license.includedScopes

<includedTypes>

A comma separated list of types to include.

This filter is applied on the list of direct dependencies (and their transitive dependencies) of the projects in the reactor.

By default if an artifact is included also its transitive dependencies are included. To suppress this behavior refer to includeTransitiveDependencies.

  • Type: java.lang.String
  • Since: 1.15
  • Required: No
  • User Property: license.includedTypes

<licenseMerges>

To merge licenses in final file.

Each entry represents a merge (first license is main license to keep), licenses are separated by |.

Example :

<licenseMerges>
<licenseMerge>The Apache Software License|Version 2.0,Apache License, Version 2.0</licenseMerge>
</licenseMerges>
</pre>


Note: This option will be overridden by 
licenseMergesUrl if it is used by command line.
  • Type: java.util.List
  • Since: 1.0
  • Required: No

<licenseMergesFile>

Deprecated. prefer use now licenseMergesUrl
The file with the merge licenses in order to be used by command line. Note: This option overrides licenseMerges.
  • Type: java.lang.String
  • Since: 1.15
  • Required: No
  • User Property: license.licenseMergesFile

<licenseMergesUrl>

Location of file with the merge licenses in order to be used by command line. Note: This option overrides licenseMerges.
  • Type: java.lang.String
  • Since: 1.17
  • Required: No
  • User Property: license.licenseMergesUrl

<missingFile>

The file to write with a license information template for dependencies with unknown license.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • User Property: license.missingFile
  • Default: src/license/THIRD-PARTY.properties

<missingFileUrl>

The Url that holds the missing license dependency entries. This is an extension to missingFile. If set then the entries that will be found at this URL will be added additionally to the entries of the missing file.

NOTE:
the response of the URL endpoint must return content that matches the THIRD-PARTY.properties file!
  • Type: java.lang.String
  • Since: 1.15
  • Required: No
  • User Property: license.missingFileUrl

<missingLicensesFileArtifact>

To resolve third party licenses from an artifact.
  • Type: java.lang.String
  • Since: 1.14
  • Required: No
  • User Property: license.missingLicensesFileArtifact

<outputDirectory>

Directory where to generate files.
  • Type: java.io.File
  • Since: 1.0
  • Required: Yes
  • User Property: license.outputDirectory
  • Default: ${project.build.directory}/generated-sources/license

<overrideFile>

Deprecated. Use overrideUrl instead
A file containing the override license information for dependencies. Note: Specify either overrideUrl (preferred) or overrideFile. If none of these is specified, then LicenseMojoUtils.DEFAULT_OVERRIDE_THIRD_PARTY resolved against ${basedir} will be used if it exists.
  • Type: java.io.File
  • Since: 1.12
  • Required: No
  • User Property: license.overrideFile

<overrideUrl>

A URL pointing at a property file with the override license information for dependencies. Note: Specify either overrideUrl (preferred) or overrideFile. If none of these is specified, then LicenseMojoUtils.DEFAULT_OVERRIDE_THIRD_PARTY resolved against ${basedir} will be used if it exists.

An example of the file content:

org.jboss.xnio--xnio-api--3.3.6.Final=The Apache Software License, Version 2.0
  • Type: java.lang.String
  • Since: 1.17
  • Required: No
  • User Property: license.overrideUrl

<skipAggregateAddThirdParty>

To skip execution of this mojo.
  • Type: boolean
  • Since: 1.5
  • Required: No
  • User Property: license.skipAggregateAddThirdParty
  • Default: false

<sortArtifactByName>

A flag to sort artifact by name in the generated third-party file.

If not then artifacts are sorted by

groupId:artifactId:version
  • Type: boolean
  • Since: 1.6
  • Required: No
  • User Property: license.sortArtifactByName
  • Default: false

<thirdPartyFilename>

File where to write the third-party file.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • User Property: license.thirdPartyFilename
  • Default: THIRD-PARTY.txt

<useMissingFile>

A flag to use the missing licenses file to consolidate the THID-PARTY file.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: license.useMissingFile
  • Default: false

<useRepositoryMissingFiles>

Load files supplying information for missing third party licenses from repositories. The plugin looks for Maven artifacts with coordinates of the form G:A:V:properties:third-party, where the group, artifact, and version are those for dependencies of your project, while the type is 'properties' and the classifier is 'third-party'.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: license.useRepositoryMissingFiles
  • Default: true

<verbose>

Flag to activate verbose mode. Note: Verbose mode is always on if you starts a debug maven instance (says via -X).
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: license.verbose
  • Default: ${maven.verbose}