File Doc Category Size Date Package
Lifecycle.java API Doc Glassfish v2 API 5269 Fri May 04 22:31:52 BST 2007 org.apache.catalina

Lifecycle

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.

author: Craig R. McClanahan
version: $Revision: 1.4 $ $Date: 2007/05/05 05:31:51 $

Fields Summary
public static final String
INIT_EVENT
The LifecycleEvent type for the "component init" event.
public static final String
START_EVENT
The LifecycleEvent type for the "component start" event.
public static final String
BEFORE_START_EVENT
The LifecycleEvent type for the "component before start" event.
public static final String
AFTER_START_EVENT
The LifecycleEvent type for the "component after start" event.
public static final String
STOP_EVENT
The LifecycleEvent type for the "component stop" event.
public static final String
BEFORE_STOP_EVENT
The LifecycleEvent type for the "component before stop" event.
public static final String
AFTER_STOP_EVENT
The LifecycleEvent type for the "component after stop" event.
Constructors Summary
Methods Summary
public void addLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component.
param
listener The listener to add
public LifecycleListener[] findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.
public void removeLifecycleListener(LifecycleListener listener)
Remove a LifecycleEvent listener from this component.
param
listener The listener to remove
public void start()
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.
exception
LifecycleException if this component detects a fatal error that prevents this component from being used
public void stop()
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.
exception
LifecycleException if this component detects a fatal error that needs to be reported