Lifecycle (Catalina Internal API Documentation)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Field Summary | |
static java.lang.String |
START_EVENT
The LifecycleEvent type for the "component start" event. |
static java.lang.String |
STOP_EVENT
The LifecycleEvent type for the "component stop" event. |
Method Summary | |
void |
addLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component. |
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 Detail |
public static final java.lang.String START_EVENT
public static final java.lang.String STOP_EVENT
Method Detail |
public void addLifecycleListener(LifecycleListener listener)
listener
- The listener to addpublic void removeLifecycleListener(LifecycleListener listener)
listener
- The listener to removepublic void start() throws LifecycleException
java.lang.IllegalStateException
- if this component has already been
started
LifecycleException
- if this component detects a fatal error
that prevents this component from being usedpublic void stop() throws LifecycleException
java.lang.IllegalStateException
- if this component has not been started
LifecycleException
- if this component detects a fatal error
that needs to be reported
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |