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.ContainerVetoException;
067:
068: import java.util.EventListener;
069:
070: /**
071: * This class is to provide for event notifications whenever a parent
072: * container changes. Event Handers should work hard to be 'quick' about their
073: * processing so that they don't hold up the hold system while events are
074: * getting handled
075: * <p><b>Also Please Note:</b> Implementers of the Container Listener should
076: * ideally have their event handlers marked <b>synchronized</b>.</p>
077: *
078: * @author Michael Rimov
079: */
080: public interface ContainerListener extends EventListener {
081:
082: /**
083: * Called whenever a new component is added to the container. The listener
084: * has the opportunity to strenusously object to the component being added
085: * by throwing a ContainerVetoException. This should only occur whenever
086: * installing the new component would seriously harm the operation of the
087: * current controller... ie extreme cases only.
088: *
089: * @param newComponent the new component instance getting installed.
090: * @throws ContainerVetoException if the component should NOT be installed
091: * for some reason or another.
092: */
093: public void onAdd(ExpressoComponent newComponent)
094: throws ContainerVetoException;
095:
096: /**
097: * Called whenever a component is removed from the container. If the removal
098: * if the specified component causes SERIOUS problem with the operation of the
099: * current component, the component can throw a ContainerVetoException, however
100: * this should only occur in very rare cases.
101: *
102: * @param removingComponent The component being removed
103: */
104: public void onRemove(ExpressoComponent removingComponent)
105: throws ContainerVetoException;
106:
107: /**
108: * Called whenever a component is installed into a component container.
109: * Since add() is called first, we don't have the option to throw
110: * ContainerVetoException since in onAdd is the chance to do so
111: *
112: * @param installingComponent the component that is getting installed
113: * @param log The InstallLog that allows us to do any final 'output notes'
114: */
115: public void onInstall(ExpressoComponent installingComponent,
116: InstallLog log);
117:
118: /**
119: * Called whenever a component is uninstalled from the ComponentContainer
120: *
121: * @param uninstallComponent the component that is getting uninstalled
122: * @param log The InstallLog that allows us to do any final 'output notes'
123: */
124: public void onUninstall(ExpressoComponent uninstallComponent,
125: InstallLog log);
126:
127: }
|