org.wso2.maven.p2.utils

Class P2ApplicationLaunchManager

java.lang.Object

org.wso2.maven.p2.utils.P2ApplicationLaunchManager

public class P2ApplicationLaunchManager
extends Object

Wrapper class containing P2ApplicationLauncher which makes configuring the P2ApplicationLauncher easier.

Since:

2.0.0

Constructor Summary

Constructors

Constructor and Description
P2ApplicationLaunchManager(org.eclipse.tycho.p2.facade.internal.P2ApplicationLauncher launcher) The constructor which initializes this class.

Method Summary

Modifier and Type	Method and Description
void	addArgumentsToInstallFeatures(String repositoryLocation, String installIUs, String destination, String profile) Sets the P2ApplicationLauncher's arguments to install features.
void	addArgumentsToUnInstallFeatures(String uninstallIUs, String destination, String profile) Sets the P2ApplicationLauncher's arguments to uninstall features.
void	addGenerateProfileArguments(URL repositoryURL, String id, String profile, URL targetPath) Sets the P2ApplicationLauncher's arguments and configure it to generate a profile.
void	addPublishProductArguments(URL repositoryURL, File productConfigurationFile, String executable) Sets the P2ApplicationLauncher's arguments and configure it to publish a give product.
void	addRepoGenerationArguments(String sourceDir, String metadataRepoLocation, String repositoryName) Sets the P2ApplicationLauncher's arguments to generate P2 repository.
void	addUpdateRepoWithCategoryArguments(String metadataRepositoryLocation, String categoryDefinitionFile) Sets the P2ApplicationLauncher's arguments and configure it to categorizing a set of Installable Units in a given repository.
void	performAction(int forkedProcessTimeoutInSeconds) Generate/update the repository.
void	setApplicationName(String applicationName) Sets the application name.
void	setWorkingDirectory(File workingDir) Sets the working directory of P2Applilcation launcher instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

P2ApplicationLaunchManager

public P2ApplicationLaunchManager(org.eclipse.tycho.p2.facade.internal.P2ApplicationLauncher launcher)

The constructor which initializes this class. This class wraps the P2ApplicationLauncher and expose a set of simple, easy to use methods to configure the P2ApplicationLauncher.

Parameters:

launcher - P2ApplicationLauncher which will be wrapped by this wrapper class

Method Detail

setWorkingDirectory

public void setWorkingDirectory(File workingDir)

Sets the working directory of P2Applilcation launcher instance

Parameters:

workingDir - File object pointing the directory

setApplicationName

public void setApplicationName(String applicationName)

Sets the application name.

Parameters:

applicationName - name of the application

addArgumentsToInstallFeatures

public void addArgumentsToInstallFeatures(String repositoryLocation,
                                          String installIUs,
                                          String destination,
                                          String profile)

Sets the P2ApplicationLauncher's arguments to install features.

Parameters:

repositoryLocation - a comma separated list of metadata repository(or artifact repository as in p2 both metadata and artifacts resides in the same repo) URLs where the software to be installed can be found.

installIUs - a comma separated list of IUs to install. Each entry in the list is in the form <id> [ '/' <version> ]. If you are looking to install a feature, the identifier of the feature has to be suffixed with ".feature.group".

destination - the path of a folder in which the targeted product is located.

profile - the profile id containing the description of the targeted product. This ID is defined by the eclipse.p2.profile property contained in the config.ini of the targeted product.

addArgumentsToUnInstallFeatures

public void addArgumentsToUnInstallFeatures(String uninstallIUs,
                                            String destination,
                                            String profile)

Sets the P2ApplicationLauncher's arguments to uninstall features.

Parameters:

uninstallIUs - a comma separated list of IUs to uninstall. Each entry in the list is in the form <id> [ '/' <version> ]. If you are looking to uninstall a feature, the identifier of the feature has to be suffixed with ".feature.group".

destination - the path of a folder in which the targeted product is located

profile - the profile id containing the description of the targeted product

addRepoGenerationArguments

public void addRepoGenerationArguments(String sourceDir,
                                       String metadataRepoLocation,
                                       String repositoryName)

Sets the P2ApplicationLauncher's arguments to generate P2 repository. For this scenario both metadata repository and artifact repository are same.

Parameters:

sourceDir - the location of the update site

metadataRepoLocation - the URI to the metadata repository where the installable units should be published

repositoryName - name of the artifact repository where the artifacts should be published

addUpdateRepoWithCategoryArguments

public void addUpdateRepoWithCategoryArguments(String metadataRepositoryLocation,
                                               String categoryDefinitionFile)

Sets the P2ApplicationLauncher's arguments and configure it to categorizing a set of Installable Units in a given repository.

Parameters:

metadataRepositoryLocation - a comma separated list of metadata repository URLs where the software to be installed can be found.

categoryDefinitionFile - The category file which drives the categorization of installable units in the repository

addPublishProductArguments

public void addPublishProductArguments(URL repositoryURL,
                                       File productConfigurationFile,
                                       String executable)
                                throws IOException

Sets the P2ApplicationLauncher's arguments and configure it to publish a give product.

Parameters:

repositoryURL - the URL to the metadata repository where the product should be published

productConfigurationFile - File object pointing the .product file

executable - location of the equinox executable jar

Throws:

IOException - throws when unable to get the canonical path from the product configuration file

addGenerateProfileArguments

public void addGenerateProfileArguments(URL repositoryURL,
                                        String id,
                                        String profile,
                                        URL targetPath)

Sets the P2ApplicationLauncher's arguments and configure it to generate a profile.

Parameters:

repositoryURL - the URL to the metadata repository where the product should be published

id - product id taken from .product file

profile - name of the new profile

targetPath - location of the components directory of the carbon distribution

performAction

public void performAction(int forkedProcessTimeoutInSeconds)
                   throws org.apache.maven.plugin.MojoFailureException

Generate/update the repository.

Parameters:

forkedProcessTimeoutInSeconds - int

Throws:

org.apache.maven.plugin.MojoFailureException - throws when unable to perform the p2 activity