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: * @(#)FileBindingBootstrap.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.file;
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 FileBindingBootstrap 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 FileBindingBootstrap.
058: */
059: public FileBindingBootstrap() {
060: mLog = Logger.getLogger(this .getClass().getPackage().getName());
061: }
062:
063: /**
064: * Get the JMX ObjectName for the optional installation configuration MBean
065: * for this BC. If there is none, the value is null.
066: *
067: * @return ObjectName the JMX object name of the installation configuration
068: * MBean or null if there is no MBean.
069: */
070: public javax.management.ObjectName getExtensionMBeanName() {
071: return null;
072: }
073:
074: /**
075: * Cleans up any resources allocated by the bootstrap implementation,
076: * including deregistration of the extension MBean, if applicable. This
077: * method will be called after the onInstall() or onUninstall() method is
078: * called, whether it succeeds or fails.
079: *
080: * @throws javax.jbi.JBIException when cleanup processing fails to complete
081: * successfully.
082: */
083: public void cleanUp() throws javax.jbi.JBIException {
084: }
085:
086: /**
087: * Called to initialize the BC bootstrap.
088: *
089: * @param installContext is the context containing information from the
090: * install command and from the BC jar file.
091: *
092: * @throws javax.jbi.JBIException when there is an error requiring that the
093: * installation be terminated.
094: */
095: public void init(InstallationContext installContext)
096: throws javax.jbi.JBIException {
097: mContext = installContext;
098:
099: return;
100: }
101:
102: /**
103: * Called at the beginning of installation of File Binding . For this file
104: * binding, all the required installation tasks have been taken care by
105: * the InstallationService.
106: *
107: * @throws javax.jbi.JBIException when there is an error requiring that the
108: * installation be terminated.
109: */
110: public void onInstall() throws javax.jbi.JBIException {
111: mLog.fine("File binding specific installation tasks started");
112:
113: mLog.fine("File binding specific installation tasks ended");
114: }
115:
116: /**
117: * Called at the beginning of uninstallation of FileBinding . For this file
118: * binding, all the required uninstallation tasks have been taken care of
119: * by the InstallationService
120: *
121: * @throws javax.jbi.JBIException when there is an error requiring that the
122: * uninstallation be terminated.
123: */
124: public void onUninstall() throws javax.jbi.JBIException {
125: mLog.fine("File binding specific uninstallation tasks started");
126:
127: mLog.fine("File binding specific uninstallation tasks ended");
128: }
129: }
|