org.apache.catalina

Interface 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.

Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Craig R. McClanahan

Field Summary
static StringAFTER_START_EVENT
The LifecycleEvent type for the "component after start" event.
static StringAFTER_STOP_EVENT
The LifecycleEvent type for the "component after stop" event.
static StringBEFORE_START_EVENT
The LifecycleEvent type for the "component before start" event.
static StringBEFORE_STOP_EVENT
The LifecycleEvent type for the "component before stop" event.
static StringDESTROY_EVENT
The LifecycleEvent type for the "component destroy" event.
static StringINIT_EVENT
The LifecycleEvent type for the "component init" event.
static StringPERIODIC_EVENT
The LifecycleEvent type for the "periodic" event.
static StringSTART_EVENT
The LifecycleEvent type for the "component start" event.
static StringSTOP_EVENT
The LifecycleEvent type for the "component stop" event.
Method Summary
voidaddLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component.
LifecycleListener[]findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle.
voidremoveLifecycleListener(LifecycleListener listener)
Remove a LifecycleEvent listener from this component.
voidstart()
Prepare for the beginning of active use of the public methods of this component.
voidstop()
Gracefully terminate the active use of the public methods of this component.

Field Detail

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.

DESTROY_EVENT

public static final String DESTROY_EVENT
The LifecycleEvent type for the "component destroy" event.

INIT_EVENT

public static final String INIT_EVENT
The LifecycleEvent type for the "component init" event.

PERIODIC_EVENT

public static final String PERIODIC_EVENT
The LifecycleEvent type for the "periodic" 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 Detail

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()
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()
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 © 2000-2011 Apache Software Foundation. All Rights Reserved.