org.exoplatform.social.client.api.event

Interface Lifecycle<M,S>

All Known Implementing Classes:

ActivityServiceImplV1Alpha1, ActivityServiceImplV1Alpha2, ActivityServiceImplV1Alpha3, IdentityServiceImplV1Alpha1, ServiceBase

public interface Lifecycle<M,S>

Common interface for component life cycle methods. In order to provide a consistent to start and stop the component.

Author:

thanh_vucong

Field Summary

Fields

Modifier and Type	Field and Description
static String	AFTER_START_EVENT The LifecycleEvent type for the "component after start"
static String	AFTER_STOP_EVENT The LifecycleEvent type for the "component after start"
static String	BEFORE_START_EVENT The LifecycleEvent type for the "component before start"
static String	BEFORE_STOP_EVENT The LifecycleEvent type for the "component before stop"
static String	DESTROY_EVENT The LifecycleEvent type for the "component destroy"
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

Methods

Modifier and Type	Method and Description
void	addLifecycleListener(LifecycleListener<M,S> listener) Add a LifecycleEvent listener to this component.
LifecycleListener<M,S>[]	findLifecycleListeners() Get the lifecycle listeners associated with this lifecycle.
void	removeLifecycleListener(LifecycleListener<M,S> 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

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"

See Also:

Constant Field Values

AFTER_START_EVENT

static final String AFTER_START_EVENT

The LifecycleEvent type for the "component after start"

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"

See Also:

Constant Field Values

AFTER_STOP_EVENT

static final String AFTER_STOP_EVENT

The LifecycleEvent type for the "component after start"

See Also:

Constant Field Values

DESTROY_EVENT

static final String DESTROY_EVENT

The LifecycleEvent type for the "component destroy"

See Also:

Constant Field Values

Method Detail

findLifecycleListeners

LifecycleListener<M,S>[] findLifecycleListeners()

Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.

removeLifecycleListener

void removeLifecycleListener(LifecycleListener<M,S> listener)

Remove a LifecycleEvent listener from this component.

Parameters:

listener - The listener to remove

addLifecycleListener

void addLifecycleListener(LifecycleListener<M,S> listener)

Add a LifecycleEvent listener to this component.

Parameters:

listener - The listener to add

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