001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064: package com.jcorporate.expresso.kernel;
065:
066: import com.jcorporate.expresso.kernel.exception.InstallationException;
067:
068: /**
069: * This interface represents a component that needs to perform install/uninstall
070: * work other than recieve straight configuration values. An example of this is a
071: * Schema. All Schemas are installable, for example, because tables need to be created,
072: * default security set up, etc. And these tables may need to be removed upon
073: * uninstallation
074: *
075: * @author Michael Rimov
076: * @since Expresso 5.1
077: */
078:
079: public interface Installable {
080:
081: /**
082: * Called when the Service Manager installs this component
083: *
084: * @param log A 'log4j-like' interface that allows you to output progress
085: * in the form of warnings, errors, info messages etc. The underlying implementation
086: * is often not log4j.
087: */
088: public void install(InstallationOptions installOptions,
089: InstallLog log) throws InstallationException;
090:
091: /**
092: * Called when the Service Manager uninstalls this component
093: *
094: * @param uninstallLog A 'log4j-like' interface that allows you to output progress
095: * in the form of warnings, errors, info messages etc. The underlying implementation
096: * is often not log4j.
097: */
098: public void uninstall(InstallationOptions installOptions,
099: InstallLog uninstallLog) throws InstallationException;
100:
101: /**
102: * This method is used to query the object for any Installation Options.
103: * The implementing component may return null if there are no special options
104: * for the job.
105: *
106: * @return Created and filled out installation objects or null;
107: */
108: public InstallationOptions getInstallationOptions();
109:
110: /**
111: * This method is used to query the Installable object for any uninstallation
112: * options. The implementing component may return null if there are no
113: * special options for the job. Although the 'type' returned is the same, as
114: * getInstallOptions(), obviously, their contents are not the same. :)
115: *
116: * @return Created and filled out InstallationOptions object or null;
117: */
118: public InstallationOptions getUninstallOptions();
119: }
|