apache-rat:check

Full name:

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

Description:

Run Rat to perform a violation check.

This documentation mentions data types for some of the arguments. An explanation of the data types is included in this documentation package.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: validate.

Required Parameters

Name Type Since Description
<basedir> File - The base directory, in which to search for files.
Default: ${basedir}
User Property: rat.basedir

Optional Parameters

Name Type Since Description
<addDefaultLicenseMatchers> boolean -
Deprecated.
Use specific configuration under <configuration>.

Whether to add the default list of license matchers.
User Property: rat.addDefaultLicenseMatchers
<addDefaultLicenses> boolean -
Deprecated.
Deprecated for removal since 0.17: Use <configurationNoDefaults> instead (note the change of state).

Whether to add the default list of licenses.
User Property: rat.addDefaultLicenses
<addLicense> boolean -
Deprecated.
Deprecated for removal since 0.17: Use <editLicense> instead.

Add the default license header to any file with an unknown license that is not in the exclusion list.
User Property: rat.AddLicense
<addLicenseHeaders> String -
Deprecated.
Use <editLicense> and <editOverwrite>.

Whether to add license headers; possible values are forced, true, and false (default).
User Property: rat.addLicenseHeaders
<additionalLicenseFiles> String[] -
Deprecated.
Use specific configuration under <configuration>.

Specifies the additional licenses file.
<approvedLicenseFile> String -
Deprecated.
Use specific configuration under <configuration>.

The file of approved licenses
User Property: rat.approvedFile
<approvedLicenses> String[] -
Deprecated.
Use specific configuration under <configuration>.

The list of approved licenses
<config> String - File names for system configuration. Arguments should be File. (See Argument Types for clarification)
<configs> String[] - File names for system configuration. Arguments should be File. (See Argument Types for clarification)
<configurationNoDefaults> boolean - Ignore default configuration.
User Property: rat.ConfigurationNoDefaults
<consoleOutput> boolean 0.12 Whether to output the names of files that have unapproved licenses to the console. Defaults to true to ease builds in containers where you are unable to access rat.txt easily.
Default: true
User Property: rat.consoleOutput
<copyright> String -
Deprecated.
Deprecated for removal since 0.17: Use <editCopyright> instead.

The copyright message to use in the license headers.
User Property: rat.Copyright
<copyrightMessage> String -
Deprecated.
Deprecated for removal since 0.17: Use <editCopyright> instead.

Copyright message to add to license headers.
User Property: rat.copyrightMessage
<counterMax> String - The acceptable maximum number for the specified counter. A value of '-1' specifies an unlimited number. Arguments should be CounterPattern. (See Argument Types for clarification)
<counterMaxs> String[] - The acceptable maximum number for the specified counter. A value of '-1' specifies an unlimited number. Arguments should be CounterPattern. (See Argument Types for clarification)
<counterMin> String - The minimum number for the specified counter. Arguments should be CounterPattern. (See Argument Types for clarification)
<counterMins> String[] - The minimum number for the specified counter. Arguments should be CounterPattern. (See Argument Types for clarification)
<defaultLicenseFiles> String[] 0.8
Deprecated.
Use specific configuration under <configuration>.

Specifies the licenses to accept. By default, these are added to the default licenses, unless you set <addDefaultLicenseMatchers> to false. Arguments should be file name of <Configs> file structure.
<defaultReportFile> File -
Deprecated.
Use <outputFile> instead.

The default output file if no other is specified.
Default: ${project.build.directory}/rat.txt
<dryRun> boolean - If set do not update the files but generate the reports.
User Property: rat.DryRun
<editCopyright> String - The copyright message to use in the license headers. Usually in the form of "Copyright 2008 Foo". Only valid with <editLicense>
User Property: rat.EditCopyright
<editLicense> boolean - Add the default license header to any file with an unknown license that is not in the exclusion list. By default new files will be created with the license header, to force the modification of existing files use the <editOverwrite> option.
User Property: rat.EditLicense
<editOverwrite> boolean - Forces any changes in files to be written directly to the source files (i.e. new files are not created). Only valid with <editLicense>
User Property: rat.EditOverwrite
<exclude> String -
Deprecated.
Deprecated for removal since 0.17: Use <inputExclude> instead.

Excludes files matching <Expression>. Arguments should be Expression. (See Argument Types for clarification)
<excludeFile> String -
Deprecated.
Deprecated for removal since 0.17: Use <inputExcludeFile> instead.

