| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/generate-adapter-metadata-mojo.xml at 2022-08-21 |
| | Rendered using Apache Maven Fluido Skin 1.11.1 |
| --> |
| <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>Apache Sling Maven Plugin – sling:generate-adapter-metadata</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.11.1.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.11.1.min.js"></script> |
| |
| <!-- Matomo --> |
| <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', '6']); |
| 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> |
| <!-- End Matomo Code --> |
| <style>.github-fork-ribbon:before { background-color: gray; }</style> |
| </head> |
| <body class="topBarDisabled"> |
| <a class="github-fork-ribbon right-top" href="https://github.com/apache/sling-maven-plugin" data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a> |
| <div class="container-fluid"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><a href="https://sling.apache.org/" id="bannerLeft"><img src="https://sling.apache.org/res/logos/sling.svg" alt="Apache Sling" style="width: 123px; height: 63px;" /></a></div> |
| <div class="pull-right"><a href="https://apache.org/" id="bannerRight"><img src="https://sling.apache.org/res/logos/apache.png" alt="Apache" style="" /></a></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li class=""><a href="https://sling.apache.org/" class="externalLink" title="Apache Sling">Apache Sling</a><span class="divider">/</span></li> |
| <li class=""><a href="https://sling.apache.org/components/" class="externalLink" title="Maven Plugins">Maven Plugins</a><span class="divider">/</span></li> |
| <li class=""><a href="index.html" title="Apache Sling Maven Plugin">Apache Sling Maven Plugin</a><span class="divider">/</span></li> |
| <li class="active ">sling:generate-adapter-metadata</li> |
| <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2022-08-21</li> |
| <li id="projectVersion" class="pull-right">Version: 3.0.2</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="bundle-installation.html" title="Bundle Installation"><span class="none"></span>Bundle Installation</a></li> |
| <li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</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> |
| </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="sling:generate-adapter-metadata"></a>sling:generate-adapter-metadata</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.apache.sling:sling-maven-plugin:3.0.2:generate-adapter-metadata</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Build <a class="externalLink" href="http://sling.apache.org/documentation/the-sling-engine/adapters.html#implementing-adaptable">adapter |
| metadata (JSON)</a> for the Web Console Plugin at |
| <code>/system/console/status-adapters</code> and |
| <code>/system/console/adapters</code> from classes annotated with |
| <a class="externalLink" href="https://github.com/apache/sling-adapter-annotations">adapter |
| annotations</a>.</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</li> |
| |
| <li>Requires dependency resolution of artifacts in scope: <code>compile</code>.</li> |
| |
| <li>The goal is thread-safe and supports parallel builds.</li> |
| |
| <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>process-classes</code>.</li> |
| </ul> |
| <section> |
| <h3><a name="Optional_Parameters"></a>Optional Parameters</h3> |
| |
| <table class="table table-striped" border="0"> |
| |
| <tr class="a"> |
| |
| <th>Name</th> |
| |
| <th>Type</th> |
| |
| <th>Since</th> |
| |
| <th>Description</th> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#buildOutputDirectory"><buildOutputDirectory></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>The directory which to check for classes with adapter metadata |
| annotations.<br /><b>Default value is</b>: <code>${project.build.outputDirectory}</code>.<br /><b>User property is</b>: <code>adapter.build.output.directory</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td align="left"><code><a href="#fileName"><fileName></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Name of the generated descriptor file (relative to |
| <code>outputDirectory</code>).<br /><b>Default value is</b>: <code>SLING-INF/adapters.json</code>.<br /><b>User property is</b>: <code>adapter.descriptor.name</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td align="left"><code><a href="#outputDirectory"><outputDirectory></a></code></td> |
| |
| <td><code>File</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>The output directory in which to emit the descriptor file with name |
| <code>fileName</code>.<br /><b>Default value is</b>: <code>${project.build.outputDirectory}</code>.<br /><b>User property is</b>: <code>adapter.output.directory</code>.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| <section> |
| <h4><a name="a.3CbuildOutputDirectory.3E"></a><b><a name="buildOutputDirectory"><buildOutputDirectory></a></b></h4> |
| |
| <div>The directory which to check for classes with adapter metadata |
| annotations.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>adapter.build.output.directory</code></li> |
| |
| <li><b>Default</b>: <code>${project.build.outputDirectory}</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CfileName.3E"></a><b><a name="fileName"><fileName></a></b></h4> |
| |
| <div>Name of the generated descriptor file (relative to |
| <code>outputDirectory</code>).</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>adapter.descriptor.name</code></li> |
| |
| <li><b>Default</b>: <code>SLING-INF/adapters.json</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CoutputDirectory.3E"></a><b><a name="outputDirectory"><outputDirectory></a></b></h4> |
| |
| <div>The output directory in which to emit the descriptor file with name |
| <code>fileName</code>.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.io.File</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>User Property</b>: <code>adapter.output.directory</code></li> |
| |
| <li><b>Default</b>: <code>${project.build.outputDirectory}</code></li> |
| </ul> |
| </section></section> |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2022 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a> | <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| <script> |
| if(anchors) { |
| anchors.add(); |
| } |
| </script> |
| </body> |
| </html> |