org.apache.uima.pear.tools

Class PackageCreator

java.lang.Object

org.apache.uima.pear.tools.PackageCreator

public class PackageCreator
extends Object

Utility class to generate a pear package.

Constructor Summary

Constructors

Constructor and Description
PackageCreator()

Method Summary

Modifier and Type	Method and Description
static String	createInstallDescriptor(String componentID, String mainComponentDesc, String classpath, String datapath, String mainComponentDir, Properties envVars) Creates the installation descriptor with the given information and save it in the metadata folder of the mainComponentDir.
static String	createPearPackage(String componentID, String mainComponentDir, String targetDir) create pear package based on the given information.
static void	generatePearPackage(String componentID, String mainComponentDesc, String classpath, String datapath, String mainComponentDir, String targetDir, Properties envVars) Default method to generate a pear package.

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageCreator

public PackageCreator()

Method Detail

generatePearPackage

public static void generatePearPackage(String componentID,
                                       String mainComponentDesc,
                                       String classpath,
                                       String datapath,
                                       String mainComponentDir,
                                       String targetDir,
                                       Properties envVars)
                                throws PackageCreatorException

Default method to generate a pear package. With the given information first the installation descriptor is created and then the pear package is built.

Parameters:

componentID - Specify a componentID for this component

mainComponentDesc - Specify the main component descriptor path that is used to start the component. The path must be specified relative to the mainComponentDir parameter.

classpath - Specify the classpath for this component. Use macros like $main_root to specify the classpath entries.

datapath - Specify the datapath for this component. Use macros like $main_root to specify the datapath entities.

mainComponentDir - Specify the main component root directory that contains all the resources for the component. The mainComponentDir is packaged to the pear file.

targetDir - Specify the target directory where the generated pear file is written to.

envVars - Specify additional environment variables for the pear component. May also use macros like $main_root to specify the key values if necessary.

Throws:

PackageCreatorException - if an error occurs while create the pear package

createInstallDescriptor

public static String createInstallDescriptor(String componentID,
                                             String mainComponentDesc,
                                             String classpath,
                                             String datapath,
                                             String mainComponentDir,
                                             Properties envVars)
                                      throws PackageCreatorException

Creates the installation descriptor with the given information and save it in the metadata folder of the mainComponentDir.

Parameters:

componentID - Specify a componentID for this component

mainComponentDesc - Specify the main component descriptor path that is used to start the component. The path must be specified relative to the mainComponentDir parameter.

classpath - Specify the classpath for this component. Use macros like $main_root to specify the classpath entries.

datapath - Specify the datapath for this component. Use macros like $main_root to specify the datapath entities.

mainComponentDir - Specify the main component root directory that contains all the resources for the component. The mainComponentDir is packaged to the pear file.

envVars - Specify additional environment variables for the pear component. May also use macros like $main_root to specify the key values if necessary.

Returns:

Path to the created installation descriptor.

Throws:

PackageCreatorException - if an error occurs while creating the installation descriptor

createPearPackage

public static String createPearPackage(String componentID,
                                       String mainComponentDir,
                                       String targetDir)
                                throws PackageCreatorException

create pear package based on the given information. This method can be called if a installation descriptor is already available or generated. The method will not generate the installation descriptor if it is not present.

Parameters:

componentID - Specify a componentID for this component

mainComponentDir - Specify the main component root directory that contains all the resources for the component. The mainComponentDir is packaged to the pear file.

targetDir - Specify the target directory where the generated pear file is written to.

Returns:

Retuns path absolute path to the created pear package.

Throws:

PackageCreatorException - if the pear package can not be created successfully.