Reads <Expression> entries from a file. Entries will be excluded from processing. Argument should be a File. (See Argument Types for clarification)
User Property: rat.ExcludeFile
<excludeSubProjects> boolean - Whether to exclude subprojects. This is recommended, if you want a separate apache-rat-plugin report for each subproject.
Default: true
User Property: rat.excludeSubprojects
<excludes> String[] -
Deprecated.
Deprecated for removal since 0.17: Use <inputExclude> instead.

Excludes files matching <Expression>. Arguments should be Expression. (See Argument Types for clarification)
<excludesFileCharset> String - Specifies the include files character set. If ${project.build.sourceEncoding} is not set defaults to UTF-8.
Default: ${project.build.sourceEncoding}
User Property: rat.excludesFileCharset
<families> Family[] -
Deprecated.
Use specific configuration under <configuration>.

The list of family definitions.
<force> boolean -
Deprecated.
Deprecated for removal since 0.17: Use <editOverwrite> instead.

Forces any changes in files to be written directly to the source files (i.e. new files are not created).
User Property: rat.Force
<helpLicenses> boolean - Print information about registered licenses.
User Property: rat.HelpLicenses
<ignoreErrors> boolean 0.9 Will ignore RAT errors and display a log message if any. Its use is NOT RECOMMENDED, but quite convenient on occasion.
Default: false
User Property: rat.ignoreErrors
<include> String -
Deprecated.
Deprecated for removal since 0.17: Use <inputInclude> instead.

Includes files matching <Expression>. Will override excluded files. Arguments should be Expression. (See Argument Types for clarification)
<includes> String[] -
Deprecated.
Deprecated for removal since 0.17: Use <inputInclude> instead.

Includes files matching <Expression>. Will override excluded files. Arguments should be Expression. (See Argument Types for clarification)
<includesFile> String -
Deprecated.
Deprecated for removal since 0.17: Use <inputIncludeFile> instead.

Reads <Expression> entries from a file. Entries will be excluded from processing. Argument should be a File. (See Argument Types for clarification)
User Property: rat.IncludesFile
<includesFileCharset> String - Specifies the include files character set. If ${project.build.sourceEncoding} is not set defaults to UTF-8.
Default: ${project.build.sourceEncoding}
User Property: rat.includesFileCharset
<inputExclude> String - Excludes files matching <Expression>. Arguments should be Expression. (See Argument Types for clarification)
<inputExcludeFile> String - Reads <Expression> entries from a file. Entries will be excluded from processing. Argument should be a File. (See Argument Types for clarification)
User Property: rat.InputExcludeFile
<inputExcludeParsedScm> String - Parse SCM based exclusion files to exclude specified files and directories. Arguments should be StandardCollection. (See Argument Types for clarification)
<inputExcludeParsedScms> String[] - Parse SCM based exclusion files to exclude specified files and directories. Arguments should be StandardCollection. (See Argument Types for clarification)
<inputExcludeSize> String - Excludes files with sizes less than the given argument. Argument should be a Integer. (See Argument Types for clarification)
User Property: rat.InputExcludeSize
<inputExcludeStd> String - Excludes files defined in standard collections based on commonly occurring groups. Arguments should be StandardCollection. (See Argument Types for clarification)
<inputExcludeStds> String[] - Excludes files defined in standard collections based on commonly occurring groups. Arguments should be StandardCollection. (See Argument Types for clarification)
<inputExcludes> String[] - Excludes files matching <Expression>. Arguments should be Expression. (See Argument Types for clarification)
<inputInclude> String - Includes files matching <Expression>. Will override excluded files. Arguments should be Expression. (See Argument Types for clarification)
<inputIncludeFile> String - Reads <Expression> entries from a file. Entries will override excluded files. Argument should be a File. (See Argument Types for clarification)
User Property: rat.InputIncludeFile
<inputIncludeStd> String - Includes files defined in standard collections based on commonly occurring groups. Will override excluded files. Arguments should be StandardCollection. (See Argument Types for clarification)
<inputIncludeStds> String[] - Includes files defined in standard collections based on commonly occurring groups. Will override excluded files. Arguments should be StandardCollection. (See Argument Types for clarification)
<inputIncludes> String[] - Includes files matching <Expression>. Will override excluded files. Arguments should be Expression. (See Argument Types for clarification)
<inputSource> String - A file containing file names to process. File names must use linux directory separator ('/') or none at all. File names that do not start with '/' are relative to the directory where the argument is located. Arguments should be File. (See Argument Types for clarification)
<inputSources> String[] - A file containing file names to process. File names must use linux directory separator ('/') or none at all. File names that do not start with '/' are relative to the directory where the argument is located. Arguments should be File. (See Argument Types for clarification)
<licenseFamilies> SimpleLicenseFamily[] 0.8
Deprecated.
Use LicenseFamily section of configuration file.

