|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Bootstrap
This interface is implemented by a JBI Component to provide any special processing required at install/uninstall time. The methods defined here are called by the JBI implementation during the installation (or uninstallation) of the component that, among other things, supplies an implementation of this interface. Initialization/cleanup tasks such as creation/deletion of directories, files, and database tables can be done by the onInstall() and onUninstall() methods, respectively. This also allows the component to terminate the installation or uninstallation in the event of an error. After calling onInstall() or onUninstall(), regardless of outcome, the JBI implementation must call the cleanUp() method afterwards. Similarly, if init(InstallationContext) fails with an exception, the JBI implementation must call the cleanUp() method. Component implementors should note that there is no guarantee that the same instance of its Bootstrap implementation will be used during both install and uninstall operations on the component. Data that need to be retained between installation-time and uninstallation-time must be persisted in such as fashion that a separate instance of the bootstrap class can find them, despite component or system shutdown.
Method Summary | |
---|---|
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. |
Method Detail |
---|
void init(InstallationContext installContext) throws JBIException
installContext
- the context containing information from the install
command and from the component installation ZIP file;
this must be non-null.
JBIException
- when there is an error requiring that the installation
be terminatedvoid cleanUp() throws JBIException
JBIException
- if the bootstrap cannot clean up allocated resourcesObjectName getExtensionMBeanName()
void onInstall() throws JBIException
JBIException
- when there is an error requiring that the installation be
terminatedvoid onUninstall() throws JBIException
JBIException
- when there is an error requiring that the uninstallation be
terminated.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |