| javax.jbi.component.Bootstrap
All known Subclasses: deploytest.BadInstallBindingComponent, testengine2.FooEngineBootstrap, testengine.FooEngineBootstrap, feederengine.CSVFeederEngineBootstrap, com.sun.jbi.ui.cli.test.binding1.boot.Binding1Installer, deploytest.BindingComponent, testengine1.FooEngineBootstrap, com.sun.jbi.ui.cli.test.statistics.SimpleTestEngine, classloaderregresstests.sharedlibtest.engine.boot.SharedNamespaceTestEngineInstaller, com.sun.jbi.ui.ant.test.engine2.boot.Engine2Installer, java4ant.BindingComponent, com.sun.jbi.binding.proxy.ProxyBindingBootstrap, classloaderregresstests.sharedlibtest.binding.boot.SharedNamespaceTestBindingInstaller, com.sun.jbi.ui.cli.test.engine2.boot.Engine2Installer, com.sun.jbi.ui.ant.test.engine4.boot.Engine4Installer, extension.ExtensionComponent, com.sun.jbi.ui.ant.test.binding2.boot.Binding2Installer, com.sun.jbi.engine.xslt.TransformationEngineBootstrap, com.sun.jbi.management.binding.ModelBindingInstaller, testengine.PBTestEngineBootstrap, com.sun.jbi.binding.file.FileBindingBootstrap, classloaderregresstests.privatelibtest.engine.boot.PrivateNamespaceTestEngineInstaller, deploytest.StartOneDeploymentComponent, deploytest.FileLockingComponent, TestBinding.PBTestBindingBootstrap, com.sun.jbi.ui.cli.test.engine1.boot.Engine1Installer, com.sun.jbi.ui.ant.test.engine1.boot.Engine1Installer, deploytest.DeployBinding, testcomponent1.BindingComponent1, restart.BaseComponent, com.sun.jbi.ui.cli.test.engine4.boot.Engine4Installer, deploytest.ConsolidatedSchemaComponent, TestBinding.BindingBootstrap, com.sun.jbi.ui.ant.test.statistics.SimpleTestEngine, com.sun.jbi.internal.security.test.binding1.boot.BootstrapImpl, deploytest.BadUninstallBindingComponent, com.sun.jbi.ui.ant.test.engine3.boot.Engine3Installer, com.sun.jbi.ui.cli.test.binding2.boot.Binding2Installer, deploytest.UpgradableComponent, deploytest.ExtensionBindingComponent, com.sun.jbi.engine.sequencing.SequencingEngineBootstrap, testcomponent.BindingComponent, deploytest.DeployOnceBindingComponent, classloaderregresstests.classloaderchaintest.engine.boot.ClassloaderChainTestEngineInstaller, com.sun.jbi.framework.BindingBootstrap, com.sun.jbi.binding.jms.JMSBindingBootstrap, com.sun.jbi.ui.ant.test.binding1.boot.Binding1Installer, classloaderregresstests.selffirstloading.engine.boot.EngineInstaller, com.sun.jbi.ui.cli.test.engine3.boot.Engine3Installer, com.sun.jbi.framework.EngineBootstrap, com.sun.jbi.management.engine.ModelEngineInstaller, test.SimpleTestEngine, test.BindingComponent,
| Bootstrap | | public interface Bootstrap (Code) | | 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
Bootstrap.onInstall() and
Bootstrap.onUninstall() methods, respectively. This also allows the component to
terminate the installation or uninstallation in the event of an error.
After calling
Bootstrap.onInstall() or
Bootstrap.onUninstall() , regardless of
outcome, the JBI implementation must call the
Bootstrap.cleanUp() method
afterwards. Similarly, if
Bootstrap.init(InstallationContext) fails with
an exception, the JBI implementation must call the
Bootstrap.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.
author:
JSR208 Expert Group |
| Method Summary | |
| void | cleanUp()
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. | | 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. |
| cleanUp | | void cleanUp() throws JBIException(Code) | | 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.
exception:
JBIException - if the bootstrap cannot clean up allocatedresources |
| getExtensionMBeanName | | ObjectName getExtensionMBeanName()(Code) | | 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.
ObjectName of the optional installer configuration MBean; returns null if there is no such MBean |
| init | | void init(InstallationContext installContext) throws JBIException(Code) | | 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.
Parameters:
installContext - the context containing information from theinstall command and from the component installationZIP file; this must be non-null.
exception:
JBIException - when there is an error requiring thatthe installation be terminated |
| onInstall | | void onInstall() throws JBIException(Code) | | 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.
exception:
JBIException - when there is an error requiring thatthe installation be terminated |
| onUninstall | | void onUninstall() throws JBIException(Code) | | 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.
exception:
JBIException - when there is an error requiring thatthe uninstallation be terminated. |
|
|