Specifies the license families to accept.
<licenseFamiliesApproved> String - The approved License Family IDs. These licenses families will be added to the list of approved licenses families. Arguments should be FamilyID. (See Argument Types for clarification)
<licenseFamiliesApprovedFile> String - Name of file containing the approved family IDs. Argument should be a File. (See Argument Types for clarification)
User Property: rat.LicenseFamiliesApprovedFile
<licenseFamiliesDenied> String - The denied License family IDs. These license families will be removed from the list of approved licenses. Arguments should be FamilyID. (See Argument Types for clarification)
<licenseFamiliesDeniedFile> String - Name of file containing the denied license IDs. Argument should be a File. (See Argument Types for clarification)
User Property: rat.LicenseFamiliesDeniedFile
<licenses> Object[] -
Deprecated.
Deprecated for removal since 0.17: Use specific configuration under <configuration>. See configuration file documentation.

The list of license definitions.
<licensesApproved> String - The approved License IDs. These licenses will be added to the list of approved licenses. Arguments should be LicenseID. (See Argument Types for clarification)
<licensesApprovedFile> String - Name of file containing the approved License IDs. Argument should be a File. (See Argument Types for clarification)
User Property: rat.LicensesApprovedFile
<licensesDenied> String - The denied License IDs. These licenses will be removed from the list of approved licenses. Once licenses are removed they can not be added back. Arguments should be LicenseID. (See Argument Types for clarification)
<licensesDeniedFile> String - Name of file containing the denied license IDs. Argument should be a File. (See Argument Types for clarification)
User Property: rat.LicensesDeniedFile
<listFamilies> String -
Deprecated.
Deprecated for removal since 0.17: Use <outputFamilies> instead.

List the defined license families. Argument should be a LicenseFilter. (See Argument Types for clarification)
User Property: rat.ListFamilies
<listLicenses> String -
Deprecated.
Deprecated for removal since 0.17: Use <outputLicenses> instead.

List the defined licenses. Argument should be a LicenseFilter. (See Argument Types for clarification)
User Property: rat.ListLicenses
<noDefaultLicenses> boolean -
Deprecated.
Deprecated for removal since 0.17: Use <configurationNoDefaults> instead.

Ignore default configuration.
User Property: rat.NoDefaultLicenses
<numUnapprovedLicenses> int -
Deprecated.
Use <counterMax>Unapproved:value</counterMax>.

Maximum number of files with unapproved licenses.
Default: 0
User Property: rat.numUnapprovedLicenses
<out> String -
Deprecated.
Deprecated for removal since 0.17: Use <outputFile> instead.

Define the output file where to write a report to. Argument should be a File. (See Argument Types for clarification)
User Property: rat.Out
<outputArchive> String - Specifies the level of detail in ARCHIVE file reporting. Argument should be a ProcessingType. (See Argument Types for clarification)
Default: NOTIFICATION
User Property: rat.OutputArchive
<outputFamilies> String - List the defined license families. Argument should be a LicenseFilter. (See Argument Types for clarification)
Default: NONE
User Property: rat.OutputFamilies
<outputFile> String - Define the output file where to write a report to. Argument should be a File. (See Argument Types for clarification)
Default: ${project.build.directory}/rat.txt
User Property: rat.OutputFile
<outputLicenses> String - List the defined licenses. Argument should be a LicenseFilter. (See Argument Types for clarification)
Default: NONE
User Property: rat.OutputLicenses
<outputStandard> String - Specifies the level of detail in STANDARD file reporting. Argument should be a ProcessingType. (See Argument Types for clarification)
Default: ABSENCE
User Property: rat.OutputStandard
<outputStyle> String - XSLT stylesheet to use when creating the report. Either an external xsl file may be specified or one of the internal named sheets. Argument should be a StyleSheet. (See Argument Types for clarification)
User Property: rat.OutputStyle
<parseSCMIgnoresAsExcludes> boolean -
Deprecated.
When set to true specifies that the STANDARD_SCMS exclusion file processors are used to exclude files and directories (e.g. ".gitignore" or ".hgignore"). Use "inputIncludeStd STANDARD_SCMS" to override.

