Lifecycle (Payara Project 5.2021.4 API)

All Known Implementing Classes:

AccessLogValve, AdHocWebModule, AuthenticatorBase, AuthenticatorProxy, BasicAuthenticator, Catalina, Connector, ContainerBase, ContextFacade, CookiePersistentManager, DigestAuthenticator, Embedded, EmbeddedWebContainer, ErrorReportValve, ExtendedAccessLogValve, FileLogger, FileStore, FormAuthenticator, GlassFishSingleSignOn, HASessionStoreValve, HASingleSignOn, HAStoreBase, JAASRealm, JDBCAccessLogValve, JDBCStore, LoggerBase, NonLoginAuthenticator, PEAccessLogValve, PECoyoteConnector, PersistentManager, PersistentManagerBase, PersistentValve, PEVirtualServer, PwcWebModule, RealmAdapter, RealmBase, RemoteAddrValve, RemoteHostValve, ReplicationAttributeStore, ReplicationManagerBase, ReplicationStore, ReplicationWebEventPersistentManager, RequestDumperValve, RequestFilterValve, SingleSignOn, SSLAuthenticator, StandardContext, StandardEngine, StandardHost, StandardManager, StandardPipeline, StandardServer, StandardService, StandardWrapper, StoreBase, SystemErrLogger, SystemOutLogger, ValveBase, VirtualServer, VirtualServerPipeline, WebappLoader, WebConnector, WebdavFixValve, WebModule, WebPipeline
```
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: 1.1.2.1 $ $Date: 2007/08/17 15:46:26 $

Author:

Craig R. McClanahan

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AFTER_START_EVENT` The LifecycleEvent type for the "component after start" event.
`static String`	`AFTER_STOP_EVENT` The LifecycleEvent type for the "component after stop" event.
`static String`	`BEFORE_START_EVENT` The LifecycleEvent type for the "component before start" event.
`static String`	`BEFORE_STOP_EVENT` The LifecycleEvent type for the "component before stop" event.
`static String`	`INIT_EVENT` The LifecycleEvent type for the "component init" event.
`static String`	`START_EVENT` The LifecycleEvent type for the "component start" event.
`static String`	`STOP_EVENT` The LifecycleEvent type for the "component stop" event.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addLifecycleListener(LifecycleListener listener)` Add a LifecycleEvent listener to this component.
`List<LifecycleListener>`	`findLifecycleListeners()` Gets the (possibly empty) list of lifecycle listeners associated with this Lifecycle instance.
`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
  - INIT_EVENT
```
static final String INIT_EVENT
```
    The LifecycleEvent type for the "component 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
- Method Detail
  - addLifecycleListener
```
void addLifecycleListener(LifecycleListener listener)
```
    Add a LifecycleEvent listener to this component.
    
    Parameters:
    
    listener - The listener to add
  - findLifecycleListeners
```
List<LifecycleListener> findLifecycleListeners()
```
    Gets the (possibly empty) list of lifecycle listeners associated with this Lifecycle instance.
  - removeLifecycleListener
```
void removeLifecycleListener(LifecycleListener listener)
```
    Remove a LifecycleEvent listener from this component.
    
    Parameters:
    
    listener - The listener to remove
  - start
```
void start()
    throws LifecycleException
```
    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
```
void stop()
   throws LifecycleException
```
    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

Interface Lifecycle

Field Summary

Method Summary

Field Detail

INIT_EVENT

START_EVENT

BEFORE_START_EVENT

AFTER_START_EVENT

STOP_EVENT

BEFORE_STOP_EVENT

AFTER_STOP_EVENT

Method Detail

addLifecycleListener

findLifecycleListeners

removeLifecycleListener

start

stop