com.sun.jbi.management.engine

Class ModelEngineInstaller

java.lang.Object

com.sun.jbi.management.engine.ModelEngineInstaller

All Implemented Interfaces:

Bootstrap

public abstract class ModelEngineInstaller
extends Object
implements Bootstrap

The ModelEngineInstaller implements the management controls for a standard engine installer class, and can be extended to provide full installer functionality for a JBI Framework engine component.

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
ModelEngineInstaller()

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanUp() Cleans up any resources allocated by the bootstrap implementation, including performing deregistration of the extension MBean, if applicable.
ObjectName	getExtensionMBeanName() Obtains the ObjectName of the optional installer configuration MBean.
void	init(InstallationContext installContext) Initializes the installation environment for a component.
void	onInstall() Called at the beginning of installation of a component to perform any special installation tasks required by the component.
void	onUninstall() Called at the beginning of uninstallation of a component to perform any special uninstallation tasks required by the component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelEngineInstaller

public ModelEngineInstaller()

Method Detail

init

public void init(InstallationContext installContext)
          throws JBIException

Initializes the installation environment for a component. This method is expected to save any information from the installation context that may be needed by other methods.

If the component needs to register an optional installer configuration MBean, it MUST do so during execution of this method, or the getExtensionMBean() method.

This method must be called after the installation root (available through the installContext parameter) is prepared.

Specified by:

init in interface Bootstrap

Parameters:

installContext - the context containing information from the install command and from the component installation ZIP file; this must be non-null.

Throws:

JBIException - when there is an error requiring that the installation be terminated

cleanUp

public void cleanUp()
             throws JBIException

Cleans up any resources allocated by the bootstrap implementation, including performing deregistration of the extension MBean, if applicable.

This method must be called after the onInstall() or onUninstall() method is called, whether it succeeds or fails. It must be called after init() is called, if init() fails by throwing an exception.

Specified by:

cleanUp in interface Bootstrap

Throws:

JBIException - if the bootstrap cannot clean up allocated resources

getExtensionMBeanName

public ObjectName getExtensionMBeanName()

Obtains the ObjectName of the optional installer configuration MBean. If none is provided by this component, this method must return null.

This method must be called before onInstall() (or onUninstall()) is called by the JBI implementation.

Specified by:

getExtensionMBeanName in interface Bootstrap

Returns:

ObjectName of the optional installer configuration MBean; returns null if there is no such MBean

onInstall

public void onInstall()
               throws JBIException

Called at the beginning of installation of a component to perform any special installation tasks required by the component.

This method must not be called if the init() method failed with an exception.

Specified by:

onInstall in interface Bootstrap

Throws:

JBIException - when there is an error requiring that the installation be terminated

onUninstall

public void onUninstall()
                 throws JBIException

Called at the beginning of uninstallation of a component to perform any special uninstallation tasks required by the component.

This method must not be called if the init() method failed with an exception.

Specified by:

onUninstall in interface Bootstrap

Throws:

JBIException - when there is an error requiring that the uninstallation be terminated.