Whether to parse source code management system (SCM) ignore files and use their contents as excludes. At the moment this works for the following SCMs:
See also: org.apache.rat.config.exclusion.StandardCollection
Default: true
User Property: rat.parseSCMIgnoresAsExcludes
<reportFile> File -
Deprecated.
Use 'out' property instead.

Where to store the report.
<reportStyle> String -
Deprecated.
Use setStyleSheet or xml instead.

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.
User Property: rat.outputStyle
<scanHiddenDirectories> boolean -
Deprecated.
Deprecated for removal since 0.17: Use <inputIncludeStd> with 'HIDDEN_DIR' argument instead.

Scans hidden directories.
User Property: rat.ScanHiddenDirectories
<skip> boolean 0.11 Will skip the plugin execution, e.g. for technical builds that do not take license compliance into account.
Default: false
User Property: rat.skip
<stylesheet> String -
Deprecated.
Deprecated for removal since 0.17: Use <outputStyle> instead.

XSLT stylesheet to use when creating the report. Argument should be a StyleSheet. (See Argument Types for clarification)
User Property: rat.Stylesheet
<useDefaultExcludes> boolean -
Deprecated.
When set to true specifies that the STANDARD_PATTERNS are excluded, as are the STANDARD_SCMS patterns. Use the various InputExclude and InputInclude elements to explicitly specify what to include or exclude.

Whether to use the default excludes when scanning for files. The default excludes are:
Default: true
User Property: rat.useDefaultExcludes
<useEclipseDefaultExcludes> boolean -
Deprecated.
When set to true specifies that the ECLIPSE patterns are excluded. Use "inputIncludeStd ECLIPSE" to override.

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: true
User Property: rat.useEclipseDefaultExcludes
<useIdeaDefaultExcludes> boolean -
Deprecated.
When set to true specifies that the IDEA patterns are excluded. Use "inputIncludeStd IDEA" to override.

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 and the .idea directory.
Default: true
User Property: rat.useIdeaDefaultExcludes
<useMavenDefaultExcludes> boolean -
Deprecated.
When set to true specifies that the MAVEN patterns are excluded. Use "inputIncludeStd MAVEN" to override.

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: true
User Property: rat.useMavenDefaultExcludes
<xml> boolean -
Deprecated.
Deprecated for removal since 0.17: Use <outputStyle> with the 'xml' argument instead.

forces XML output rather than the textual report.
User Property: rat.Xml

Parameter Details

<addDefaultLicenseMatchers>

Deprecated.
Use specific configuration under <configuration>.

Whether to add the default list of license matchers.
  • Type: boolean
  • Required: No
  • User Property: rat.addDefaultLicenseMatchers

<addDefaultLicenses>

Deprecated.
Deprecated for removal since 0.17: Use <configurationNoDefaults> instead (note the change of state).

Whether to add the default list of licenses.
  • Type: boolean
  • Required: No
  • User Property: rat.addDefaultLicenses

<addLicense>

Deprecated.
Deprecated for removal since 0.17: Use <editLicense> instead.

Add the default license header to any file with an unknown license that is not in the exclusion list.
  • Type: boolean
  • Required: No
  • User Property: rat.AddLicense

<addLicenseHeaders>

Deprecated.
Use <editLicense> and <editOverwrite>.

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

<additionalLicenseFiles>

Deprecated.
Use specific configuration under <configuration>.

Specifies the additional licenses file.
  • Type: java.lang.String[]
  • Required: No

<approvedLicenseFile>

Deprecated.
Use specific configuration under <configuration>.

The file of approved licenses
  • Type: java.lang.String
  • Required: No
  • User Property: rat.approvedFile

<approvedLicenses>

Deprecated.
Use specific configuration under <configuration>.

The list of approved licenses
  • Type: java.lang.String[]
  • Required: No

<basedir>

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

<config>

File names for system configuration. Arguments should be File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<configs>

File names for system configuration. Arguments should be File. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<configurationNoDefaults>

Ignore default configuration.
  • Type: boolean
  • Required: No
  • User Property: rat.ConfigurationNoDefaults

