| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-plugin-report-plugin:3.15.2:report at 2026-03-22 |
| | Rendered using Apache Maven Fluido Skin 2.1.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>Plugin Details – Apache RAT™ Plugin for Apache Maven</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-2.1.0.min.js"></script> |
| <link href="https://creadur.apache.org/font/matesc.css" type="text/css" rel="stylesheet" /> |
| </head> |
| <body> |
| <a class="github-fork-ribbon right-top" href="https://github.com/apache/creadur-rat" data-ribbon="Fork me on GitHub">Fork me on GitHub</a> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href="https://www.apache.org/"><img src="https://www.apache.org/img/asf_logo.png" alt="The Apache Software Foundation" /> Apache RAT</a></h1></div></div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2026-03-22<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.0.0-SNAPSHOT<span class="divider">|</span></li> |
| <li><a href="https://www.apache.org/">Apache</a><span class="divider">/</span></li> |
| <li><a href="../../">Creadur</a><span class="divider">/</span></li> |
| <li><a href="../">RAT</a><span class="divider">/</span></li> |
| <li><a href="index.html">Apache RAT™ Plugin for Apache Maven</a><span class="divider">/</span></li> |
| <li class="active">Plugin Details</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Parent Project</li> |
| <li><a href="../index.html">Apache Creadur RAT</a></li> |
| <li class="nav-header">Overview</li> |
| <li><a href="index.html">Introduction</a></li> |
| <li class="active"><a>Goals</a></li> |
| <li><a href="mvn_options.html">Maven Options</a></li> |
| <li><a href="faq.html">FAQ</a></li> |
| <li class="nav-header">Examples</li> |
| <li><a href="examples/index.html">Introduction</a></li> |
| <li><a href="examples/basic.html">Basic use</a></li> |
| <li><a href="examples/verify.html">Running the plugin automatically</a></li> |
| <li><a href="examples/site.html">Adding a report to the site</a></li> |
| <li><a href="examples/custom-license.html">Custom license</a></li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> |
| <li><a href="project-reports.html"><span class="icon-chevron-down"></span>Project Reports</a> |
| <ul class="nav nav-list"> |
| <li><a href="jira-changes.html">JIRA Report</a></li> |
| <li><a href="taglist.html">Tag List</a></li> |
| <li><a href="checkstyle.html">Checkstyle</a></li> |
| <li><a href="apidocs/index.html">Javadoc</a></li> |
| <li><a href="xref/index.html">Source Xref</a></li> |
| <li><a href="xref-test/index.html">Test Source Xref</a></li> |
| <li><a href="pmd.html">PMD</a></li> |
| <li><a href="rat-report.html">RAT Report</a></li> |
| <li><a href="spotbugs.html">SpotBugs</a></li> |
| <li><a href="jacoco/index.html">JaCoCo</a></li> |
| <li class="active"><a>Plugin Details</a></li> |
| </ul></li> |
| <li class="nav-header">Apache RAT™</li> |
| <li><a href="../index.html">Introducing RAT</a></li> |
| <li><a href="../download_rat.cgi">Downloads</a></li> |
| <li><a href="../changes.html">Changes</a></li> |
| <li><a href="../apache-rat/known_issues.html">Known Issues</a></li> |
| <li><a href="../apache-rat/migration_guide.html">Migration Guide</a></li> |
| <li class="nav-header">RAT from the Command Line</li> |
| <li><a href="../apache-rat/index.html">Command Line Introduction</a></li> |
| <li><a href="../apache-rat/cli_options.html">Command Line Options</a></li> |
| <li><a href="../apache-rat/env_vars.html">Environment Variables</a></li> |
| <li><a href="../apache-rat-core/exclusion_expression.html">Exclusion Expressions</a></li> |
| <li><a href="../apache-rat/standard_collections.html">Standard Collections</a></li> |
| <li class="nav-header">RAT from Ant</li> |
| <li><a href="../apache-rat-tasks/index.html">Ant Task Introduction</a></li> |
| <li><a href="../apache-rat-tasks/ant_options.html">Ant Elements and Attributes</a></li> |
| <li class="nav-header">RAT from Maven</li> |
| <li><a href="../apache-rat-plugin/index.html">Maven Plugin Introduction</a></li> |
| <li><a href="../apache-rat-plugin/mvn_options.html">Maven Options</a></li> |
| <li><a href="../apache-rat-plugin/examples/index.html">Maven Examples</a></li> |
| <li class="nav-header">Configuring RAT</li> |
| <li><a href="../apache-rat/name_xref.html">Option Name Cross Reference</a></li> |
| <li><a href="../apache-rat/default_licenses.html">Default Licenses</a></li> |
| <li><a href="../apache-rat/default_matchers.html">Default Matchers</a></li> |
| <li><a href="../license_def.html">Defining New Licenses</a></li> |
| <li><a href="../apache-rat/xsd.html">Configuration XSD</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/default.xml">Default Configuration</a></li> |
| <li><a href="../apache-rat/detecting_generated_files.html">Detecting Generated Files</a></li> |
| <li class="nav-header">RAT Output</li> |
| <li><a href="../apache-rat/output/example.html">Standard Output Example</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/rat-report.xsd">Output XSD</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/plain-rat.xsl">XSLT - Plain text</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/missing-headers.xsl">XSLT - Missing headers list</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/unapproved-licenses.xsl">XSLT - Unapproved licenses list</a></li> |
| <li class="nav-header">Developing RAT</li> |
| <li><a href="../architecture.html">Architecture</a></li> |
| <li><a href="../apidocs/index.html">Javadocs</a></li> |
| <li><a href="../apache-rat-core/development/document_name.html">Document Name concept</a></li> |
| <li><a href="../development/ui_implementation.html">UI Development</a></li> |
| <li><a href="../apache-rat-core/development/write_file_processor.html">Writing a File Processor</a></li> |
| <li class="nav-header">Apache Creadur™</li> |
| <li><a href="../..">Creadur Project Home</a></li> |
| <li><a href="../../tentacles">Apache Tentacles</a></li> |
| <li><a href="../../whisker">Apache Whisker</a></li> |
| <li><a href="https://www.apache.org/security/">Security</a></li> |
| <li><a href="https://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li class="nav-header">The Apache Software Foundation</li> |
| <li><a href="https://www.apache.org/foundation">About the Foundation</a></li> |
| <li><a href="https://projects.apache.org">The projects</a></li> |
| <li><a href="https://people.apache.org">The people</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html">How we work</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html#history">Our history</a></li> |
| <li><a href="https://blogs.apache.org/foundation/">News</a></li> |
| <li class="nav-header">Contribute</li> |
| <li><a href="https://www.apache.org/foundation/getinvolved.html">Get Involved</a></li> |
| <li class="nav-header">Committer Info</li> |
| <li><a href="https://www.apache.org/dev/committers.html">ASF Committers' FAQ</a></li> |
| <li><a href="https://www.apache.org/dev/new-committers-guide.html">New Committers Guide</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-site/blob/asf-site/README.md">How to publish this site</a></li> |
| <li><a href="https://community.apache.org/">Community</a></li> |
| <li><a href="https://www.apache.org/legal/">Legal</a></li> |
| <li><a href="https://www.apache.org/foundation/marks/">Branding</a></li> |
| <li><a href="https://www.apache.org/press/">Media Relations</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy"><img class="builtBy" src="https://maven.apache.org/images/logos/maven-feather.png" /> Maven</a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| <section><a id="Plugin_Details"></a> |
| <h1>Plugin Details</h1> |
| <p>This report describes goals, parameters details, requirements and sample usage of this plugin.</p><section><a id="Goals"></a> |
| <h2>Goals</h2> |
| <p>Goals available for this plugin:</p> |
| <table class="table table-striped"> |
| <tr class="a"> |
| <th>Goal</th> |
| <th>Report?</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td><a href="./check-mojo.html">apache-rat:check</a></td> |
| <td>No</td> |
| <td>Run RAT to perform a violation check. |
| <p>This documentation mentions data types for some arguments.</p></td></tr> |
| <tr class="a"> |
| <td><a href="./help-mojo.html">apache-rat:help</a></td> |
| <td>No</td> |
| <td>Display help information on apache-rat-plugin. |
| <br /> |
| Call <code>mvn apache-rat:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.</td></tr> |
| <tr class="b"> |
| <td><a href="./rat-mojo.html">apache-rat:rat</a></td> |
| <td>Yes</td> |
| <td>Generates a report with RAT's output.</td></tr></table></section><section><a id="System_Requirements"></a> |
| <h2>System Requirements</h2> |
| <p>The following specifies the minimum requirements to run this Maven plugin:</p> |
| <table class="table table-striped"> |
| <tr class="a"> |
| <td>Maven</td> |
| <td>3.9</td></tr> |
| <tr class="b"> |
| <td>JDK</td> |
| <td>17</td></tr></table></section><section><a id="System_Requirements_History"></a> |
| <h2>System Requirements History</h2> |
| <p>The following specifies the minimum requirements to run this Maven plugin for historical versions:</p> |
| <table class="table table-striped"> |
| <tr class="a"> |
| <th>Plugin Version</th> |
| <th>Maven</th> |
| <th>JDK</th></tr> |
| <tr class="b"> |
| <td>0.18</td> |
| <td>3.9</td> |
| <td>17</td></tr> |
| <tr class="a"> |
| <td>from 0.16 to 0.17</td> |
| <td>3.2.5</td> |
| <td>8</td></tr> |
| <tr class="b"> |
| <td>from 0.14 to 0.15</td> |
| <td>2.2.1</td> |
| <td>8</td></tr> |
| <tr class="a"> |
| <td>from 0.9 to 0.13</td> |
| <td>2.2.1</td> |
| <td>5</td></tr> |
| <tr class="b"> |
| <td>from 0.6 to 0.8</td> |
| <td>2.0.4</td> |
| <td>1.4</td></tr></table></section><section><a id="Usage"></a> |
| <h2>Usage</h2> |
| <p>You should specify the version in your project's plugin configuration:</p> |
| <pre class="prettyprint"><code><project> |
| ... |
| <build> |
| <!-- To define the plugin version in your parent POM --> |
| <pluginManagement> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.rat</groupId> |
| <artifactId>apache-rat-plugin</artifactId> |
| <version>1.0.0-SNAPSHOT</version> |
| </plugin> |
| ... |
| </plugins> |
| </pluginManagement> |
| <!-- To use the plugin goals in your POM or parent POM --> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.rat</groupId> |
| <artifactId>apache-rat-plugin</artifactId> |
| </plugin> |
| ... |
| </plugins> |
| </build> |
| ... |
| <!-- To use the report goals in your POM or parent POM --> |
| <reporting> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.rat</groupId> |
| <artifactId>apache-rat-plugin</artifactId> |
| <version>1.0.0-SNAPSHOT</version> |
| </plugin> |
| ... |
| </plugins> |
| </reporting> |
| ... |
| </project></code></pre> |
| <p>For more information, see <a class="externalLink" href="https://maven.apache.org/guides/mini/guide-configuring-plugins.html">"Guide to Configuring Plug-ins"</a></p></section></section> </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| Copyright © 2016-2025 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache Creadur, Creadur, Apache RAT, Apache Tentacles, Apache Whisker, Apache and the ASF logo are trademarks |
| of The Apache Software Foundation. |
| Oracle and Java are registered trademarks of Oracle and/or its affiliates. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
