FileDocCategorySizeDatePackage
Installer.javaAPI DocGlassfish v2 API5043Fri May 04 22:30:22 BST 2007com.sun.appserv.addons

Installer

public interface Installer

Name of an implementation of this interface will be put in the META-INF/services/com.sun.appserv.addons.Installer file of the addon installer jar file. SDK installer or asadmin install-addon command will instantiate this class and execute install method. SDK uninstaller or asadmin uninstall-addon command will instantiate this class and execute uninstall method.

see
com.sun.appserv.addons.Configurator

Fields Summary
Constructors Summary
Methods Summary
public voidinstall(InstallationContext ic)

Installs the Addon on top of the appserver. Typically it will unbundle the addon installable and setup any installation wide configuration or settings. The shared addon bits will be unbundled into the AS_HOME/addons/ directory.

The addon installer will also copy a configurator plugin to AS_HOME/lib/addons directory.

The addon installer will also copy any system applications to AS_HOME/lib/install/applications directory.

The Installer will be loaded with an instance of URLClassLoader and ant jars will be added to it's classpath.

If this method throws an AddonFatalException or RuntimeException Appserver installation will be aborted. However if it throws an AddonException, then the appserver installation will continue after displaying the error message.

param
ic InstallationContext object.

public voiduninstall(InstallationContext ic)

Perform uninstallation activity. It rollbacks any change Installer did during the installation. This include the removal of the system applications from the lib/install/applications directory also.

The Installer will be loaded with an instance of URLClassLoader and ant jars will be added to it's classpath.

If this method throws an AddonFatalException or RuntimeException Appserver uninstallation will be aborted. However if it throws an AddonException, then the appserver uninstallation will continue after displaying the error message.

param
ic InstallationContext object.

public voidupgrade(InstallationContext ic, AddonVersion version)
Upgrade the addon.

If this method throws AddonFatalException or RuntimeException, the appserver startup will not continue. If it throws AddonException, then the appserver startup will continue after displaying the error message.

param
ic InstallationContext object.
param
version AddonVersion object corresponding to the existing version.