<consoleOutput>

Whether to output the names of files that have unapproved licenses to the console. Defaults to true to ease builds in containers where you are unable to access rat.txt easily.
  • Type: boolean
  • Since: 0.12
  • Required: No
  • User Property: rat.consoleOutput
  • Default: true

<copyright>

Deprecated.
Deprecated for removal since 0.17: Use <editCopyright> instead.

The copyright message to use in the license headers.
  • Type: java.lang.String
  • Required: No
  • User Property: rat.Copyright

<copyrightMessage>

Deprecated.
Deprecated for removal since 0.17: Use <editCopyright> instead.

Copyright message to add to license headers.
  • Type: java.lang.String
  • Required: No
  • User Property: rat.copyrightMessage

<counterMax>

The acceptable maximum number for the specified counter. A value of '-1' specifies an unlimited number. Arguments should be CounterPattern. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<counterMaxs>

The acceptable maximum number for the specified counter. A value of '-1' specifies an unlimited number. Arguments should be CounterPattern. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<counterMin>

The minimum number for the specified counter. Arguments should be CounterPattern. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<counterMins>

The minimum number for the specified counter. Arguments should be CounterPattern. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<defaultLicenseFiles>

Deprecated.
Use specific configuration under <configuration>.

Specifies the licenses to accept. By default, these are added to the default licenses, unless you set <addDefaultLicenseMatchers> to false. Arguments should be file name of <Configs> file structure.
  • Type: java.lang.String[]
  • Since: 0.8
  • Required: No

<defaultReportFile>

Deprecated.
Use <outputFile> instead.

The default output file if no other is specified.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/rat.txt

<dryRun>

If set do not update the files but generate the reports.
  • Type: boolean
  • Required: No
  • User Property: rat.DryRun

<editCopyright>

The copyright message to use in the license headers. Usually in the form of "Copyright 2008 Foo". Only valid with <editLicense>
  • Type: java.lang.String
  • Required: No
  • User Property: rat.EditCopyright

<editLicense>

Add the default license header to any file with an unknown license that is not in the exclusion list. By default new files will be created with the license header, to force the modification of existing files use the <editOverwrite> option.
  • Type: boolean
  • Required: No
  • User Property: rat.EditLicense

<editOverwrite>

Forces any changes in files to be written directly to the source files (i.e. new files are not created). Only valid with <editLicense>
  • Type: boolean
  • Required: No
  • User Property: rat.EditOverwrite

<exclude>

Deprecated.
Deprecated for removal since 0.17: Use <inputExclude> instead.

Excludes files matching <Expression>. Arguments should be Expression. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<excludeFile>

Deprecated.
Deprecated for removal since 0.17: Use <inputExcludeFile> instead.

Reads <Expression> entries from a file. Entries will be excluded from processing. Argument should be a File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.ExcludeFile

<excludeSubProjects>

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

<excludes>

Deprecated.
Deprecated for removal since 0.17: Use <inputExclude> instead.

Excludes files matching <Expression>. Arguments should be Expression. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<excludesFileCharset>

Specifies the include files character set. If ${project.build.sourceEncoding} is not set defaults to UTF-8.
  • Type: java.lang.String
  • Required: No
  • User Property: rat.excludesFileCharset
  • Default: ${project.build.sourceEncoding}

<families>

Deprecated.
Use specific configuration under <configuration>.

The list of family definitions.
  • Type: org.apache.rat.mp.Family[]
  • Required: No

<force>

Deprecated.
Deprecated for removal since 0.17: Use <editOverwrite> instead.

Forces any changes in files to be written directly to the source files (i.e. new files are not created).
  • Type: boolean
  • Required: No
  • User Property: rat.Force

<helpLicenses>

Print information about registered licenses.
  • Type: boolean
  • Required: No
  • User Property: rat.HelpLicenses

<ignoreErrors>

Will ignore RAT errors and display a log message if any. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Since: 0.9
  • Required: No
  • User Property: rat.ignoreErrors
  • Default: false

<include>

Deprecated.
Deprecated for removal since 0.17: Use <inputInclude> instead.

Includes files matching <Expression>. Will override excluded files. Arguments should be Expression. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<includes>

Deprecated.
Deprecated for removal since 0.17: Use <inputInclude> instead.

Includes files matching <Expression>. Will override excluded files. Arguments should be Expression. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<includesFile>

