Nested and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	AbstractLifeCycle.AbstractLifeCycleListener Deprecated this class is redundant now that `LifeCycle.Listener` has default methods.
pack-priv static enum	AbstractLifeCycle.State
public class	AbstractLifeCycle.StopException An exception, which if thrown by doStart will immediately stop the component

Field Summary

Modifier and Type	Field and Description
private final List<EventListener>	_eventListener
private final AutoLock	_lock
private volatile AbstractLifeCycle.State	_state
public static final String	FAILED
private static final Logger	LOG
public static final String	STARTED
public static final String	STARTING
public static final String	STOPPED
public static final String	STOPPING

Constructor Summary

Access	Constructor and Description
public	AbstractLifeCycle()

Method Summary

Modifier and Type	Method and Description
public boolean	addEventListener(EventListener listener) Implements org.eclipse.jetty.util.component.LifeCycle.addEventListener.
protected void	doStart() Method to override to start the lifecycle
protected void	doStop() Method to override to stop the lifecycle
public List<EventListener>	getEventListeners()
public String	getState()
public static String	getState(LifeCycle lc)
public boolean	isFailed() Implements org.eclipse.jetty.util.component.LifeCycle.isFailed.
public boolean	isRunning() Implements org.eclipse.jetty.util.component.LifeCycle.isRunning.
public boolean	isStarted() Implements org.eclipse.jetty.util.component.LifeCycle.isStarted.
public boolean	isStarting() Implements org.eclipse.jetty.util.component.LifeCycle.isStarting.
public boolean	isStopped() Implements org.eclipse.jetty.util.component.LifeCycle.isStopped.
public boolean	isStopping() Implements org.eclipse.jetty.util.component.LifeCycle.isStopping.
public boolean	removeEventListener(EventListener listener) Implements org.eclipse.jetty.util.component.LifeCycle.removeEventListener.
public void	setEventListeners(Collection<EventListener> eventListeners)
private void	setFailed(Throwable th)
private void	setStarted()
private void	setStarting()
private void	setStopped()
private void	setStopping()
public final void	start() Implements org.eclipse.jetty.util.component.LifeCycle.start. Starts the component.
public final void	stop() Implements org.eclipse.jetty.util.component.LifeCycle.stop. Stops the component.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_eventListener	back to summary
private final List<EventListener> _eventListener

_lock	back to summary
private final AutoLock _lock

_state	back to summary
private volatile AbstractLifeCycle.State _state

FAILED	back to summary
public static final String FAILED

LOG	back to summary
private static final Logger LOG

STARTED	back to summary
public static final String STARTED

STARTING	back to summary
public static final String STARTING

STOPPED	back to summary
public static final String STOPPED

STOPPING	back to summary
public static final String STOPPING

Constructor Detail

AbstractLifeCycle	back to summary
public AbstractLifeCycle()

Method Detail

addEventListener	back to summary
public boolean addEventListener(EventListener listener) Implements org.eclipse.jetty.util.component.LifeCycle.addEventListener. Annotations @Override

addEventListener

back to summary

public boolean addEventListener(EventListener listener)

Implements org.eclipse.jetty.util.component.LifeCycle.addEventListener.

Annotations

@Override

doStart	back to summary
protected void doStart() throws Exception Method to override to start the lifecycle Exceptions Exception: If there was a problem starting. Will cause a transition to FAILED state StopException: If thrown, the lifecycle will immediately be stopped.

doStart

back to summary

protected void doStart() throws Exception

Method to override to start the lifecycle

Exceptions

Exception:: If there was a problem starting. Will cause a transition to FAILED state
StopException:: If thrown, the lifecycle will immediately be stopped.

doStop	back to summary
protected void doStop() throws Exception Method to override to stop the lifecycle Exceptions Exception: If there was a problem stopping. Will cause a transition to FAILED state

doStop

back to summary

protected void doStop() throws Exception

Method to override to stop the lifecycle

Exceptions

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

getEventListeners	back to summary
public List<EventListener> getEventListeners()

getState	back to summary
public String getState() Annotations @ManagedAttribute:Lifecycle State for this instance readonly:true

getState	back to summary
public static String getState(LifeCycle lc)

isFailed	back to summary
public boolean isFailed() Implements org.eclipse.jetty.util.component.LifeCycle.isFailed. Returns:boolean Doc from org.eclipse.jetty.util.component.LifeCycle.isFailed. true if the component has failed to start or has failed to stop. Annotations @Override

