Package org.eclipse.jetty.util.component

Interface LifeCycle

All Known Subinterfaces:

Scheduler

All Known Implementing Classes:

AbstractLeakPreventer, AbstractLifeCycle, AppContextLeakPreventer, AWTLeakPreventer, ContainerLifeCycle, DOMLeakPreventer, DriverManagerLeakPreventer, EatWhatYouKill, ExecutorSizedThreadPool, ExecutorThreadPool, GCThreadLeakPreventer, Java2DLeakPreventer, LDAPLeakPreventer, LeakDetector, LoginConfigurationLeakPreventer, PathWatcher, QueuedThreadPool, ReservedThreadExecutor, Scanner, ScheduledExecutorScheduler, SecurityProviderLeakPreventer, SslContextFactory, SslSelectionDump, StopLifeCycle, Sweeper, TimerScheduler

@ManagedObject("Lifecycle Interface for startable components")
public interface LifeCycle

The lifecycle interface for generic components.
Classes implementing this interface have a defined life cycle defined by the methods of this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LifeCycle.Listener	Listener.

Method Summary

Modifier and Type	Method	Description
void	addLifeCycleListener(LifeCycle.Listener listener)
boolean	isFailed()
boolean	isRunning()
boolean	isStarted()
boolean	isStarting()
boolean	isStopped()
boolean	isStopping()
void	removeLifeCycleListener(LifeCycle.Listener listener)
void	start()	Starts the component.
static void	start(java.lang.Object object)	Utility to start an object if it is a LifeCycle and to convert any exception thrown to a RuntimeException
void	stop()	Stops the component.
static void	stop(java.lang.Object object)	Utility to stop an object if it is a LifeCycle and to convert any exception thrown to a RuntimeException

Method Detail

start

@ManagedOperation(value="Starts the instance",
                  impact="ACTION")
void start()
    throws java.lang.Exception

Starts the component.

Throws:

java.lang.Exception - If the component fails to start

See Also:

isStarted(), stop(), isFailed()

stop

@ManagedOperation(value="Stops the instance",
                  impact="ACTION")
void stop()
   throws java.lang.Exception

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

Throws:

java.lang.Exception - If the component fails to stop

See Also:

isStopped(), start(), isFailed()

isRunning

boolean isRunning()

Returns:

true if the component is starting or has been started.

isStarted

boolean isStarted()

Returns:

true if the component has been started.

See Also:

start(), isStarting()

isStarting

boolean isStarting()

Returns:

true if the component is starting.

See Also:

isStarted()

isStopping

boolean isStopping()

Returns:

true if the component is stopping.

See Also:

isStopped()

isStopped

boolean isStopped()

Returns:

true if the component has been stopped.

See Also:

stop(), isStopping()

isFailed

boolean isFailed()

Returns:

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

addLifeCycleListener

void addLifeCycleListener(LifeCycle.Listener listener)

removeLifeCycleListener

void removeLifeCycleListener(LifeCycle.Listener listener)

start

static void start(java.lang.Object object)

Utility to start an object if it is a LifeCycle and to convert any exception thrown to a RuntimeException

Parameters:

object - The instance to start.

Throws:

java.lang.RuntimeException - if the call to start throws an exception.

stop

static void stop(java.lang.Object object)

Utility to stop an object if it is a LifeCycle and to convert any exception thrown to a RuntimeException

Parameters:

object - The instance to stop.

Throws:

java.lang.RuntimeException - if the call to stop throws an exception.