Using the Carbon P2 Plugin

Generate P2 repositories

Configuring the P2-repo-gen Maven goal

Publish a product into a P2 repository

Configuring the publish-product Maven goal

Generate product profiles

Configuring the materialize-product Maven goal

Install Carbon features into a product profile

Configuring the p2-profile-gen Maven goal

The Id of the feature being generated.

The copyright text that should be attached to the feature.xml file.

The license URL that should be given in the feature.xml file.

This points to the location of the manifest file. The content in this file is considered if the manifest is present when generating the feature.xml file. This manifest file is copied and its content will be updated as the feature.xml file.

This points to the location of the properties file. Properties of the property file (if exists) are merged with the properties passed to the Maven goal through the <properties> parameter explained below.

<propertyFile>PATH_FOR_THE_PROPERTY_FILE</propertyFile>

A collection of key-value pairs passed to the Maven goal, which should be written to the feature.properties output file. 

Content to be written to the p2.inf output file are fed into the p2-feature-gen maven goal using this adviceFile property.

Specifies the OSGI bundles that should be included in the feature being created. These bundles should be given as maven coordinates. The P2 plugin supports 3 variations as shown below:

<bundles>
 	<bundleDef>{groupId}:{artifactId}:{version}</bundleDef>
 	<bundleDef>{groupId}:{artifactId}:{version}:	{compatibility}</bundleDef>
 	<bundleDef>{groupId}:{artifactId}:{compatibility}:{version}</bundleDef>
</bundles>

If the 1st bundle format is used, the default value for compatibility, which is “equivalent” is used.

The following values are permitted for compatibility;

• perfect

• equivalent

• compatible

• greaterOrEqual

• patch

Carbon features that need to be included in the feature being built are specified using the includeFeatures property. These included features are copied to the final output ZIP file. Included features can be given in 4 different ways as shown below.

<includedFeatures>
 <featureDef>{groupId}:{artifactId}</featureDef>        
 <featureDef>{groupId}:{artifactId}:{version}</featureDef>
 <featureDef>{groupId}:{artifactId}:optional</featureDef>
 <featureDef>{groupId}:{artifactId}:{version}:optional</featureDef>
</includedFeature>

If the term “optional” is given as a featureDef, that feature is marked as optional.

The dependant features for the feature being built are included here. These import features are included in the feature.xml file, but are not copied to the final ZIP file. Import features can be given in 5 different ways as shown below.

<importFeatures>                              
<featureDef>{featureId}</featureDef>         
<featureDef>{featureId}:{compatibility}</featureDef> 
<featureDef>{featureId}:{compatibility}:{version}</featureDef>
<featureDef>{featureId}:{version}</featureDef> 
<featureDef>{featureId}:{version}:{compatible}</featureDef> 
</importFeatures>

By default, the compatibility is set to "equivalent". If compatibility is set to “optional” then this import feature is marked as “optional” and the compatibility is set to “equivalent”.

The following values are permitted for compatibility;

• perfect

• equivalent

• compatible

• greaterOrEqual

• patch

The name of the newly created artifact repository. If you do not specify this, the artifact ID of the project is taken by default.

The URL of the location where the metadata repository should be created.

The URL of the location where the artifact repository should be created.

Important: For carbon, both artifacts and metadata reside in the same repository. Therefore, the value for both metadataRepository and artifactRepository should be the same.

<artifactRepository>file:/home/p2-repo</artifactRepository>

The set of features that need to be included in the repository are passed to the p2-repo-gen maven goal through this parameter. Features can be provided in 2 different ways as shown below.

<featureArtifacts>
   <featureArtifactDef>{groupId}:{artifactId}</featureArtifactDef>
   <featureArtifactDef>{groupId}:{artifactId}:{version}</featureArtifactDef>
<features>

If the version is not given, the plugin tries to extract the version from the project’s dependency list. The maven goal will search for the given artifact in the local .m2 repository. If it is not found there, the goal will search in the configured remote repositories. Not finding the artifact may cause the maven goal to terminate with a BUILD FAILURE.

Important: For the plugin to work properly, the artifact representing each feature is required to be specified as a maven dependency.

The set of bundles that need to be included in the repository are passed to the p2-repo-gen maven goal through this parameter. Bundle artifacts can be provided in two ways as shown below.

<bundleArtifacts>
       <bundleArtifactDef>{groupId}:{artifactId}</bundleArtifactDef>
       <bundleArtifactDef>{groupId}:{artifactId}:{version}</bundleArtifactDef>
 <bundleArtifacts>

If the version is not given, the maven goal will search for the given artifact in the local .m2 repository to resolve the version. If it is not found there, the goal will search in the the configured remote repositories. Not finding the artifact may cause the maven goal to terminate with a BUILD FAILURE. So for the plugin to work properly, the artifact representing each bundle needs to be specified as a maven dependency.

The URL of the location where the artifact repository to be created.

Important: For carbon, both artifacts and metadata reside in the same repository. Therefore the value for both metadataRepository and artifactRepository should be the same. 

Points to the executable file.

The URL of the location where the artifact repository to be created.

Important: For carbon, both artifacts and metadata reside in the same repository. Therefore, the value for both metadataRepository and artifactRepository should be the same. 

Points to the components folder of the Carbon product in which the profile is being created.

Name of the profile to be created.

Points to the <CARBON_HOME>/repository/components/ directory.

<destination>/home/Carbon/wso2carbon-4.4.0/repository/components</destination>

The profile which needs to be updated with the new set of features in the destination.

The URL of the location where the artifact repository to be created.

Important: For carbon, both artifacts and metadata resides in the same repository. Therefore, the value for both metadataRepository and artifactRepository should be the same. 

The features to be installed in the destination profile. Features that you add here should already exist in the P2 repository to which the <repositoryURL> parameter of the plugin points.