isFailed

back to summary

public boolean isFailed()

Implements org.eclipse.jetty.util.component.LifeCycle.isFailed.

Returns:boolean

Doc from org.eclipse.jetty.util.component.LifeCycle.isFailed.

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

Annotations

@Override

isRunning	back to summary
public boolean isRunning() Implements org.eclipse.jetty.util.component.LifeCycle.isRunning. Returns:boolean Doc from org.eclipse.jetty.util.component.LifeCycle.isRunning. true if the component is starting or has been started. Annotations @Override

isRunning

back to summary

public boolean isRunning()

Implements org.eclipse.jetty.util.component.LifeCycle.isRunning.

Returns:boolean

Doc from org.eclipse.jetty.util.component.LifeCycle.isRunning.

true if the component is starting or has been started.

Annotations

@Override

isStarted	back to summary
public boolean isStarted() Implements org.eclipse.jetty.util.component.LifeCycle.isStarted. Returns:boolean Doc from org.eclipse.jetty.util.component.LifeCycle.isStarted. true if the component has been started. Annotations @Override

isStarted

back to summary

public boolean isStarted()

Implements org.eclipse.jetty.util.component.LifeCycle.isStarted.

Returns:boolean

Doc from org.eclipse.jetty.util.component.LifeCycle.isStarted.

true if the component has been started.

Annotations

@Override

isStarting	back to summary
public boolean isStarting() Implements org.eclipse.jetty.util.component.LifeCycle.isStarting. Returns:boolean Doc from org.eclipse.jetty.util.component.LifeCycle.isStarting. true if the component is starting. Annotations @Override

isStarting

back to summary

public boolean isStarting()

Implements org.eclipse.jetty.util.component.LifeCycle.isStarting.

Returns:boolean

Doc from org.eclipse.jetty.util.component.LifeCycle.isStarting.

true if the component is starting.

Annotations

@Override

isStopped	back to summary
public boolean isStopped() Implements org.eclipse.jetty.util.component.LifeCycle.isStopped. Returns:boolean Doc from org.eclipse.jetty.util.component.LifeCycle.isStopped. true if the component has been stopped. Annotations @Override

isStopped

back to summary

public boolean isStopped()

Implements org.eclipse.jetty.util.component.LifeCycle.isStopped.

Returns:boolean

Doc from org.eclipse.jetty.util.component.LifeCycle.isStopped.

true if the component has been stopped.

Annotations

@Override

isStopping	back to summary
public boolean isStopping() Implements org.eclipse.jetty.util.component.LifeCycle.isStopping. Returns:boolean Doc from org.eclipse.jetty.util.component.LifeCycle.isStopping. true if the component is stopping. Annotations @Override

isStopping

back to summary

public boolean isStopping()

Implements org.eclipse.jetty.util.component.LifeCycle.isStopping.

Returns:boolean

Doc from org.eclipse.jetty.util.component.LifeCycle.isStopping.

true if the component is stopping.

Annotations

@Override

removeEventListener	back to summary
public boolean removeEventListener(EventListener listener) Implements org.eclipse.jetty.util.component.LifeCycle.removeEventListener. Annotations @Override

removeEventListener

back to summary

public boolean removeEventListener(EventListener listener)

Implements org.eclipse.jetty.util.component.LifeCycle.removeEventListener.

Annotations

@Override

setEventListeners	back to summary
public void setEventListeners(Collection<EventListener> eventListeners)

setFailed	back to summary
private void setFailed(Throwable th)

setStarted	back to summary
private void setStarted()

setStarting	back to summary
private void setStarting()

setStopped	back to summary
private void setStopped()

setStopping	back to summary
private void setStopping()

start	back to summary
public final void start() throws Exception Implements org.eclipse.jetty.util.component.LifeCycle.start. Doc from org.eclipse.jetty.util.component.LifeCycle.start. Starts the component. Annotations @Override Exceptions Exception: If the component fails to start

start

back to summary

public final void start() throws Exception

Implements org.eclipse.jetty.util.component.LifeCycle.start.

Doc from org.eclipse.jetty.util.component.LifeCycle.start.

Starts the component.

Annotations

@Override

Exceptions

Exception:: If the component fails to start

