Maven Plugin API – PluginDescriptor

<!DOCTYPE html>  <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 1.11.1" /> <title>Maven Plugin API – PluginDescriptor</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.12.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-1.12.0.min.js"></script>  <script> var _paq = window._paq = window._paq || []; _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="https://analytics.apache.org/"; _paq.push(['setTrackerUrl', u+'/matomo.php']); _paq.push(['setSiteId', '3']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s); })(); </script>  </head> <body> <div class="container-fluid container-fluid-top"> <header> <div id="banner"> <div class="pull-left"><a href="../../../" id="bannerLeft"><img src="../../../images/apache-maven-project.png" alt="Maven Plugin API" style="" /></a></div> <div class="pull-right"><a href="../../../" id="bannerRight"><img src="../../../images/maven-logo-black-on-white.png" style="" /></a></div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> <li><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> <li><a href="../../" title="Ref">Ref</a><span class="divider">/</span></li> <li><a href="../" title="Maven 3.9.9">Maven 3.9.9</a><span class="divider">/</span></li> <li><a href="index.html" title="Maven Plugin API">Maven Plugin API</a><span class="divider">/</span></li> <li class="active ">PluginDescriptor <a href="https://github.com/apache/maven/tree/maven-3.9.9/maven-plugin-api/target/generated-site/xdoc/plugin.xml"><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-08-14</li> <li id="projectVersion" class="pull-right">Version: 3.9.9</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">Overview</li> <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li> <li><a href="apidocs/index.html" title="Javadocs"><span class="none"></span>Javadocs</a></li> <li><a href="xref/index.html" title="Source Xref"><span class="none"></span>Source Xref</a></li> <li class="nav-header">Reference</li> <li><a href="lifecycle-mappings.html" title="META-INF/maven/lifecycle.xml"><span class="none"></span>META-INF/maven/lifecycle.xml</a></li> <li class="active"><a><span class="none"></span>META-INF/maven/plugin.xml</a></li> <li class="nav-header">Descriptors Reference</li> <li><a href="../maven-model/maven.html" title="POM"><span class="none"></span>POM</a></li> <li><a href="../maven-settings/settings.html" title="Settings"><span class="none"></span>Settings</a></li> <li><a href="../maven-core/toolchains.html" title="Toolchains"><span class="none"></span>Toolchains</a></li> <li class="nav-header">Reference</li> <li><a href="../maven-core/lifecycles.html" title="Lifecycles"><span class="none"></span>Lifecycles</a></li> <li><a href="../maven-core/default-bindings.html" title="Plugin Bindings to Default Lifecycle"><span class="none"></span>Plugin Bindings to Default Lifecycle</a></li> <li><a href="../maven-core/artifact-handlers.html" title="Artifact Handlers"><span class="none"></span>Artifact Handlers</a></li> <li><a href="../maven-embedder/cli.html" title="CLI options"><span class="none"></span>CLI options</a></li> <li><a href="../maven-model-builder/super-pom.html" title="Super POM"><span class="none"></span>Super POM</a></li> <li class="nav-header">Development</li> <li><a href="../../../developers/index.html" title="Maven Developer Centre"><span class="none"></span>Maven Developer Centre</a></li> <li><a href="../../../core-its/index.html" title="Maven Core ITs"><span class="none"></span>Maven Core ITs</a></li> <li class="nav-header">Project Documentation</li> <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li> <li class="nav-header">Maven Projects</li> <li><a href="../../current" title="Maven"><span class="none"></span>Maven</a></li> <li><a href="../../../archetypes/index.html" title="Archetypes"><span class="none"></span>Archetypes</a></li> <li><a href="../../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> <li><a href="../../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> <li><a href="../../../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li> <li><a href="../../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> <li><a href="" title="Components"><span class="icon-chevron-down"></span>Components</a> <ul class="nav nav-list"> <li><a href="../../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> <li><a href="../../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> <li><a href="../../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> <li><a href="../../../maven-indexer/index.html" title="Indexer"><span class="none"></span>Indexer</a></li> <li><a href="../../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> <li><a href="../../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> <li><a href="../../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> <li><a href="../../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> <li><a href="../../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> <li><a href="../../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> <li><a href="../../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> <li><a href="../../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> </ul></li> <li class="nav-header">ASF</li> <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> <li><a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> </ul> </nav> <div class="well sidebar-nav"> <div id="poweredBy"> <div class="clear"></div> <div class="clear"></div> <div class="clear"></div> <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> </div> </div> </header> <main id="bodyColumn" class="span10" > <section> <h2><a name="PluginDescriptor"></a>PluginDescriptor</h2> <p>Plugin descriptor, stored in <code>META-INF/maven/plugin.xml</code> in a plugin's jar artifact. This descriptor is generally generated from plugin sources, using <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>. <p><i>Notice:</i> this documentation is generated from a Modello model but the <a href="apidocs/org/apache/maven/plugin/descriptor/PluginDescriptor.html"><code>PluginDescriptor</code></a>/<a href="apidocs/org/apache/maven/plugin/descriptor/MojoDescriptor.html"><code>MojoDescriptor</code></a> code executed is not generated from this model. Please report if you find anything wrong this documentation.</p> <div class="source"><pre class="prettyprint linenums"> <<a href="#class_plugin">plugin</a>> <name/> <description/> <groupId/> <artifactId/> <version/> <goalPrefix/> <isolatedRealm/> <inheritedByDefault/> <mojos> <<a href="#class_mojo">mojo</a>> <goal/> <description/> <implementation/> <language/> <phase/> <executePhase/> <executeGoal/> <executeLifecycle/> <requiresDependencyResolution/> <requiresDependencyCollection/> <requiresDirectInvocation/> <requiresProject/> <requiresReports/> <requiresOnline/> <aggregator/> <inheritedByDefault/> <threadSafe/> <instantiationStrategy/> <executionStrategy/> <since/> <deprecated/> <configurator/> <composer/> <parameters> <<a href="#class_parameter">parameter</a>> <name/> <alias/> <type/> <required/> <editable/> <implementation/> <description/> <since/> <deprecated/> </parameter> </parameters> <configuration> <<a href="#class_paramName">paramName</a> implementation=.. default-value=.. /> </configuration> <requirements> <<a href="#class_requirement">requirement</a>> <role/> <role-hint/> <field-name/> </requirement> </requirements> </mojo> </mojos> <dependencies> <<a href="#class_dependency">dependency</a>> <groupId/> <artifactId/> <version/> <type/> </dependency> </dependencies> </plugin> </pre></div> <a name="class_plugin"></a> <section> <h3><a name="plugin"></a>plugin</h3> <p>Root element of the <code>plugin.xml</code> file.</p> <table border="0" class="table table-striped"> <tr class="a"> <th>Element</th> <th>Type</th> <th>Description</th> </tr> <tr class="b"> <td align="left"> <code>name</code> </td> <td> <code>String</code> </td> <td>Name of the plugin.</td> </tr> <tr class="a"> <td align="left"> <code>description</code> </td> <td> <code>String</code> </td> <td>Description of the plugin.</td> </tr> <tr class="b"> <td align="left"> <code>groupId</code> </td> <td> <code>String</code> </td> <td>The group id of the plugin.</td> </tr> <tr class="a"> <td align="left"> <code>artifactId</code> </td> <td> <code>String</code> </td> <td>The artifact id of the plugin.</td> </tr> <tr class="b"> <td align="left"> <code>version</code> </td> <td> <code>String</code> </td> <td>The version of the plugin.</td> </tr> <tr class="a"> <td align="left"> <code>goalPrefix</code> </td> <td> <code>String</code> </td> <td></td> </tr> <tr class="b"> <td align="left"> <code>isolatedRealm</code> </td> <td> <code>boolean</code> </td> <td> <p><b>Default value</b>: <code>false</code></p></td> </tr> <tr class="a"> <td align="left"> <code>inheritedByDefault</code> </td> <td> <code>boolean</code> </td> <td> <p><b>Default value</b>: <code>true</code></p></td> </tr> <tr class="b"> <td align="left"> <code>mojos/<a href="#class_mojo">mojo</a>*</code> </td> <td> <code>List<MojoDescriptor></code> </td> <td><b>(Many)</b> Description of each Mojo provided by the plugin.</td> </tr> <tr class="a"> <td align="left"> <code>dependencies/<a href="#class_dependency">dependency</a>*</code> </td> <td> <code>List<Dependency></code> </td> <td><b>(Many)</b> A set of dependencies which the plugin requires in order to function. This enables the plugin to function independently of its POM (or at least to declare the libraries it needs to run).</td> </tr> </table> </section> <a name="class_mojo"></a> <section> <h3><a name="mojo"></a>mojo</h3> <p>A Mojo description.</p> <table border="0" class="table table-striped"> <tr class="a"> <th>Element</th> <th>Type</th> <th>Description</th> </tr> <tr class="b"> <td align="left"> <code>goal</code> </td> <td> <code>String</code> </td> <td>The goal name for the Mojo, that users will reference from the command line to execute the Mojo directly, or inside a POM in order to provide Mojo-specific configuration.</td> </tr> <tr class="a"> <td align="left"> <code>description</code> </td> <td> <code>String</code> </td> <td>The description of this Mojo's functionality.</td> </tr> <tr class="b"> <td align="left"> <code>implementation</code> </td> <td> <code>String</code> </td> <td>The Mojo's fully-qualified class name (or script path in the case of non-Java Mojos).</td> </tr> <tr class="a"> <td align="left"> <code>language</code> </td> <td> <code>String</code> </td> <td>The implementation language for this Mojo (java, beanshell, etc.). <p><b>Default value</b>: <code>java</code></p></td> </tr> <tr class="b"> <td align="left"> <code>phase</code> </td> <td> <code>String</code> </td> <td>Defines a default phase to bind a mojo execution to if the user does not explicitly set a phase in the POM. <i>Note:</i> This will not automagically make a mojo run when the plugin declaration is added to the POM. It merely enables the user to omit the <code><phase></code> element from the surrounding <code><execution></code> element.</td> </tr> <tr class="a"> <td align="left"> <code>executePhase</code> </td> <td> <code>String</code> </td> <td>Reference the invocation phase of the Mojo.</td> </tr> <tr class="b"> <td align="left"> <code>executeGoal</code> </td> <td> <code>String</code> </td> <td>Reference the invocation goal of the Mojo.</td> </tr> <tr class="a"> <td align="left"> <code>executeLifecycle</code> </td> <td> <code>String</code> </td> <td></td> </tr> <tr class="b"> <td align="left"> <code>requiresDependencyResolution</code> </td> <td> <code>String</code> </td> <td>Flags this Mojo as requiring the dependencies in the specified class path to be resolved before it can execute: <code>compile</code>, <code>runtime</code>, <code>test</code>, <code>compile+runtime</code> (since Maven 3.0) or <code>runtime+system</code> (since Maven 3.0) <p><b>Default value</b>: <code>runtime</code></p></td> </tr> <tr class="a"> <td align="left"> <code>requiresDependencyCollection</code> </td> <td> <code>String</code> </td> <td>Flags this mojo as requiring information about the dependencies that would make up the specified class path. As the name suggests, this is similar to requiresDependencyResolution and supports the same values. The important difference is this will not resolve the files for the dependencies, i.e. the artifacts associated with a Maven project can lack a file. As such, this annotation is meant for mojos that only want to analyze the set of transitive dependencies, in particular during early lifecycle phases where full dependency resolution might fail due to projects which haven't been built yet.</td> </tr> <tr class="b"> <td align="left"> <code>requiresDirectInvocation</code> </td> <td> <code>boolean</code> </td> <td>Flags this Mojo to be invoked directly only. <p><b>Default value</b>: <code>false</code></p></td> </tr> <tr class="a"> <td align="left"> <code>requiresProject</code> </td> <td> <code>boolean</code> </td> <td>Flags this Mojo to require running inside of a project. <p><b>Default value</b>: <code>true</code></p></td> </tr> <tr class="b"> <td align="left"> <code>requiresReports</code> </td> <td> <code>boolean</code> </td> <td>Flags this Mojo to require running inside of a reports context. Unsupported since Maven 3.0. <p><b>Default value</b>: <code>false</code></p></td> </tr> <tr class="a"> <td align="left"> <code>requiresOnline</code> </td> <td> <code>boolean</code> </td> <td>Flags this Mojo to require online mode for its operation. <p><b>Default value</b>: <code>false</code></p></td> </tr> <tr class="b"> <td align="left"> <code>aggregator</code> </td> <td> <code>boolean</code> </td> <td>Flags this Mojo to run it in a multi module way, i.e. aggregate the build with the set of projects listed as modules. <p><b>Default value</b>: <code>false</code></p></td> </tr> <tr class="a"> <td align="left"> <code>inheritedByDefault</code> </td> <td> <code>boolean</code> </td> <td>Specify that the Mojo is inherited. <p><b>Default value</b>: <code>true</code></p></td> </tr> <tr class="b"> <td align="left"> <code>threadSafe</code> </td> <td> <code>boolean</code> </td> <td>Marks this mojo as being thread-safe, i.e. the mojo safely supports concurrent execution during parallel builds. Mojos without this annotation will make Maven output a warning when used during a parallel build session. Since Maven 3.0. <p><b>Default value</b>: <code>false</code></p></td> </tr> <tr class="a"> <td align="left"> <code>instantiationStrategy</code> </td> <td> <code>String</code> </td> <td>Specify the instantiation strategy. <p><b>Default value</b>: <code>per-lookup</code></p></td> </tr> <tr class="b"> <td align="left"> <code>executionStrategy</code> </td> <td> <code>String</code> </td> <td>Specify the execution strategy: <code>once-per-session</code>, <code>always</code>. <p><b>Default value</b>: <code>once-per-session</code></p></td> </tr> <tr class="a"> <td align="left"> <code>since</code> </td> <td> <code>String</code> </td> <td>Specify the version when the Mojo was added to the API. Similar to Javadoc since.</td> </tr> <tr class="b"> <td align="left"> <code>deprecated</code> </td> <td> <code>String</code> </td> <td>Description with the reason of Mojo deprecation. Similar to Javadoc <code>@deprecated</code> This will trigger a warning when a user tries to use a Mojo marked as deprecated.</td> </tr> <tr class="a"> <td align="left"> <code>configurator</code> </td> <td> <code>String</code> </td> <td>The configurator type to use when injecting parameter values into this Mojo. The value is normally deduced from the Mojo's implementation language, but can be specified to allow a custom ComponentConfigurator implementation to be used.</td> </tr> <tr class="b"> <td align="left"> <code>composer</code> </td> <td> <code>String</code> </td> <td></td> </tr> <tr class="a"> <td align="left"> <code>parameters/<a href="#class_parameter">parameter</a>*</code> </td> <td> <code>List<Parameter></code> </td> <td><b>(Many)</b> </td> </tr> <tr class="b"> <td align="left"> <code>configuration/<a href="#class_paramName">paramName</a>*</code> </td> <td> <code>List<Configuration></code> </td> <td><b>(Many)</b> </td> </tr> <tr class="a"> <td align="left"> <code>requirements/<a href="#class_requirement">requirement</a>*</code> </td> <td> <code>List<Requirement></code> </td> <td><b>(Many)</b> </td> </tr> </table> </section> <a name="class_parameter"></a> <section> <h3><a name="parameter"></a>parameter</h3> <p>A phase mapping definition.</p> <table border="0" class="table table-striped"> <tr class="a"> <th>Element</th> <th>Type</th> <th>Description</th> </tr> <tr class="b"> <td align="left"> <code>name</code> </td> <td> <code>String</code> </td> <td>The name of the parameter, to be used while configuring this parameter from the Mojo's declared defaults or from the POM.</td> </tr> <tr class="a"> <td align="left"> <code>alias</code> </td> <td> <code>String</code> </td> <td>Specifies an alias which can be used to configure this parameter from the POM. This is primarily useful to improve user-friendliness, where Mojo field names are not intuitive to the user or are otherwise not conducive to configuration via the POM.</td> </tr> <tr class="b"> <td align="left"> <code>type</code> </td> <td> <code>String</code> </td> <td>The Java type for this parameter. This is used to validate the result of any expressions used to calculate the value which should be injected into the Mojo for this parameter.</td> </tr> <tr class="a"> <td align="left"> <code>required</code> </td> <td> <code>boolean</code> </td> <td>Whether this parameter is required for the Mojo to function. This is used to validate the configuration for a Mojo before it is injected, and before the Mojo is executed from some half-state. <p><b>Default value</b>: <code>false</code></p></td> </tr> <tr class="b"> <td align="left"> <code>editable</code> </td> <td> <code>boolean</code> </td> <td>Specifies that this parameter can be configured directly by the user (as in the case of POM-specified configuration). This is useful when you want to force the user to use common POM elements rather than plugin configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you want the user to modify <code><build><finalName/></build></code> rather than specifying a value for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a List-typed parameter which expects items of type Artifact doesn't get a List full of Strings. <p><b>Default value</b>: <code>true</code></p></td> </tr> <tr class="a"> <td align="left"> <code>implementation</code> </td> <td> <code>String</code> </td> <td></td> </tr> <tr class="b"> <td align="left"> <code>description</code> </td> <td> <code>String</code> </td> <td>The description of this parameter's use inside the Mojo.</td> </tr> <tr class="a"> <td align="left"> <code>since</code> </td> <td> <code>String</code> </td> <td>Specify the version when the parameter was added to the API. Similar to Javadoc since.</td> </tr> <tr class="b"> <td align="left"> <code>deprecated</code> </td> <td> <code>String</code> </td> <td>Description with the reason of parameter deprecation. Similar to Javadoc <code>@deprecated</code> This will trigger a warning when a user tries to configure a parameter marked as deprecated.</td> </tr> </table> </section> <a name="class_paramName"></a> <section> <h3><a name="paramName"></a>paramName</h3> <p>A parameter configuration.</p> <p> <b>Element Content: </b>Parameter expression, to let user override default value with a user property, system property or project property.</p> <table border="0" class="table table-striped"> <tr class="a"> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> <tr class="b"> <td align="left"> <code>implementation</code> </td> <td> <code>String</code> </td> <td></td> </tr> <tr class="a"> <td align="left"> <code>default-value</code> </td> <td> <code>String</code> </td> <td>The default value, as an expression that will be evaluated at injection or run-time.</td> </tr> </table> </section> <a name="class_requirement"></a> <section> <h3><a name="requirement"></a>requirement</h3> <p>Describes a component requirement.</p> <table border="0" class="table table-striped"> <tr class="a"> <th>Element</th> <th>Type</th> <th>Description</th> </tr> <tr class="b"> <td align="left"> <code>role</code> </td> <td> <code>String</code> </td> <td></td> </tr> <tr class="a"> <td align="left"> <code>role-hint</code> </td> <td> <code>String</code> </td> <td></td> </tr> <tr class="b"> <td align="left"> <code>field-name</code> </td> <td> <code>String</code> </td> <td>The field name which has this requirement.</td> </tr> </table> </section> <a name="class_dependency"></a> <section> <h3><a name="dependency"></a>dependency</h3> <p>Definition of a dependency, needed by the plugin at runtime.</p> <table border="0" class="table table-striped"> <tr class="a"> <th>Element</th> <th>Type</th> <th>Description</th> </tr> <tr class="b"> <td align="left"> <code>groupId</code> </td> <td> <code>String</code> </td> <td>The group id of the dependency.</td> </tr> <tr class="a"> <td align="left"> <code>artifactId</code> </td> <td> <code>String</code> </td> <td>The artifact id of the dependency.</td> </tr> <tr class="b"> <td align="left"> <code>version</code> </td> <td> <code>String</code> </td> <td>The version of the dependency.</td> </tr> <tr class="a"> <td align="left"> <code>type</code> </td> <td> <code>String</code> </td> <td>The type of dependency. <p><b>Default value</b>: <code>jar</code></p></td> </tr> </table> </section> </section> </main> </div> </div> <hr/> <footer> <div class="container-fluid"> <div class="row-fluid"> <p>© 2001–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a> </p> </div> </div> </footer> <script> if(anchors) { anchors.add(); } </script> </body> </html>

CINXE.COM

Maven Plugin API – PluginDescriptor