Module org.eclipse.jetty.util

Package org.eclipse.jetty.util.component

Class AbstractLifeCycle

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

All Implemented Interfaces:

LifeCycle

Direct Known Subclasses:

AbstractLeakPreventer, ContainerLifeCycle, ScheduledExecutorScheduler, StopLifeCycle, Sweeper, TimerScheduler

@ManagedObject("Abstract Implementation of LifeCycle")
public abstract class AbstractLifeCycle
extends Object
implements LifeCycle

Basic implementation of the life cycle interface for components.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractLifeCycle.AbstractLifeCycleListener	Deprecated, for removal: This API element is subject to removal in a future version. this class is redundant now that LifeCycle.Listener has default methods.
static class	AbstractLifeCycle.StopException	An exception, which when thrown by doStart() will immediately stop the component

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FAILED
static final String	STARTED
static final String	STARTING
static final String	STOPPED
static final String	STOPPING

Constructor Summary

Constructors

Constructor	Description
AbstractLifeCycle()

Method Summary

Modifier and Type	Method	Description
boolean	addEventListener(EventListener listener)
protected void	doStart()	Method to override to start the lifecycle
protected void	doStop()	Method to override to stop the lifecycle
List<EventListener>	getEventListeners()
String	getState()
static String	getState(LifeCycle lc)
boolean	isFailed()
boolean	isRunning()
boolean	isStarted()
boolean	isStarting()
boolean	isStopped()
boolean	isStopping()
boolean	removeEventListener(EventListener listener)
void	setEventListeners(Collection<EventListener> eventListeners)
final void	start()	Starts the component.
final void	stop()	Stops the component.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

STOPPED

public static final String STOPPED

FAILED

public static final String FAILED

STARTING

public static final String STARTING

STARTED

public static final String STARTED

STOPPING

public static final String STOPPING

Constructor Details

AbstractLifeCycle

public AbstractLifeCycle()

Method Details

doStart

protected void doStart()
                throws Exception

Method to override to start the lifecycle

Throws:

AbstractLifeCycle.StopException - If thrown, the lifecycle will immediately be stopped.

Exception - If there was a problem starting. Will cause a transition to FAILED state

doStop

protected void doStop()
               throws Exception

Method to override to stop the lifecycle

Throws:

Exception - If there was a problem stopping. Will cause a transition to FAILED state

start

public final void start()
                 throws Exception

Description copied from interface: LifeCycle

Starts the component.

Specified by:

start in interface LifeCycle

Throws:

Exception - If the component fails to start

See Also:

• LifeCycle.isStarted()
• LifeCycle.stop()
• LifeCycle.isFailed()

stop

public final void stop()
                throws Exception

Description copied from interface: LifeCycle

Stops the component. The component may wait for current activities to complete normally, but it can be interrupted.

Specified by:

stop in interface LifeCycle

Throws:

Exception - If the component fails to stop

See Also:

• LifeCycle.isStopped()
• LifeCycle.start()
• LifeCycle.isFailed()

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LifeCycle

Returns:

true if the component is starting or has been started.

isStarted

public boolean isStarted()

Specified by:

isStarted in interface LifeCycle

Returns:

true if the component has been started.

See Also:

• LifeCycle.start()
• LifeCycle.isStarting()

isStarting

public boolean isStarting()

Specified by:

isStarting in interface LifeCycle

Returns:

true if the component is starting.

See Also:

• LifeCycle.isStarted()

isStopping

public boolean isStopping()

Specified by:

isStopping in interface LifeCycle

Returns:

true if the component is stopping.

See Also:

• LifeCycle.isStopped()

isStopped

public boolean isStopped()

Specified by:

isStopped in interface LifeCycle

Returns:

true if the component has been stopped.

See Also:

• LifeCycle.stop()
• LifeCycle.isStopping()

isFailed

public boolean isFailed()

Specified by:

isFailed in interface LifeCycle

Returns:

true if the component has failed to start or has failed to stop.

getEventListeners

public List<EventListener> getEventListeners()

setEventListeners

public void setEventListeners(Collection<EventListener> eventListeners)

addEventListener

public boolean addEventListener(EventListener listener)

Specified by:

addEventListener in interface LifeCycle

removeEventListener

public boolean removeEventListener(EventListener listener)

Specified by:

removeEventListener in interface LifeCycle

getState

@ManagedAttribute(value="Lifecycle State for this instance",
                  readonly=true)
public String getState()

getState

public static String getState(LifeCycle lc)

toString

public String toString()

Overrides:

toString in class Object