Full name:
com.mycila:license-maven-plugin:4.2-SNAPSHOT:check
Description:
Attributes:
verify
.Name | Type | Since | Description |
---|---|---|---|
<defaultBasedir> |
File |
- |
The base directory, in which to search for project files.
This is named `defaultBaseDirectory` as it will be used as the default value for the base directory. This default value can be overridden in each LicenseSet by setting Default value is: ${project.basedir} .User property is: license.basedir .Alias is: basedir . |
<dependencyEnforce> |
boolean |
- |
Whether to enforce license.dependencies.allow list. Default value is: false .User property is: license.dependencies.enforce . |
<dependencyExceptionMessage> |
String |
- |
Exception message prefix to display when an artifact is denied by one of the license policies. Default value is: Some licenses were denied by policy: .User property is: license.dependencies.exceptionMessage . |
<dependencyScopes> |
List<String> |
- |
When enforcing licenses on dependencies, exclude all but these scopes. Default value is: runtime .User property is: license.dependencies.scope . |
<project> |
MavenProject |
- |
(no description) Default value is: ${project} . |
Name | Type | Since | Description |
---|---|---|---|
<aggregate> |
boolean |
- |
You can set this flag to true if you want to check the headers for all modules of your project. Only used for multi-modules projects, to check for example the header licenses from the parent module for all sub modules. Default value is: false .User property is: license.aggregate . |
<concurrencyFactor> |
float |
- |
Maven license plugin uses concurrency to check license headers. This factor is used to control the number of threads used to check. The rule is: <nThreads> = <number of cores> * concurrencyFactor The default is 1.5. Default value is: 1.5 .User property is: license.concurrencyFactor . |
<defaultHeaderDefinitions> |
String[] |
- |
Allows the use of external header definitions files. These files are properties like files.
This is named `defaultHeaderDefinitions` as it will be used as the default value for the header definitions. This default value can be overridden in each LicenseSet by setting Alias is: headerDefinitions . |
<defaultInlineHeaderStyles> |
HeaderStyle[] |
- |
Allows the use of inline header definitions.
This is named `defaultInlineHeaderStyles` as it will be used as the default value for the header definitions. This default value can be overridden in each LicenseSet by setting Inline styles overrides those read from file |
<defaultProperties> |
Map<String,String> |
- |
You can set here some properties that you want to use when reading the header file. You can use in your header file some properties like ${year}, ${owner} or whatever you want for the name. They will be replaced when the header file is read by those you specified in the command line, in the POM and in system environment.
This is named `defaultProperties` as it will be used as the default value for the properties. This default value can be overridden in each LicenseSet by setting Alias is: properties . |
<defaultUseDefaultExcludes> |
boolean |
- |
Specify if you want to use default exclusions besides the files you have excluded. Default exclusions exclude CVS and SVN folders, IDE descriptors and so on.
This is named `defaultUseDefaultExcludes` as it will be used as the default value for whether to use default excludes. This default value can be overridden in each LicenseSet by setting Default value is: true .User property is: license.useDefaultExcludes .Alias is: useDefaultExcludes . |
<dependencyPolicies> |
Set<LicensePolicy> |
- |
Block of com.mycila.maven.plugin.license.dependencies.LicensePolicy configuration for enforcing license adherence in dependencies.User property is: license.dependencies.policies . |
<dryRun> |
boolean |
- |
If dryRun is enabled, calls to license:format and license:remove will not overwrite the existing file but instead write the result to a new file with the same name but ending with `.licensed`. Default value is: false .User property is: license.dryRun . |
<encoding> |
String |
- |
Specify the encoding of your files. Default to the project source encoding property (project.build.sourceEncoding). Default value is: ${project.build.sourceEncoding} .User property is: license.encoding . |
<errorMessage> |
String |
- |
(no description) Default value is: Some files do not have the expected license header .User property is: license.errorMessage . |
<failIfMissing> |
boolean |
- |
You can set this flag to false if you do not want the build to fail when some headers are missing. Default value is: true .User property is: license.failIfMissing . |
<failIfUnknown> |
boolean |
2.8 |
You can leave this flag on false if you do not want the build to fail for files that do not have an implicit or explicit comment style definition. Setting this explicitly to true is a safe way to make sure that the effective file type mappings cover all files included from your project.
Default is Default value is: false .User property is: license.failIfUnknown . |
<legacyConfigExcludes> |
String[] |
- |
Deprecated. Specifies files, which are excluded in the check. By default, only the files matching the default exclude patterns are excluded. User property is: license.excludes .Alias is: excludes . |
<legacyConfigHeader> |
String |
- |
Deprecated. Location of the header. It can be a relative path, absolute path, classpath resource, any URL. The plugin first check if the name specified is a relative file, then an absolute file, then in the classpath. If not found, it tries to construct a URL from the location. User property is: license.header .Alias is: header . |
<legacyConfigHeaderSections> |
HeaderSection[] |
- |
Deprecated. HeadSections define special regions of a header that allow for dynamic substitution and validation Alias is: headerSections . |
<legacyConfigIncludes> |
String[] |
- |
Deprecated. Specifies files, which are included in the check. By default, all files are included. User property is: license.includes .Alias is: includes . |
<legacyConfigInlineHeader> |
String |
- |
Deprecated. Header, as text, directly in pom file. Using a CDATA section is strongly recommended. User property is: license.inlineHeader .Alias is: inlineHeader . |
<legacyConfigKeywords> |
String[] |
- |
Deprecated. Specify the list of keywords to use to detect a header. A header must include all keywords to be valid. By default, the word 'copyright' is used. Detection is done case insensitive. Alias is: keywords . |
<legacyConfigMulti> |
Multi |
- |
Deprecated. Alternative to `header`, `inlineHeader`, or `validHeaders` for use when code is multi-licensed. Whilst you could create a concatenated header yourself, a cleaner approach may be to specify more than one header and have them concatenated together by the plugin. This allows you to maintain each distinct license header in its own file and combined them in different ways. |
<legacyConfigValidHeaders> |
String[] |
- |
Deprecated. Specifies additional header files to use when checking for the presence of a valid header in your sources. When using format goal, this property will be used to detect all valid headers that don't need formatting. When using remove goal, this property will be used to detect all valid headers that also must be removed. Alias is: validHeaders . |
<licenseSets> |
LicenseSet[] |
- |
(no description) |
<mapping> |
Map<String,String> |
- |
Set mapping between document mapping and a supported type to use. This section is very useful when you want to customize the supported extensions. If your project is using file extensions not supported by default by this plugin, you can add a mapping to attach the extension to an existing type of comment. The tag name is the new extension name to support, and the value is the name of the comment type to use. |
<nThreads> |
int |
- |
Maven license plugin uses concurrency to check license headers. With this option the number of threads used to check can be specified. If given it take precedence over concurrencyFactor
The default is 0 which implies that the default for Default value is: 0 .User property is: license.nThreads . |
<quiet> |
boolean |
- |
If you do not want to see the list of file having a missing header, you can add the quiet flag that will shorten the output Default value is: false .User property is: license.quiet . |
<reportFormat> |
String |
- |
Format of the report.
Can be (case-insensitive): 'xml', 'json'. Default is XML. User property is: license.report.format . |
<reportLocation> |
File |
- |
The location where to write the report of the plugin execution (file processed, action taken, etc).
"PRESENT" means the file has a header (check goal) "MISSING" means the header is missing (check goal) "NOOP" means no action were performed (remove or format goal) "ADDED" means a header was added (format goal) "REPLACED" means a header was replaced (format goal) "REMOVED" means a header was removed (format goal) "UNKNOWN" means that the file extension is unknown Activated by default. Default value is: ${project.reporting.outputDirectory}/license-plugin-report.xml .User property is: license.report.location . |
<reportSkipped> |
boolean |
- |
Skip the report generation. Default: false Default value is: false .User property is: license.report.skip . |
<session> |
MavenSession |
- |
(no description) Default value is: ${session} . |
<skip> |
boolean |
- |
Whether to skip the plugin execution Default value is: false .User property is: license.skip . |
<skipExistingHeaders> |
boolean |
- |
Skip the formatting of files which already contain a detected header. Default value is: false .User property is: license.skipExistingHeaders . |
<strictCheck> |
boolean |
- |
Set to true if you need a strict check against the headers. By default, the existence of a header is verified by taking the top portion of a file and checking if it contains the headers text, not considering special characters (spaces, tabs, ...). We highly recommend to keep this option set to true .Default value is: true .User property is: license.strictCheck . |
<useDefaultMapping> |
boolean |
- |
Whether to use the default mapping between file extensions and comment types, or only the one your provide. Default value is: true .User property is: license.useDefaultMapping . |
<warnIfShallow> |
boolean |
- |
Determination of the year and author of the first commit and last change year of a file requires a full git or svn history. By default the plugin will log warning when using these properties on a shallow or sparse repository. If you are certain the repository depth will permit accurate determination of these values, you can disable this check. Default value is: true .User property is: license.warnIfShallow . |
boolean
No
license.aggregate
false
<nThreads> = <number of cores> * concurrencyFactor
float
No
license.concurrencyFactor
1.5
This is named `defaultBaseDirectory` as it will be used as the default value for the base directory. This default value can be overridden in each LicenseSet by setting LicenseSet.basedir
.
java.io.File
Yes
license.basedir
${project.basedir}
basedir
This is named `defaultHeaderDefinitions` as it will be used as the default value for the header definitions. This default value can be overridden in each LicenseSet by setting LicenseSet.headerDefinitions
or LicenseSet.inlineHeaderStyles
and is overridden by defaultInlineHeaderStyles
.
java.lang.String[]
No
headerDefinitions
This is named `defaultInlineHeaderStyles` as it will be used as the default value for the header definitions.
This default value can be overridden in each LicenseSet by setting LicenseSet.headerDefinitions
or LicenseSet.inlineHeaderStyles
.
Inline styles overrides those read from file
com.mycila.maven.plugin.license.HeaderStyle[]
No
This is named `defaultProperties` as it will be used as the default value for the properties. This default value can be overridden in each LicenseSet by setting LicenseSet.properties
.
java.util.Map<java.lang.String, java.lang.String>
No
properties
This is named `defaultUseDefaultExcludes` as it will be used as the default value for whether to use default excludes. This default value can be overridden in each LicenseSet by setting LicenseSet.useDefaultExcludes
.
boolean
No
license.useDefaultExcludes
true
useDefaultExcludes
boolean
Yes
license.dependencies.enforce
false
java.lang.String
Yes
license.dependencies.exceptionMessage
Some licenses were denied by policy:
com.mycila.maven.plugin.license.dependencies.LicensePolicy
configuration for enforcing license adherence in dependencies.java.util.Set<com.mycila.maven.plugin.license.dependencies.LicensePolicy>
No
license.dependencies.policies
java.util.List<java.lang.String>
Yes
license.dependencies.scope
runtime
boolean
No
license.dryRun
false
java.lang.String
No
license.encoding
${project.build.sourceEncoding}
java.lang.String
No
license.errorMessage
Some files do not have the expected license header
boolean
No
license.failIfMissing
true
false
if you do not want the build to fail for files that do not have an implicit or explicit comment style definition. Setting this explicitly to true
is a safe way to make sure that the effective file type mappings cover all files included from your project.
Default is false
for backwards compatibility reasons.
boolean
2.8
No
license.failIfUnknown
false
LicenseSet.excludes
java.lang.String[]
No
license.excludes
excludes
LicenseSet.header
java.lang.String
No
license.header
header
LicenseSet.headerSections
com.mycila.maven.plugin.license.HeaderSection[]
No
headerSections
LicenseSet.includes
java.lang.String[]
No
license.includes
includes
LicenseSet.inlineHeader
java.lang.String
No
license.inlineHeader
inlineHeader
LicenseSet.keywords
java.lang.String[]
No
keywords
LicenseSet.multi
com.mycila.maven.plugin.license.Multi
No
LicenseSet.validHeaders
java.lang.String[]
No
validHeaders
com.mycila.maven.plugin.license.LicenseSet[]
No
java.util.Map<java.lang.String, java.lang.String>
No
concurrencyFactor
The default is 0 which implies that the default for concurrencyFactor
is used.
int
No
license.nThreads
0
org.apache.maven.project.MavenProject
Yes
${project}
boolean
No
license.quiet
false
Can be (case-insensitive): 'xml', 'json'.
Default is XML.
java.lang.String
No
license.report.format
"PRESENT" means the file has a header (check goal)
"MISSING" means the header is missing (check goal)
"NOOP" means no action were performed (remove or format goal)
"ADDED" means a header was added (format goal)
"REPLACED" means a header was replaced (format goal)
"REMOVED" means a header was removed (format goal)
"UNKNOWN" means that the file extension is unknown
Activated by default.
java.io.File
No
license.report.location
${project.reporting.outputDirectory}/license-plugin-report.xml
boolean
No
license.report.skip
false
org.apache.maven.execution.MavenSession
No
${session}
boolean
No
license.skip
false
boolean
No
license.skipExistingHeaders
false
true
.boolean
No
license.strictCheck
true
boolean
No
license.useDefaultMapping
true
boolean
No
license.warnIfShallow
true