Deprecated.
Deprecated for removal since 0.17: Use <inputIncludeFile> instead.

Reads <Expression> entries from a file. Entries will be excluded from processing. Argument should be a File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.IncludesFile

<includesFileCharset>

Specifies the include files character set. If ${project.build.sourceEncoding} is not set defaults to UTF-8.
  • Type: java.lang.String
  • Required: No
  • User Property: rat.includesFileCharset
  • Default: ${project.build.sourceEncoding}

<inputExclude>

Excludes files matching <Expression>. Arguments should be Expression. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<inputExcludeFile>

Reads <Expression> entries from a file. Entries will be excluded from processing. Argument should be a File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.InputExcludeFile

<inputExcludeParsedScm>

Parse SCM based exclusion files to exclude specified files and directories. Arguments should be StandardCollection. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<inputExcludeParsedScms>

Parse SCM based exclusion files to exclude specified files and directories. Arguments should be StandardCollection. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<inputExcludeSize>

Excludes files with sizes less than the given argument. Argument should be a Integer. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.InputExcludeSize

<inputExcludeStd>

Excludes files defined in standard collections based on commonly occurring groups. Arguments should be StandardCollection. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<inputExcludeStds>

Excludes files defined in standard collections based on commonly occurring groups. Arguments should be StandardCollection. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<inputExcludes>

Excludes files matching <Expression>. Arguments should be Expression. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<inputInclude>

Includes files matching <Expression>. Will override excluded files. Arguments should be Expression. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<inputIncludeFile>

Reads <Expression> entries from a file. Entries will override excluded files. Argument should be a File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.InputIncludeFile

<inputIncludeStd>

Includes files defined in standard collections based on commonly occurring groups. Will override excluded files. Arguments should be StandardCollection. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<inputIncludeStds>

Includes files defined in standard collections based on commonly occurring groups. Will override excluded files. Arguments should be StandardCollection. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<inputIncludes>

Includes files matching <Expression>. Will override excluded files. Arguments should be Expression. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<inputSource>

A file containing file names to process. File names must use linux directory separator ('/') or none at all. File names that do not start with '/' are relative to the directory where the argument is located. Arguments should be File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<inputSources>

A file containing file names to process. File names must use linux directory separator ('/') or none at all. File names that do not start with '/' are relative to the directory where the argument is located. Arguments should be File. (See Argument Types for clarification)
  • Type: java.lang.String[]
  • Required: No

<licenseFamilies>

Deprecated.
Use LicenseFamily section of configuration file.

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

<licenseFamiliesApproved>

The approved License Family IDs. These licenses families will be added to the list of approved licenses families. Arguments should be FamilyID. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<licenseFamiliesApprovedFile>

Name of file containing the approved family IDs. Argument should be a File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.LicenseFamiliesApprovedFile

<licenseFamiliesDenied>

The denied License family IDs. These license families will be removed from the list of approved licenses. Arguments should be FamilyID. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<licenseFamiliesDeniedFile>

Name of file containing the denied license IDs. Argument should be a File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.LicenseFamiliesDeniedFile

<licenses>

Deprecated.
Deprecated for removal since 0.17: Use specific configuration under <configuration>. See configuration file documentation.

The list of license definitions.
  • Type: java.lang.Object[]
  • Required: No

<licensesApproved>

The approved License IDs. These licenses will be added to the list of approved licenses. Arguments should be LicenseID. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<licensesApprovedFile>

Name of file containing the approved License IDs. Argument should be a File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.LicensesApprovedFile

<licensesDenied>

The denied License IDs. These licenses will be removed from the list of approved licenses. Once licenses are removed they can not be added back. Arguments should be LicenseID. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No

<licensesDeniedFile>

Name of file containing the denied license IDs. Argument should be a File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.LicensesDeniedFile

<listFamilies>

Deprecated.
Deprecated for removal since 0.17: Use <outputFamilies> instead.

List the defined license families. Argument should be a LicenseFilter. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.ListFamilies

<listLicenses>

Deprecated.
Deprecated for removal since 0.17: Use <outputLicenses> instead.

List the defined licenses. Argument should be a LicenseFilter. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.ListLicenses

<noDefaultLicenses>

Deprecated.
Deprecated for removal since 0.17: Use <configurationNoDefaults> instead.

Ignore default configuration.
  • Type: boolean
  • Required: No
  • User Property: rat.NoDefaultLicenses

