Package org.apache.uima.pear.tools
Class PackageInstaller
java.lang.Object
org.apache.uima.pear.tools.PackageInstaller
The
PackageInstaller class is the main user API for installing PEAR packages. The
class has a static method installPackage to install PEAR packages that returns a
PackageBrowser object containing all the needed information about the installed PEAR
package.- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PackageBrowserinstallPackage(File installDir, File pearPackage, boolean verify) Installs the specified PEAR package to the specified install location.static PackageBrowserinstallPackage(File installDir, File pearPackage, boolean verify, boolean cleanInstallDir) Installs the specified PEAR package to the specified install location.static PackageBrowserinstallPackage(File installDir, File pearPackage, boolean verify, boolean cleanInstallDir, boolean installToTopLevelDir) Installs the specified PEAR package to the specified install location.
-
Constructor Details
-
PackageInstaller
public PackageInstaller()
-
-
Method Details
-
installPackage
public static PackageBrowser installPackage(File installDir, File pearPackage, boolean verify) throws PackageInstallerException Installs the specified PEAR package to the specified install location. After the installation is completed, an optional installation verification step can be executed. This verification uses the main component descriptor to instantiate the UIMA resource, encapsulated in the PEAR package, and may run some additional tests, if applicable- Parameters:
installDir- PEAR package install locationpearPackage- PEAR package file location to installverify- If true the PEAR package verification is done after the installation- Returns:
- Returns a
PackageBrowserobject containing all PEAR package install settings - Throws:
PackageInstallerException- If an error occurred during the pear installation or verification.
-
installPackage
public static PackageBrowser installPackage(File installDir, File pearPackage, boolean verify, boolean cleanInstallDir) throws PackageInstallerException Installs the specified PEAR package to the specified install location. After the installation is completed, an optional installation verification step can be executed. This verification uses the main component descriptor to instantiate the UIMA resource, encapsulated in the PEAR package, and may run some additional tests, if applicable- Parameters:
installDir- PEAR package install locationpearPackage- PEAR package file location to installverify- If true the PEAR package verification is done after the installationcleanInstallDir- Iftrue, the target installation directory will be cleaned before the PEAR file is installed.- Returns:
- Returns a
PackageBrowserobject containing all PEAR package install settings - Throws:
PackageInstallerException- If an error occurred during the pear installation or verification.
-
installPackage
public static PackageBrowser installPackage(File installDir, File pearPackage, boolean verify, boolean cleanInstallDir, boolean installToTopLevelDir) throws PackageInstallerException Installs the specified PEAR package to the specified install location. After the installation is completed, an optional installation verification step can be executed. This verification uses the main component descriptor to instantiate the UIMA resource, encapsulated in the PEAR package, and may run some additional tests, if applicable.- Parameters:
installDir- PEAR package install locationpearPackage- PEAR package file location to installverify- If true the PEAR package verification is done after the installationcleanInstallDir- Iftrue, the target installation directory will be cleaned before the PEAR file is installed.installToTopLevelDir- Iftrue, the PEAR is installed directly into theinstallDir. No intermediate directory with the component name is created. Defaults tofalsein the overloads of this method.- Returns:
- Returns a
PackageBrowserobject containing all PEAR package install settings - Throws:
PackageInstallerException- If an error occurred during the pear installation or verification.
-