Fork me on GitHub

sling-feature-converter:convert-cp

Full name:

org.apache.sling:sling-feature-converter-maven-plugin:1.0.12:convert-cp

Description:

Converts the given Content Packages into Feature Models and places the converted Content Package into the local Maven Repository

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Optional Parameters

Name Type Since Description
<apiRegions> List<String> - Specify the API Regions that the generated feature is made part of
User Property: apiRegions
<artifactIdOverride> String - If set to true the Content Package is strictly validated.
User Property: artifactIdOverride
<bundleStartOrder> int - If set to true the Content Package is strictly validated.
Default: 20
User Property: bundleStartOrder
<contentPackages> List<ContentPackage> - List of Content Packages to be converted
User Property: packages
<convertedCPOutput> File - Target directory for the Converted Content Package file
Default: ${project.build.directory}/cp-conversion
User Property: convertedContentPackageOutputDirectory
<exportToApiRegion> String - Specify the API Region to export all exported packages to, if not specified packages will not be added to the api-regions extension.
User Property: exportToApiRegion
<filterPatterns> List<String> - Regex based pattern(s) to reject content-package archive entries.
User Property: filterPatterns
<fmOutput> File - Target directory for the converted Content Package Feature Model file
Default: ${project.build.directory}/cp-conversion/fm.out
User Property: featureModelsOutputDirectory
<fmPrefix> String - System Properties to hand over to the Content Package Converter
User Property: fmPrefix
<installConvertedCP> boolean - If set to true the converted Content Package will be installed in the local Maven Repository
Default: true
User Property: installConvertedContentPackage
<isContentPackage> boolean - If set to true the module is handled as Content Package
Default: false
User Property: isContentPackage
<mergeConfigurations> boolean - If set to true the OSGi Configurations with same PID are merged.
Default: false
User Property: mergeConfigurations
<repoSession> RepositorySystemSession - No description.
Default: ${repositorySystemSession}
<strictValidation> boolean - If set to true the Content Package is strictly validated.
Default: false
User Property: strictValidation
<systemProperties> List<String> - System Properties to hand over to the Content Package Converter
User Property: cpSystemProperties

Parameter Details

<apiRegions>

Specify the API Regions that the generated feature is made part of
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: apiRegions

<artifactIdOverride>

If set to true the Content Package is strictly validated.
  • Type: java.lang.String
  • Required: No
  • User Property: artifactIdOverride

<bundleStartOrder>

If set to true the Content Package is strictly validated.
  • Type: int
  • Required: No
  • User Property: bundleStartOrder
  • Default: 20

<contentPackages>

List of Content Packages to be converted
  • Type: java.util.List<org.apache.sling.cpconverter.maven.mojos.ContentPackage>
  • Required: No
  • User Property: packages

<convertedCPOutput>

Target directory for the Converted Content Package file
  • Type: java.io.File
  • Required: No
  • User Property: convertedContentPackageOutputDirectory
  • Default: ${project.build.directory}/cp-conversion

<exportToApiRegion>

Specify the API Region to export all exported packages to, if not specified packages will not be added to the api-regions extension.
  • Type: java.lang.String
  • Required: No
  • User Property: exportToApiRegion

<filterPatterns>

Regex based pattern(s) to reject content-package archive entries.
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: filterPatterns

<fmOutput>

Target directory for the converted Content Package Feature Model file
  • Type: java.io.File
  • Required: No
  • User Property: featureModelsOutputDirectory
  • Default: ${project.build.directory}/cp-conversion/fm.out

<fmPrefix>

System Properties to hand over to the Content Package Converter
  • Type: java.lang.String
  • Required: No
  • User Property: fmPrefix

<installConvertedCP>

If set to true the converted Content Package will be installed in the local Maven Repository
  • Type: boolean
  • Required: No
  • User Property: installConvertedContentPackage
  • Default: true

<isContentPackage>

If set to true the module is handled as Content Package
  • Type: boolean
  • Required: No
  • User Property: isContentPackage
  • Default: false

<mergeConfigurations>

If set to true the OSGi Configurations with same PID are merged.
  • Type: boolean
  • Required: No
  • User Property: mergeConfigurations
  • Default: false

<repoSession>

No description.
  • Type: org.eclipse.aether.RepositorySystemSession
  • Required: No
  • Default: ${repositorySystemSession}

<strictValidation>

If set to true the Content Package is strictly validated.
  • Type: boolean
  • Required: No
  • User Property: strictValidation
  • Default: false

<systemProperties>

System Properties to hand over to the Content Package Converter
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: cpSystemProperties