001: /*
002: * BEGIN_HEADER - DO NOT EDIT
003: *
004: * The contents of this file are subject to the terms
005: * of the Common Development and Distribution License
006: * (the "License"). You may not use this file except
007: * in compliance with the License.
008: *
009: * You can obtain a copy of the license at
010: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
011: * See the License for the specific language governing
012: * permissions and limitations under the License.
013: *
014: * When distributing Covered Code, include this CDDL
015: * HEADER in each file and include the License file at
016: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
017: * If applicable add the following below this CDDL HEADER,
018: * with the fields enclosed by brackets "[]" replaced with
019: * your own identifying information: Portions Copyright
020: * [year] [name of copyright owner]
021: */
022:
023: /*
024: * @(#)ProxyBindingBootstrap.java
025: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
026: *
027: * END_HEADER - DO NOT EDIT
028: */
029: package com.sun.jbi.binding.proxy;
030:
031: import java.util.logging.Logger;
032:
033: import javax.jbi.component.Bootstrap;
034: import javax.jbi.component.InstallationContext;
035:
036: /**
037: * Implemented by a BC Component (BC) to provide any special processing
038: * required at install/uninstall time. Things such as creation/deletion of
039: * directories, files, database tables could be done by the onInstall() and
040: * onUninstall() methods, respectively. Also allows the BC to terminate the
041: * installation or uninstallation in the event of an error.
042: *
043: * @author Sun Microsystems, Inc
044: */
045: public class ProxyBindingBootstrap implements Bootstrap {
046: /**
047: * This is the installation context given by the framework.
048: */
049: private InstallationContext mContext;
050:
051: /**
052: * Internal handle to the logger instance
053: */
054: private Logger mLog;
055:
056: /**
057: * Creates a new instance of ProxyBindingBootstrap.
058: */
059: public ProxyBindingBootstrap() {
060: mLog = Logger.getLogger(this .getClass().getPackage().getName());
061: }
062:
063: //
064: // ---------- Methods defined in javax.jbi.component.Bootstrap ---------
065: //
066:
067: /**
068: * Get the JMX ObjectName for the optional installation configuration MBean
069: * for this BC. If there is none, the value is null.
070: * @return ObjectName the JMX object name of the installation configuration
071: * MBean or null if there is no MBean.
072: */
073: public javax.management.ObjectName getExtensionMBeanName() {
074: return null;
075: }
076:
077: /**
078: * Called to initialize the BC bootstrap.
079: * @param installContext is the context containing information from the
080: * install command and from the BC jar file.
081: * @throws javax.jbi.JBIException when there is an error requiring that the
082: * installation be terminated.
083: */
084: public void init(InstallationContext installContext)
085: throws javax.jbi.JBIException {
086: mContext = installContext;
087: }
088:
089: /**
090: * Cleans up any resources allocated by the bootstrap implementation,
091: * including performing deregistration of the extension MBean, if
092: * applicable.
093: * <p>
094: * This method must be called after the onInstall() or onUninstall() method
095: * is called, whether it succeeds or fails. It must be called after
096: * init() is called, if init() fails by throwing an exception.
097: *
098: * @exception JBIException if the bootstrap cannot clean up allocated
099: * resources
100: */
101: public void cleanUp() throws javax.jbi.JBIException {
102:
103: }
104:
105: /**
106: * Called at the beginning of installation of Proxy Binding . For the Proxy
107: * Binding there is nothing to do.
108: * @throws javax.jbi.JBIException when there is an error requiring that the
109: * installation be terminated.
110: */
111: public void onInstall() throws javax.jbi.JBIException {
112: }
113:
114: /**
115: * Called at the beginning of uninstallation of ProxyBinding . For the Proxy
116: * Binding there is nothing to do.
117: * @throws javax.jbi.JBIException when there is an error requiring that the
118: * uninstallation be terminated.
119: */
120: public void onUninstall() throws javax.jbi.JBIException {
121: }
122:
123: }
|