org.apache.catalina

Interface Lifecycle

Known Implementing Classes:
AccessLogValve, Ajp13Connector, AuthenticatorBase, BasicAuthenticator, Catalina, ContainerBase, CoyoteConnector, CoyoteConnector, DataSourceRealm, DigestAuthenticator, Embedded, ExtendedAccessLogValve, FileLogger, FileStore, FormAuthenticator, JAASMemoryLoginModule, JAASRealm, JDBCAccessLogValve, JDBCRealm, JDBCStore, JNDIRealm, LoggerBase, MemoryRealm, NonLoginAuthenticator, PersistentManager, PersistentManagerBase, RealmBase, SingleSignOn, SSLAuthenticator, StandardContext, StandardEngine, StandardHost, StandardManager, StandardPipeline, StandardServer, StandardService, StandardWrapper, StoreBase, SystemErrLogger, SystemOutLogger, UserDatabaseRealm, WebappClassLoader, WebappLoader

public interface Lifecycle

Common interface for component life cycle methods. Catalina components may, but are not required to, implement this interface (as well as the appropriate interface(s) for the functionality they support) in order to provide a consistent mechanism to start and stop the component.

Version:
$Revision: 1.2 $ $Date: 2004/02/27 14:58:38 $

Author:
Craig R. McClanahan

Field Summary

static String
AFTER_START_EVENT
The LifecycleEvent type for the "component after start" event.
static String
AFTER_STOP_EVENT
The LifecycleEvent type for the "component after stop" event.
static String
BEFORE_START_EVENT
The LifecycleEvent type for the "component before start" event.
static String
BEFORE_STOP_EVENT
The LifecycleEvent type for the "component before stop" event.
static String
START_EVENT
The LifecycleEvent type for the "component start" event.
static String
STOP_EVENT
The LifecycleEvent type for the "component stop" event.

Method Summary

void
addLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component.
LifecycleListener[]
findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle.
void
removeLifecycleListener(LifecycleListener listener)
Remove a LifecycleEvent listener from this component.
void
start()
Prepare for the beginning of active use of the public methods of this component.
void
stop()
Gracefully terminate the active use of the public methods of this component.

Field Details

AFTER_START_EVENT

public static final String AFTER_START_EVENT
The LifecycleEvent type for the "component after start" event.


AFTER_STOP_EVENT

public static final String AFTER_STOP_EVENT
The LifecycleEvent type for the "component after stop" event.


BEFORE_START_EVENT

public static final String BEFORE_START_EVENT
The LifecycleEvent type for the "component before start" event.


BEFORE_STOP_EVENT

public static final String BEFORE_STOP_EVENT
The LifecycleEvent type for the "component before stop" event.


START_EVENT

public static final String START_EVENT
The LifecycleEvent type for the "component start" event.


STOP_EVENT

public static final String STOP_EVENT
The LifecycleEvent type for the "component stop" event.

Method Details

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component.

Parameters:
listener - The listener to add


findLifecycleListeners

public LifecycleListener[] findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.


removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)
Remove a LifecycleEvent listener from this component.

Parameters:
listener - The listener to remove


start

public void start()
            throws LifecycleException
Prepare for the beginning of active use of the public methods of this component. This method should be called before any of the public methods of this component are utilized. It should also send a LifecycleEvent of type START_EVENT to any registered listeners.

Throws:
LifecycleException - if this component detects a fatal error that prevents this component from being used


stop

public void stop()
            throws LifecycleException
Gracefully terminate the active use of the public methods of this component. This method should be the last one called on a given instance of this component. It should also send a LifecycleEvent of type STOP_EVENT to any registered listeners.

Throws:
LifecycleException - if this component detects a fatal error that needs to be reported


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.