Package org.apache.catalina
Interface Lifecycle
-
- All Known Subinterfaces:
Container,Context,Engine,Executor,Host,Server,Service,WebResourceRoot,WebResourceSet,Wrapper
- All Known Implementing Classes:
AbstractAccessLogValve,AbstractArchiveResourceSet,AbstractFileResourceSet,AbstractResourceSet,AbstractSingleArchiveResourceSet,AccessLogValve,AuthenticatedUserRealm,AuthenticatorBase,BackupManager,BasicAuthenticator,ClusterManagerBase,ClusterSingleSignOn,CombinedRealm,Connector,ContainerBase,CrawlerSessionManagerValve,DataSourceRealm,DataSourceStore,DeltaManager,DigestAuthenticator,DirResourceSet,EmptyResourceSet,ErrorReportValve,ExtendedAccessLogValve,ExtractingRoot,FailedContext,FileResourceSet,FileStore,FormAuthenticator,HealthCheckValve,JAASMemoryLoginModule,JAASRealm,JarResourceSet,JarWarResourceSet,JDBCAccessLogValve,JNDIRealm,JsonErrorReportValve,JvmRouteBinderValve,LifecycleBase,LifecycleMBeanBase,LoadBalancerDrainingValve,LockOutRealm,ManagerBase,MapperListener,MemoryRealm,NamingResourcesImpl,NonLoginAuthenticator,NullRealm,ParallelWebappClassLoader,PersistentManager,PersistentManagerBase,PersistentValve,ProxyErrorReportValve,RealmBase,RemoteAddrValve,RemoteCIDRValve,RemoteHostValve,RemoteIpValve,ReplicatedContext,ReplicationValve,RequestFilterValve,RewriteValve,SemaphoreValve,SessionIdGeneratorBase,SimpleTcpCluster,SingleSignOn,SpnegoAuthenticator,SSLAuthenticator,SSLValve,StandardContext,StandardEngine,StandardHost,StandardManager,StandardPipeline,StandardRoot,StandardServer,StandardService,StandardSessionIdGenerator,StandardThreadExecutor,StandardWrapper,StoreBase,StuckThreadDetectionValve,Tomcat.ExistingStandardWrapper,UserDatabaseRealm,ValveBase,WarResourceSet,WebappClassLoader,WebappClassLoaderBase,WebappLoader
public interface LifecycleCommon interface for component life cycle methods. Catalina components may 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.
The valid state transitions for components that supportLifecycleare:start() ----------------------------- | | | init() | NEW -»-- INITIALIZING | | | | | ------------------«----------------------- | | |auto | | | | | \|/ start() \|/ \|/ auto auto stop() | | | INITIALIZED --»-- STARTING_PREP --»- STARTING --»- STARTED --»--- | | | | | | | |destroy()| | | | --»-----«-- ------------------------«-------------------------------- ^ | | | | | | \|/ auto auto start() | | | STOPPING_PREP ----»---- STOPPING ------»----- STOPPED -----»----- | \|/ ^ | ^ | | stop() | | | | | -------------------------- | | | | | | | | | | destroy() destroy() | | | | FAILED ----»------ DESTROYING ---«----------------- | | | ^ | | | | destroy() | |auto | | --------»----------------- \|/ | | DESTROYED | | | | stop() | ----»-----------------------------»------------------------------ Any state can transition to FAILED. Calling start() while a component is in states STARTING_PREP, STARTING or STARTED has no effect. Calling start() while a component is in state NEW will cause init() to be called immediately after the start() method is entered. Calling stop() while a component is in states STOPPING_PREP, STOPPING or STOPPED has no effect. Calling stop() while a component is in state NEW transitions the component to STOPPED. This is typically encountered when a component fails to start and does not start all its sub-components. When the component is stopped, it will try to stop all sub-components - even those it didn't start. Attempting any other transition will throwTheLifecycleException.LifecycleEvents fired during state changes are defined in the methods that trigger the changed. NoLifecycleEvents are fired if the attempted transition is not valid.- Author:
- Craig R. McClanahan
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceLifecycle.SingleUseMarker interface used to indicate that the instance should only be used once.
-
Field Summary
Fields Modifier and Type Field Description static StringAFTER_DESTROY_EVENTThe LifecycleEvent type for the "component after destroy" event.static StringAFTER_INIT_EVENTThe LifecycleEvent type for the "component after init" event.static StringAFTER_START_EVENTThe LifecycleEvent type for the "component after start" event.static StringAFTER_STOP_EVENTThe LifecycleEvent type for the "component after stop" event.static StringBEFORE_DESTROY_EVENTThe LifecycleEvent type for the "component before destroy" event.static StringBEFORE_INIT_EVENTThe LifecycleEvent type for the "component before init" event.static StringBEFORE_START_EVENTThe LifecycleEvent type for the "component before start" event.static StringBEFORE_STOP_EVENTThe LifecycleEvent type for the "component before stop" event.static StringCONFIGURE_START_EVENTThe LifecycleEvent type for the "configure_start" event.static StringCONFIGURE_STOP_EVENTThe LifecycleEvent type for the "configure_stop" event.static StringPERIODIC_EVENTThe LifecycleEvent type for the "periodic" event.static StringSTART_EVENTThe LifecycleEvent type for the "component start" event.static StringSTOP_EVENTThe LifecycleEvent type for the "component stop" event.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddLifecycleListener(LifecycleListener listener)Add a LifecycleEvent listener to this component.voiddestroy()Prepare to discard the object.LifecycleListener[]findLifecycleListeners()Get the life cycle listeners associated with this life cycle.LifecycleStategetState()Obtain the current state of the source component.StringgetStateName()Obtain a textual representation of the current component state.voidinit()Prepare the component for starting.voidremoveLifecycleListener(LifecycleListener listener)Remove a LifecycleEvent listener from this component.voidstart()Prepare for the beginning of active use of the public methods other than property getters/setters and life cycle methods of this component.voidstop()Gracefully terminate the active use of the public methods other than property getters/setters and life cycle methods of this component.
-
-
-
Field Detail
-
BEFORE_INIT_EVENT
static final String BEFORE_INIT_EVENT
The LifecycleEvent type for the "component before init" event.- See Also:
- Constant Field Values
-
AFTER_INIT_EVENT
static final String AFTER_INIT_EVENT
The LifecycleEvent type for the "component after init" event.- See Also:
- Constant Field Values
-
START_EVENT
static final String START_EVENT
The LifecycleEvent type for the "component start" event.- See Also:
- Constant Field Values
-
BEFORE_START_EVENT
static final String BEFORE_START_EVENT
The LifecycleEvent type for the "component before start" event.- See Also:
- Constant Field Values
-
AFTER_START_EVENT
static final String AFTER_START_EVENT
The LifecycleEvent type for the "component after start" event.- See Also:
- Constant Field Values
-
STOP_EVENT
static final String STOP_EVENT
The LifecycleEvent type for the "component stop" event.- See Also:
- Constant Field Values
-
BEFORE_STOP_EVENT
static final String BEFORE_STOP_EVENT
The LifecycleEvent type for the "component before stop" event.- See Also:
- Constant Field Values
-
AFTER_STOP_EVENT
static final String AFTER_STOP_EVENT
The LifecycleEvent type for the "component after stop" event.- See Also:
- Constant Field Values
-
AFTER_DESTROY_EVENT
static final String AFTER_DESTROY_EVENT
The LifecycleEvent type for the "component after destroy" event.- See Also:
- Constant Field Values
-
BEFORE_DESTROY_EVENT
static final String BEFORE_DESTROY_EVENT
The LifecycleEvent type for the "component before destroy" event.- See Also:
- Constant Field Values
-
PERIODIC_EVENT
static final String PERIODIC_EVENT
The LifecycleEvent type for the "periodic" event.- See Also:
- Constant Field Values
-
CONFIGURE_START_EVENT
static final String CONFIGURE_START_EVENT
The LifecycleEvent type for the "configure_start" event. Used by those components that use a separate component to perform configuration and need to signal when configuration should be performed - usually afterBEFORE_START_EVENTand beforeSTART_EVENT.- See Also:
- Constant Field Values
-
CONFIGURE_STOP_EVENT
static final String CONFIGURE_STOP_EVENT
The LifecycleEvent type for the "configure_stop" event. Used by those components that use a separate component to perform configuration and need to signal when de-configuration should be performed - usually afterSTOP_EVENTand beforeAFTER_STOP_EVENT.- See Also:
- Constant Field Values
-
-
Method Detail
-
addLifecycleListener
void addLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component.- Parameters:
listener- The listener to add
-
findLifecycleListeners
LifecycleListener[] findLifecycleListeners()
Get the life cycle listeners associated with this life cycle.- 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
void removeLifecycleListener(LifecycleListener listener)
Remove a LifecycleEvent listener from this component.- Parameters:
listener- The listener to remove
-
init
void init() throws LifecycleException
Prepare the component for starting. This method should perform any initialization required post object creation. The followingLifecycleEvents will be fired in the following order:- INIT_EVENT: On the successful completion of component initialization.
- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
start
void start() throws LifecycleExceptionPrepare 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 followingLifecycleEvents 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.STARTINGand 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.
- 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
-
stop
void stop() throws LifecycleException
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 followingLifecycleEvents 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.STOPPINGand 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.FAILEDthen the three events above will be fired but the component will transition directly fromLifecycleState.FAILEDtoLifecycleState.STOPPING, bypassingLifecycleState.STOPPING_PREP- 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
-
destroy
void destroy() throws LifecycleExceptionPrepare to discard the object. The followingLifecycleEvents will be fired in the following order:- DESTROY_EVENT: On the successful completion of component destruction.
- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
getState
LifecycleState getState()
Obtain the current state of the source component.- Returns:
- The current state of the source component.
-
getStateName
String getStateName()
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, usegetState().- Returns:
- The name of the current component state.
-
-