001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/Lifecycle.java,v 1.6 2002/06/09 02:10:50 remm Exp $
003: * $Revision: 1.6 $
004: * $Date: 2002/06/09 02:10:50 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina;
065:
066: /**
067: * Common interface for component life cycle methods. Catalina components
068: * may, but are not required to, implement this interface (as well as the
069: * appropriate interface(s) for the functionality they support) in order to
070: * provide a consistent mechanism to start and stop the component.
071: *
072: * @author Craig R. McClanahan
073: * @version $Revision: 1.6 $ $Date: 2002/06/09 02:10:50 $
074: */
075:
076: public interface Lifecycle {
077:
078: // ----------------------------------------------------- Manifest Constants
079:
080: /**
081: * The LifecycleEvent type for the "component start" event.
082: */
083: public static final String START_EVENT = "start";
084:
085: /**
086: * The LifecycleEvent type for the "component before start" event.
087: */
088: public static final String BEFORE_START_EVENT = "before_start";
089:
090: /**
091: * The LifecycleEvent type for the "component after start" event.
092: */
093: public static final String AFTER_START_EVENT = "after_start";
094:
095: /**
096: * The LifecycleEvent type for the "component stop" event.
097: */
098: public static final String STOP_EVENT = "stop";
099:
100: /**
101: * The LifecycleEvent type for the "component before stop" event.
102: */
103: public static final String BEFORE_STOP_EVENT = "before_stop";
104:
105: /**
106: * The LifecycleEvent type for the "component after stop" event.
107: */
108: public static final String AFTER_STOP_EVENT = "after_stop";
109:
110: // --------------------------------------------------------- Public Methods
111:
112: /**
113: * Add a LifecycleEvent listener to this component.
114: *
115: * @param listener The listener to add
116: */
117: public void addLifecycleListener(LifecycleListener listener);
118:
119: /**
120: * Get the lifecycle listeners associated with this lifecycle. If this
121: * Lifecycle has no listeners registered, a zero-length array is returned.
122: */
123: public LifecycleListener[] findLifecycleListeners();
124:
125: /**
126: * Remove a LifecycleEvent listener from this component.
127: *
128: * @param listener The listener to remove
129: */
130: public void removeLifecycleListener(LifecycleListener listener);
131:
132: /**
133: * Prepare for the beginning of active use of the public methods of this
134: * component. This method should be called before any of the public
135: * methods of this component are utilized. It should also send a
136: * LifecycleEvent of type START_EVENT to any registered listeners.
137: *
138: * @exception LifecycleException if this component detects a fatal error
139: * that prevents this component from being used
140: */
141: public void start() throws LifecycleException;
142:
143: /**
144: * Gracefully terminate the active use of the public methods of this
145: * component. This method should be the last one called on a given
146: * instance of this component. It should also send a LifecycleEvent
147: * of type STOP_EVENT to any registered listeners.
148: *
149: * @exception LifecycleException if this component detects a fatal error
150: * that needs to be reported
151: */
152: public void stop() throws LifecycleException;
153:
154: }
|