Package org.apache.catalina.util
Class LifecycleBase
java.lang.Object
org.apache.catalina.util.LifecycleBase
- All Implemented Interfaces:
Lifecycle
- Direct Known Subclasses:
AbstractResourceSet
,EmptyResourceSet
,LifecycleMBeanBase
,SessionIdGeneratorBase
,StandardPipeline
,StoreBase
Base implementation of the
Lifecycle
interface that implements the state transition rules for
Lifecycle.start()
and Lifecycle.stop()
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse
-
Field Summary
Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addLifecycleListener
(LifecycleListener listener) Add a LifecycleEvent listener to this component.final void
destroy()
Prepare to discard the object.protected abstract void
Sub-classes implement this method to perform any instance destruction required.Get the life cycle listeners associated with this life cycle.protected void
fireLifecycleEvent
(String type, Object data) Allow sub classes to fireLifecycle
events.getState()
Obtain the current state of the source component.Obtain a textual representation of the current component state.boolean
Will aLifecycleException
thrown by a sub-class duringinitInternal()
,startInternal()
,stopInternal()
ordestroyInternal()
be re-thrown for the caller to handle or will it be logged instead?final void
init()
Prepare the component for starting.protected abstract void
Sub-classes implement this method to perform any instance initialisation required.void
removeLifecycleListener
(LifecycleListener listener) Remove a LifecycleEvent listener from this component.protected void
setState
(LifecycleState state) Provides a mechanism for sub-classes to update the component state.protected void
setState
(LifecycleState state, Object data) Provides a mechanism for sub-classes to update the component state.void
setThrowOnFailure
(boolean throwOnFailure) Configure if aLifecycleException
thrown by a sub-class duringinitInternal()
,startInternal()
,stopInternal()
ordestroyInternal()
will be re-thrown for the caller to handle or if it will be logged instead.final void
start()
Prepare for the beginning of active use of the public methods other than property getters/setters and life cycle methods of this component.protected abstract void
Sub-classes must ensure that the state is changed toLifecycleState.STARTING
during the execution of this method.final void
stop()
Gracefully terminate the active use of the public methods other than property getters/setters and life cycle methods of this component.protected abstract void
Sub-classes must ensure that the state is changed toLifecycleState.STOPPING
during the execution of this method.
-
Constructor Details
-
LifecycleBase
public LifecycleBase()
-
-
Method Details
-
getThrowOnFailure
public boolean getThrowOnFailure()Will aLifecycleException
thrown by a sub-class duringinitInternal()
,startInternal()
,stopInternal()
ordestroyInternal()
be re-thrown for the caller to handle or will it be logged instead?- Returns:
true
if the exception will be re-thrown, otherwisefalse
-
setThrowOnFailure
public void setThrowOnFailure(boolean throwOnFailure) Configure if aLifecycleException
thrown by a sub-class duringinitInternal()
,startInternal()
,stopInternal()
ordestroyInternal()
will be re-thrown for the caller to handle or if it will be logged instead.- Parameters:
throwOnFailure
-true
if the exception should be re-thrown, otherwisefalse
-
addLifecycleListener
Description copied from interface:Lifecycle
Add a LifecycleEvent listener to this component.- Specified by:
addLifecycleListener
in interfaceLifecycle
- Parameters:
listener
- The listener to add
-
findLifecycleListeners
Description copied from interface:Lifecycle
Get the life cycle listeners associated with this life cycle.- Specified by:
findLifecycleListeners
in interfaceLifecycle
- Returns:
- An array containing the life cycle listeners associated with this life cycle. If this component has no listeners registered, a zero-length array is returned.
-
removeLifecycleListener
Description copied from interface:Lifecycle
Remove a LifecycleEvent listener from this component.- Specified by:
removeLifecycleListener
in interfaceLifecycle
- Parameters:
listener
- The listener to remove
-
fireLifecycleEvent
-
init
Description copied from interface:Lifecycle
Prepare the component for starting. This method should perform any initialization required post object creation. The followingLifecycleEvent
s will be fired in the following order:- INIT_EVENT: On the successful completion of component initialization.
- Specified by:
init
in interfaceLifecycle
- Throws:
LifecycleException
- if this component detects a fatal error that prevents this component from being used
-
initInternal
Sub-classes implement this method to perform any instance initialisation required.- Throws:
LifecycleException
- If the initialisation fails
-
start
Description copied from interface:Lifecycle
Prepare for the beginning of active use of the public methods other than property getters/setters and life cycle methods of this component. This method should be called before any of the public methods other than property getters/setters and life cycle methods of this component are utilized. The followingLifecycleEvent
s will be fired in the following order:- BEFORE_START_EVENT: At the beginning of the method. It is as this point the state transitions to
LifecycleState.STARTING_PREP
. - START_EVENT: During the method once it is safe to call start() for any child components. It is at this point
that the state transitions to
LifecycleState.STARTING
and that the public methods other than property getters/setters and life cycle methods may be used. - AFTER_START_EVENT: At the end of the method, immediately before it returns. It is at this point that the
state transitions to
LifecycleState.STARTED
.
- Specified by:
start
in interfaceLifecycle
- Throws:
LifecycleException
- if this component detects a fatal error that prevents this component from being used
- BEFORE_START_EVENT: At the beginning of the method. It is as this point the state transitions to
-
startInternal
Sub-classes must ensure that the state is changed toLifecycleState.STARTING
during the execution of this method. Changing state will trigger theLifecycle.START_EVENT
event. If a component fails to start it may either throw aLifecycleException
which will cause it's parent to fail to start or it can place itself in the error state in which casestop()
will be called on the failed component but the parent component will continue to start normally.- Throws:
LifecycleException
- Start error occurred
-
stop
Description copied from interface:Lifecycle
Gracefully terminate the active use of the public methods other than property getters/setters and life cycle methods of this component. Once the STOP_EVENT is fired, the public methods other than property getters/setters and life cycle methods should not be used. The followingLifecycleEvent
s will be fired in the following order:- BEFORE_STOP_EVENT: At the beginning of the method. It is at this point that the state transitions to
LifecycleState.STOPPING_PREP
. - STOP_EVENT: During the method once it is safe to call stop() for any child components. It is at this point
that the state transitions to
LifecycleState.STOPPING
and that the public methods other than property getters/setters and life cycle methods may no longer be used. - AFTER_STOP_EVENT: At the end of the method, immediately before it returns. It is at this point that the state
transitions to
LifecycleState.STOPPED
.
LifecycleState.FAILED
then the three events above will be fired but the component will transition directly fromLifecycleState.FAILED
toLifecycleState.STOPPING
, bypassingLifecycleState.STOPPING_PREP
- Specified by:
stop
in interfaceLifecycle
- Throws:
LifecycleException
- if this component detects a fatal error that needs to be reported
- BEFORE_STOP_EVENT: At the beginning of the method. It is at this point that the state transitions to
-
stopInternal
Sub-classes must ensure that the state is changed toLifecycleState.STOPPING
during the execution of this method. Changing state will trigger theLifecycle.STOP_EVENT
event.- Throws:
LifecycleException
- Stop error occurred
-
destroy
Description copied from interface:Lifecycle
Prepare to discard the object. The followingLifecycleEvent
s will be fired in the following order:- DESTROY_EVENT: On the successful completion of component destruction.
- Specified by:
destroy
in interfaceLifecycle
- Throws:
LifecycleException
- if this component detects a fatal error that prevents this component from being used
-
destroyInternal
Sub-classes implement this method to perform any instance destruction required.- Throws:
LifecycleException
- If the destruction fails
-
getState
Description copied from interface:Lifecycle
Obtain the current state of the source component. -
getStateName
Description copied from interface:Lifecycle
Obtain a textual representation of the current component state. Useful for JMX. The format of this string may vary between point releases and should not be relied upon to determine component state. To determine component state, useLifecycle.getState()
.- Specified by:
getStateName
in interfaceLifecycle
- Returns:
- The name of the current component state.
-
setState
Provides a mechanism for sub-classes to update the component state. Calling this method will automatically fire any associatedLifecycle
event. It will also check that any attempted state transition is valid for a sub-class.- Parameters:
state
- The new state for this component- Throws:
LifecycleException
- when attempting to set an invalid state
-
setState
Provides a mechanism for sub-classes to update the component state. Calling this method will automatically fire any associatedLifecycle
event. It will also check that any attempted state transition is valid for a sub-class.- Parameters:
state
- The new state for this componentdata
- The data to pass to the associatedLifecycle
event- Throws:
LifecycleException
- when attempting to set an invalid state
-