javax.jbi.component.Bootstrap Maven / Gradle / Ivy
/*
* BEGIN_HEADER - DO NOT EDIT
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* https://open-esb.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* https://open-esb.dev.java.net/public/CDDLv1.0.html.
* If applicable add the following below this CDDL HEADER,
* with the fields enclosed by brackets "[]" replaced with
* your own identifying information: Portions Copyright
* [year] [name of copyright owner]
*/
/*
* @(#)Bootstrap.java
* Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
*
* END_HEADER - DO NOT EDIT
*/
package javax.jbi.component;
import javax.jbi.JBIException;
import javax.management.ObjectName;
/**
* 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 {@link #onInstall()} and {@link
* #onUninstall()} methods, respectively. This also allows the component to
* terminate the installation or uninstallation in the event of an error.
*
* After calling {@link #onInstall()} or {@link #onUninstall()}, regardless of
* outcome, the JBI implementation must call the {@link #cleanUp()} method
* afterwards. Similarly, if {@link #init(InstallationContext)} fails with
* an exception, the JBI implementation must call the {@link #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 schemaorg_apache_xmlbeans.system shutdown.
*
* @author JSR208 Expert Group
*/
public interface Bootstrap
{
/**
* 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.
*
* @param installContext the context containing information from the
* install command and from the component installation
* ZIP file; this must be non-null.
* @exception JBIException when there is an error requiring that
* the installation be terminated
*/
void init(InstallationContext installContext)
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.
*
* @exception JBIException if the bootstrap cannot clean up allocated
* resources
*/
void cleanUp() throws JBIException;
/**
* 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.
*
* @return ObjectName of the optional installer configuration MBean;
* returns null if there is no such MBean
*/
ObjectName getExtensionMBeanName();
/**
* 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 that
* the installation be terminated
*/
void onInstall()
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.
*
* @exception JBIException when there is an error requiring that
* the uninstallation be terminated.
*/
void onUninstall()
throws JBIException;
}