| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2020-01-16 |
| | Rendered using Apache Maven Fluido Skin 1.6 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20200116" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Apache Sling Feature Model Converter Plugin – sling-feature-converter:convert-cp</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h2>Apache Sling Feature Model Converter Plugin</h2> |
| </div> |
| </div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2020-01-16<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.0.4</li> |
| </ul> |
| </div> |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span2"> |
| <div 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="plugin-info.html" title="Goals"><span class="none"></span>Goals</a> </li> |
| <li><a href="usage.html" title="Usage"><span class="none"></span>Usage</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> |
| <hr /> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <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> |
| </div> |
| <div id="bodyColumn" class="span10" > |
| |
| |
| <div class="section"> |
| <h2><a name="sling-feature-converter:convert-cp"></a>sling-feature-converter:convert-cp</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.apache.sling:sling-feature-converter-maven-plugin:1.0.4:convert-cp</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Converts the given Content Packages into Feature Models and places |
| the converted Content Package into the local Maven Repository</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</li> |
| </ul> |
| |
| <div class="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><tt><a href="#artifactIdOverride"><artifactIdOverride></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the Content Package is strictly |
| validated.<br /><b>User property is</b>: <tt>artifactIdOverride</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#bundleStartOrder"><bundleStartOrder></a></tt></td> |
| |
| <td><tt>int</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the Content Package is strictly |
| validated.<br /><b>Default value is</b>: <tt>20</tt>.<br /><b>User property is</b>: <tt>bundleStartOrder</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#contentPackages"><contentPackages></a></tt></td> |
| |
| <td><tt>List</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>List of Content Packages to be converted<br /><b>User property is</b>: <tt>packages</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#convertedCPOutput"><convertedCPOutput></a></tt></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Target directory for the Converted Content Package file<br /><b>Default value is</b>: <tt>${project.build.directory}/cp-conversion</tt>.<br /><b>User property is</b>: <tt>convertedContentPackageOutputDirectory</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#fmOutput"><fmOutput></a></tt></td> |
| |
| <td><tt>File</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>Target directory for the converted Content Package Feature Model |
| file<br /><b>Default value is</b>: <tt>${project.build.directory}/cp-conversion/fm.out</tt>.<br /><b>User property is</b>: <tt>featureModelsOutputDirectory</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#fmPrefix"><fmPrefix></a></tt></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>System Properties to hand over to the Content Package Converter<br /><b>User property is</b>: <tt>fmPrefix</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#installConvertedCP"><installConvertedCP></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the converted Content Package will be |
| installed in the local Maven Repository<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>installConvertedContentPackage</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#isContentPackage"><isContentPackage></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the module is handled as Content |
| Package<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>isContentPackage</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#mergeConfigurations"><mergeConfigurations></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the OSGi Configurations with same PID |
| are merged.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>mergeConfigurations</tt>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><tt><a href="#strictValidation"><strictValidation></a></tt></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If set to <tt>true</tt> the Content Package is strictly |
| validated.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>strictValidation</tt>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><tt><a href="#systemProperties"><systemProperties></a></tt></td> |
| |
| <td><tt>List</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>System Properties to hand over to the Content Package Converter<br /><b>User property is</b>: <tt>cpSystemProperties</tt>.<br /></td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="section"> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| |
| <div class="section"> |
| <h4><a name="a.3CartifactIdOverride.3E"></a><b><a name="artifactIdOverride"><artifactIdOverride></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the Content Package is strictly |
| validated.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>artifactIdOverride</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CbundleStartOrder.3E"></a><b><a name="bundleStartOrder"><bundleStartOrder></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the Content Package is strictly |
| validated.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>int</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>bundleStartOrder</tt></li> |
| |
| <li><b>Default</b>: <tt>20</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CcontentPackages.3E"></a><b><a name="contentPackages"><contentPackages></a></b></h4> |
| |
| <div>List of Content Packages to be converted</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.util.List</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>packages</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CconvertedCPOutput.3E"></a><b><a name="convertedCPOutput"><convertedCPOutput></a></b></h4> |
| |
| <div>Target directory for the Converted Content Package file</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.io.File</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>convertedContentPackageOutputDirectory</tt></li> |
| |
| <li><b>Default</b>: <tt>${project.build.directory}/cp-conversion</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CfmOutput.3E"></a><b><a name="fmOutput"><fmOutput></a></b></h4> |
| |
| <div>Target directory for the converted Content Package Feature Model |
| file</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.io.File</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>featureModelsOutputDirectory</tt></li> |
| |
| <li><b>Default</b>: <tt>${project.build.directory}/cp-conversion/fm.out</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CfmPrefix.3E"></a><b><a name="fmPrefix"><fmPrefix></a></b></h4> |
| |
| <div>System Properties to hand over to the Content Package Converter</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>fmPrefix</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CinstallConvertedCP.3E"></a><b><a name="installConvertedCP"><installConvertedCP></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the converted Content Package will be |
| installed in the local Maven Repository</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>installConvertedContentPackage</tt></li> |
| |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CisContentPackage.3E"></a><b><a name="isContentPackage"><isContentPackage></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the module is handled as Content |
| Package</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>isContentPackage</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CmergeConfigurations.3E"></a><b><a name="mergeConfigurations"><mergeConfigurations></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the OSGi Configurations with same PID |
| are merged.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>mergeConfigurations</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CstrictValidation.3E"></a><b><a name="strictValidation"><strictValidation></a></b></h4> |
| |
| <div>If set to <tt>true</tt> the Content Package is strictly |
| validated.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>strictValidation</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /></div> |
| <div class="section"> |
| <h4><a name="a.3CsystemProperties.3E"></a><b><a name="systemProperties"><systemProperties></a></b></h4> |
| |
| <div>System Properties to hand over to the Content Package Converter</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.util.List</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>cpSystemProperties</tt></li> |
| </ul> |
| </div></div> |
| </div> |
| |
| |
| </div> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>Copyright ©2007–2020 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| All rights reserved.</p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
