apache-rat:check

Full name:

org.apache.rat:apache-rat-plugin:0.9-SNAPSHOT:check

Description:

Run RAT to perform a violation check.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: verify.

Required Parameters

Name Type Since Description
basedir File - The base directory, in which to search for files.
Default value is: ${basedir}.

Optional Parameters

Name Type Since Description
addDefaultLicenseMatchers boolean - Whether to add the default list of license matchers.
Default value is: true.
addLicenseHeaders String - Whether to add license headers; possible values are forced, true, and false (default).
Default value is: false.
copyrightMessage String - Copyright message to add to license headers. This option is ignored, unless addLicenseHeaders is set to true, or forced.
excludeSubProjects boolean - Whether to exclude subprojects. This is recommended, if you want a separate apache-rat-plugin report for each subproject.
Default value is: true.
excludes String[] - Specifies files, which are excluded in the report. By default, no files are excluded.
includes String[] - Specifies files, which are included in the report. By default, all files are included.
licenseFamilies ILicenseFamily[] 0.8 Specifies the license families to accept.
licenseMatchers HeaderMatcherSpecification[] - Deprecated. {0}. Use licenses instead.
licenses IHeaderMatcher[] 0.8 Specifies the licenses to accept. By default, these are added to the default licenses, unless you set addDefaultLicenseMatchers to true.
numUnapprovedLicenses int - Maximum number of files with unapproved licenses.
Default value is: 0.
reportFile File - Where to store the report.
Default value is: ${project.build.directory}/rat.txt.
reportStyle String - Output style of the report. Use "plain" (the default) for a plain text report or "xml" for the raw XML report. Alternatively you can give the path of an XSL transformation that will be applied on the raw XML to produce the report written to the output file.
Default value is: plain.
useDefaultExcludes boolean - Whether to use the default excludes when scanning for files.
Default value is: true.
useEclipseDefaultExcludes boolean - Whether to use the Eclipse specific default excludes when scanning for files. Eclipse specific default excludes are given by the constant ECLIPSE_DEFAULT_EXCLUDES: The .classpath and .project files, the .settings directory, and so on.
Default value is: true.
useIdeaDefaultExcludes boolean - Whether to use the IDEA specific default excludes when scanning for files. IDEA specific default excludes are given by the constant IDEA_DEFAULT_EXCLUDES: The *.iml, *.ipr and *.iws files.
Default value is: true.
useMavenDefaultExcludes boolean - Whether to use the Maven specific default excludes when scanning for files. Maven specific default excludes are given by the constant MAVEN_DEFAULT_EXCLUDES: The target directory, the cobertura.ser file, and so on.
Default value is: true.

Parameter Details

addDefaultLicenseMatchers:

Whether to add the default list of license matchers.
  • Type: boolean
  • Required: No
  • Expression: ${rat.addDefaultLicenseMatchers}
  • Default: true

addLicenseHeaders:

Whether to add license headers; possible values are forced, true, and false (default).
  • Type: java.lang.String
  • Required: No
  • Expression: ${rat.addLicenseHeaders}
  • Default: false

basedir:

The base directory, in which to search for files.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${rat.basedir}
  • Default: ${basedir}

copyrightMessage:

Copyright message to add to license headers. This option is ignored, unless addLicenseHeaders is set to true, or forced.
  • Type: java.lang.String
  • Required: No
  • Expression: ${rat.copyrightMessage}

excludeSubProjects:

Whether to exclude subprojects. This is recommended, if you want a separate apache-rat-plugin report for each subproject.
  • Type: boolean
  • Required: No
  • Expression: ${rat.excludeSubprojects}
  • Default: true

excludes:

Specifies files, which are excluded in the report. By default, no files are excluded.
  • Type: java.lang.String[]
  • Required: No

includes:

Specifies files, which are included in the report. By default, all files are included.
  • Type: java.lang.String[]
  • Required: No

licenseFamilies:

Specifies the license families to accept.
  • Type: org.apache.rat.license.ILicenseFamily[]
  • Since: 0.8
  • Required: No

licenseMatchers:

Deprecated. Use licenses instead.
Specifies the licenses to accept. Deprecated, use licenses instead.
  • Type: org.apache.rat.mp.HeaderMatcherSpecification[]
  • Required: No

licenses:

Specifies the licenses to accept. By default, these are added to the default licenses, unless you set addDefaultLicenseMatchers to true.
  • Type: org.apache.rat.analysis.IHeaderMatcher[]
  • Since: 0.8
  • Required: No

numUnapprovedLicenses:

Maximum number of files with unapproved licenses.
  • Type: int
  • Required: No
  • Expression: ${rat.numUnapprovedLicenses}
  • Default: 0

reportFile:

Where to store the report.
  • Type: java.io.File
  • Required: No
  • Expression: ${rat.outputFile}
  • Default: ${project.build.directory}/rat.txt

reportStyle:

Output style of the report. Use "plain" (the default) for a plain text report or "xml" for the raw XML report. Alternatively you can give the path of an XSL transformation that will be applied on the raw XML to produce the report written to the output file.
  • Type: java.lang.String
  • Required: No
  • Expression: ${rat.outputStyle}
  • Default: plain

useDefaultExcludes:

Whether to use the default excludes when scanning for files.
  • Type: boolean
  • Required: No
  • Expression: ${rat.useDefaultExcludes}
  • Default: true

useEclipseDefaultExcludes:

Whether to use the Eclipse specific default excludes when scanning for files. Eclipse specific default excludes are given by the constant ECLIPSE_DEFAULT_EXCLUDES: The .classpath and .project files, the .settings directory, and so on.
  • Type: boolean
  • Required: No
  • Expression: ${rat.useEclipseDefaultExcludes}
  • Default: true

useIdeaDefaultExcludes:

Whether to use the IDEA specific default excludes when scanning for files. IDEA specific default excludes are given by the constant IDEA_DEFAULT_EXCLUDES: The *.iml, *.ipr and *.iws files.
  • Type: boolean
  • Required: No
  • Expression: ${rat.useIdeaDefaultExcludes}
  • Default: true

useMavenDefaultExcludes:

Whether to use the Maven specific default excludes when scanning for files. Maven specific default excludes are given by the constant MAVEN_DEFAULT_EXCLUDES: The target directory, the cobertura.ser file, and so on.
  • Type: boolean
  • Required: No
  • Expression: ${rat.useMavenDefaultExcludes}
  • Default: true