stop	back to summary
public final void stop() throws Exception Implements org.eclipse.jetty.util.component.LifeCycle.stop. Doc from org.eclipse.jetty.util.component.LifeCycle.stop. Stops the component. The component may wait for current activities to complete normally, but it can be interrupted. Annotations @Override Exceptions Exception: If the component fails to stop

stop

back to summary

public final void stop() throws Exception

Implements org.eclipse.jetty.util.component.LifeCycle.stop.

Doc from org.eclipse.jetty.util.component.LifeCycle.stop.

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

Annotations

@Override

Exceptions

Exception:: If the component fails to stop

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.eclipse.jetty.util.component back to summary

public abstract Class AbstractLifeCycle.AbstractLifeCycleListener

Class Inheritance

extends Object
implements Listener

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

All Implemented Interfaces

org.eclipse.jetty.util.component.LifeCycle.Listener, java.util.EventListener

Annotations

@Deprecated

Deprecated

this class is redundant now that LifeCycle.Listener has default methods.

Constructor Summary

Access	Constructor and Description
public	AbstractLifeCycleListener()

Method Summary

Modifier and Type	Method and Description
public void	lifeCycleFailure(LifeCycle event, Throwable cause) Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleFailure.
public void	lifeCycleStarted(LifeCycle event) Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStarted.
public void	lifeCycleStarting(LifeCycle event) Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStarting.
public void	lifeCycleStopped(LifeCycle event) Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStopped.
public void	lifeCycleStopping(LifeCycle event) Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStopping.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

AbstractLifeCycleListener	back to summary
public AbstractLifeCycleListener()

Method Detail

lifeCycleFailure	back to summary
public void lifeCycleFailure(LifeCycle event, Throwable cause) Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleFailure. Annotations @Override

lifeCycleFailure

back to summary

public void lifeCycleFailure(LifeCycle event, Throwable cause)

Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleFailure.

Annotations

@Override

lifeCycleStarted	back to summary
public void lifeCycleStarted(LifeCycle event) Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStarted. Annotations @Override

lifeCycleStarted

back to summary

public void lifeCycleStarted(LifeCycle event)

Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStarted.

Annotations

@Override

lifeCycleStarting	back to summary
public void lifeCycleStarting(LifeCycle event) Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStarting. Annotations @Override

lifeCycleStarting

back to summary

public void lifeCycleStarting(LifeCycle event)

Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStarting.

Annotations

@Override

lifeCycleStopped	back to summary
public void lifeCycleStopped(LifeCycle event) Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStopped. Annotations @Override

lifeCycleStopped

back to summary

public void lifeCycleStopped(LifeCycle event)

Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStopped.

Annotations

@Override

lifeCycleStopping	back to summary
public void lifeCycleStopping(LifeCycle event) Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStopping. Annotations @Override

lifeCycleStopping

back to summary

public void lifeCycleStopping(LifeCycle event)

Overrides default org.eclipse.jetty.util.component.LifeCycle.Listener.lifeCycleStopping.

Annotations

@Override

Field Summary

Modifier and Type	Field and Description
public static final AbstractLifeCycle.State	FAILED
public static final AbstractLifeCycle.State	STARTED
public static final AbstractLifeCycle.State	STARTING
public static final AbstractLifeCycle.State	STOPPED
public static final AbstractLifeCycle.State	STOPPING

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static AbstractLifeCycle.State	valueOf(String name)
public static AbstractLifeCycle.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FAILED	back to summary
public static final AbstractLifeCycle.State FAILED

STARTED	back to summary
public static final AbstractLifeCycle.State STARTED

STARTING	back to summary
public static final AbstractLifeCycle.State STARTING

STOPPED	back to summary
public static final AbstractLifeCycle.State STOPPED

STOPPING	back to summary
public static final AbstractLifeCycle.State STOPPING

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static AbstractLifeCycle.State valueOf(String name)

values	back to summary
public static AbstractLifeCycle.State[] values()

org.eclipse.jetty.util.component back to summary

public Class AbstractLifeCycle.StopException

Class Inheritance

extends RuntimeException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

An exception, which if thrown by doStart will immediately stop the component

Constructor Summary

Access	Constructor and Description
public	StopException()

Constructor Detail

StopException	back to summary
public StopException()

public abstract Class AbstractLifeCycle

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class AbstractLifeCycle.AbstractLifeCycleListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv final Enum AbstractLifeCycle.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AbstractLifeCycle.StopException

Constructor Summary

Constructor Detail