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.

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

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

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

Attach the 'missing' file as an additional artifact so that it is deployed in the deploy phase.

Encoding used to read and writes files. Note: If nothing is filled here, we will use the system property file.encoding.

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.

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.

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.

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.

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.

If true enforces excluding transitive dependencies of the excluded artifacts in the reactor; otherwise only artifacts that match exclude filters are excluded.

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.

A flag to fail the build if at least one dependency was blacklisted.

A flag to fail the build if at least one dependency was detected without a license.

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.

To force generation of the third-party file even if everything is up to date.

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.

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.

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.

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.

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.

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.

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.

If true enforces including transitive dependencies of the projects in the reactor; otherwise only direct dependencies of the reactor projects are considered.

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.

Deprecated. prefer use now licenseMergesUrl

The file with the merge licenses in order to be used by command line. Note: This option overrides licenseMerges.

Location of file with the merge licenses in order to be used by command line. Note: This option overrides licenseMerges.

The file to write with a license information template for dependencies with unknown license.

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!

To resolve third party licenses from an artifact.

Directory where to generate files.

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 "src/license/override-THIRD-PARTY.properties" resolved against ${basedir} will be used if it exists.

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 "src/license/override-THIRD-PARTY.properties" 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

To skip execution of this mojo.

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

If not then artifacts are sorted by

groupId:artifactId:version

File where to write the third-party file.

A flag to use the missing licenses file to consolidate the THID-PARTY file.

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'.

Flag to activate verbose mode. Note: Verbose mode is always on if you starts a debug maven instance (says via -X).