<numUnapprovedLicenses>

Deprecated.
Use <counterMax>Unapproved:value</counterMax>.

Maximum number of files with unapproved licenses.
  • Type: int
  • Required: No
  • User Property: rat.numUnapprovedLicenses
  • Default: 0

<out>

Deprecated.
Deprecated for removal since 0.17: Use <outputFile> instead.

Define the output file where to write a report to. Argument should be a File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.Out

<outputArchive>

Specifies the level of detail in ARCHIVE file reporting. Argument should be a ProcessingType. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.OutputArchive
  • Default: NOTIFICATION

<outputFamilies>

List the defined license families. Argument should be a LicenseFilter. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.OutputFamilies
  • Default: NONE

<outputFile>

Define the output file where to write a report to. Argument should be a File. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.OutputFile
  • Default: ${project.build.directory}/rat.txt

<outputLicenses>

List the defined licenses. Argument should be a LicenseFilter. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.OutputLicenses
  • Default: NONE

<outputStandard>

Specifies the level of detail in STANDARD file reporting. Argument should be a ProcessingType. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.OutputStandard
  • Default: ABSENCE

<outputStyle>

XSLT stylesheet to use when creating the report. Either an external xsl file may be specified or one of the internal named sheets. Argument should be a StyleSheet. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.OutputStyle

<parseSCMIgnoresAsExcludes>

Deprecated.
When set to true specifies that the STANDARD_SCMS exclusion file processors are used to exclude files and directories (e.g. ".gitignore" or ".hgignore"). Use "inputIncludeStd STANDARD_SCMS" to override.

Whether to parse source code management system (SCM) ignore files and use their contents as excludes. At the moment this works for the following SCMs:
See also: org.apache.rat.config.exclusion.StandardCollection
  • Type: boolean
  • Required: No
  • User Property: rat.parseSCMIgnoresAsExcludes
  • Default: true

<reportFile>

Deprecated.
Use 'out' property instead.

Where to store the report.
  • Type: java.io.File
  • Required: No

<reportStyle>

Deprecated.
Use setStyleSheet or xml instead.

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
  • User Property: rat.outputStyle

<scanHiddenDirectories>

Deprecated.
Deprecated for removal since 0.17: Use <inputIncludeStd> with 'HIDDEN_DIR' argument instead.

Scans hidden directories.
  • Type: boolean
  • Required: No
  • User Property: rat.ScanHiddenDirectories

<skip>

Will skip the plugin execution, e.g. for technical builds that do not take license compliance into account.
  • Type: boolean
  • Since: 0.11
  • Required: No
  • User Property: rat.skip
  • Default: false

<stylesheet>

Deprecated.
Deprecated for removal since 0.17: Use <outputStyle> instead.

XSLT stylesheet to use when creating the report. Argument should be a StyleSheet. (See Argument Types for clarification)
  • Type: java.lang.String
  • Required: No
  • User Property: rat.Stylesheet

<useDefaultExcludes>

Deprecated.
When set to true specifies that the STANDARD_PATTERNS are excluded, as are the STANDARD_SCMS patterns. Use the various InputExclude and InputInclude elements to explicitly specify what to include or exclude.

Whether to use the default excludes when scanning for files. The default excludes are:
  • Type: boolean
  • Required: No
  • User Property: rat.useDefaultExcludes
  • Default: true

<useEclipseDefaultExcludes>

Deprecated.
When set to true specifies that the ECLIPSE patterns are excluded. Use "inputIncludeStd ECLIPSE" to override.

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
  • User Property: rat.useEclipseDefaultExcludes
  • Default: true

<useIdeaDefaultExcludes>

Deprecated.
When set to true specifies that the IDEA patterns are excluded. Use "inputIncludeStd IDEA" to override.

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 and the .idea directory.
  • Type: boolean
  • Required: No
  • User Property: rat.useIdeaDefaultExcludes
  • Default: true

<useMavenDefaultExcludes>

Deprecated.
When set to true specifies that the MAVEN patterns are excluded. Use "inputIncludeStd MAVEN" to override.

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
  • User Property: rat.useMavenDefaultExcludes
  • Default: true

<xml>

Deprecated.
Deprecated for removal since 0.17: Use <outputStyle> with the 'xml' argument instead.

forces XML output rather than the textual report.
  • Type: boolean
  • Required: No
  • User Property: rat.Xml