Class ContainerLifeCycle
- java.lang.Object
-
- org.eclipse.jetty.util.component.AbstractLifeCycle
-
- org.eclipse.jetty.util.component.ContainerLifeCycle
-
- All Implemented Interfaces:
Container
,Destroyable
,Dumpable
,Dumpable.DumpableContainer
,LifeCycle
- Direct Known Subclasses:
AbstractConnectionFactory
,AbstractConnectionPool
,AbstractConnector
,AbstractHandler
,AbstractHttpClientTransport
,AbstractLoginService
,AbstractSessionCache
,AbstractSessionDataStore
,AdaptiveExecutionStrategy
,AttributeContainerMap
,CachingSessionDataStore
,ClientConnectionFactory.Info
,ClientConnectionFactoryOverHTTP2
,ClientConnectionFactoryOverHTTP3
,ClientConnector
,ConfigurableSpnegoLoginService
,CustomRequestLog
,DefaultSessionIdManager
,DelegatingThreadPool
,DeploymentManager
,ExecutorThreadPool
,HTTP2Client
,HTTP2Session
,HTTP3Client
,HttpClient
,HttpDestination
,JAASLoginService
,JakartaWebSocketContainer
,JakartaWebSocketShutdownContainer
,JettyWebSocketFrameHandlerFactory
,JettyWebSocketServerContainer
,KeyStoreScanner
,LeakTrackingByteBufferPool
,LowResourceMonitor
,ManagedSelector
,MavenServerConnector
,OpenIdConfiguration
,OpenIdLoginService
,ProtocolSession
,QueuedThreadPool
,QuicSession
,Scanner
,ScanningAppProvider
,SelectorManager
,ServletContextHandler.ServletContainerInitializerStarter
,ServletTester
,WebSocketClient
,WebSocketComponents
,WebSocketCoreClient
@ManagedObject("Implementation of Container and LifeCycle") public class ContainerLifeCycle extends AbstractLifeCycle implements Container, Destroyable, Dumpable.DumpableContainer
A ContainerLifeCycle is anLifeCycle
implementation for a collection of contained beans.Beans can be added to the ContainerLifeCycle either as managed beans or as unmanaged beans. A managed bean is started, stopped and destroyed with the aggregate. An unmanaged bean is associated with the aggregate for the purposes of
dump()
, but its lifecycle must be managed externally.When a
LifeCycle
bean is added without a managed state being specified the state is determined heuristically:- If the added bean is running, it will be added as an unmanaged bean.
- If the added bean is !running and the container is !running, it will be added as an AUTO bean (see below).
- If the added bean is !running and the container is starting, it will be added as a managed bean and will be started (this handles the frequent case of new beans added during calls to doStart).
- If the added bean is !running and the container is started, it will be added as an unmanaged bean.
When stopping the container, a contained bean will be stopped by this aggregate only if it is started by this aggregate.
The methods
addBean(Object, boolean)
,manage(Object)
andunmanage(Object)
can be used to explicitly control the life cycle relationship.If adding a bean that is shared between multiple
ContainerLifeCycle
instances, then it should be started before being added, so it is unmanaged, or the API must be used to explicitly set it as unmanaged.All
EventListener
s added viaaddEventListener(EventListener)
are also added as beans and all beans added via anaddBean(Object)
method that are alsoEventListener
s are added as listeners via a call toaddEventListener(EventListener)
.This class also provides utility methods to dump deep structures of objects. In the dump, the following symbols are used to indicate the type of contained object:
SomeContainerLifeCycleInstance +- contained POJO instance += contained MANAGED object, started and stopped with this instance +~ referenced UNMANAGED object, with separate lifecycle +? referenced AUTO object that could become MANAGED or UNMANAGED.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container
Container.InheritedListener, Container.Listener
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
Dumpable.DumpableContainer
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
LifeCycle.Listener
-
-
Constructor Summary
Constructors Constructor Description ContainerLifeCycle()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
addBean(java.lang.Object o)
Adds the given bean, detecting whether to manage it or not.boolean
addBean(java.lang.Object o, boolean managed)
Adds the given bean, explicitly managing it or not.boolean
addEventListener(java.util.EventListener listener)
Add an event listener.void
addManaged(LifeCycle lifecycle)
Adds a managed lifecycle.boolean
contains(java.lang.Object bean)
void
destroy()
Destroys the managed Destroyable beans in the reverse order they were added.protected void
doStart()
Starts the managed lifecycle beans in the order they were added.protected void
doStop()
Stops the managed lifecycle beans in the reverse order they were added.java.lang.String
dump()
void
dump(java.lang.Appendable out)
Dump this object to an Appendable with no indent.void
dump(java.lang.Appendable out, java.lang.String indent)
Dump this object (and children) into an Appendable using the provided indent after any new lines.protected void
dumpObjects(java.lang.Appendable out, java.lang.String indent, java.lang.Object... items)
Dump this object, it's contained beans and additional items to an Appendablevoid
dumpStdErr()
Dumps toSystem.err
.<T> T
getBean(java.lang.Class<T> clazz)
java.util.Collection<java.lang.Object>
getBeans()
<T> java.util.Collection<T>
getBeans(java.lang.Class<T> clazz)
<T> java.util.Collection<T>
getContainedBeans(java.lang.Class<T> clazz)
protected <T> void
getContainedBeans(java.lang.Class<T> clazz, java.util.Collection<T> beans)
boolean
isAuto(java.lang.Object bean)
boolean
isManaged(java.lang.Object bean)
Test if this container manages a beanboolean
isUnmanaged(java.lang.Object bean)
void
manage(java.lang.Object bean)
Manages a bean already contained by this aggregate, so that it is started/stopped/destroyed with this aggregate.boolean
removeBean(java.lang.Object o)
Removes the given bean.void
removeBeans()
Removes all beanboolean
removeEventListener(java.util.EventListener listener)
Remove an event listener.void
setBeans(java.util.Collection<java.lang.Object> beans)
protected void
start(LifeCycle l)
Starts the given lifecycle.protected void
stop(LifeCycle l)
Stops the given lifecycle.void
unmanage(java.lang.Object bean)
Unmanages a bean already contained by this aggregate, so that it is not started/stopped/destroyed with this aggregate.void
updateBean(java.lang.Object oldBean, java.lang.Object newBean)
void
updateBean(java.lang.Object oldBean, java.lang.Object newBean, boolean managed)
void
updateBeans(java.lang.Object[] oldBeans, java.lang.Object[] newBeans)
void
updateBeans(java.util.Collection<?> oldBeans, java.util.Collection<?> newBeans)
-
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.jetty.util.component.Container
getCachedBeans, getEventListeners
-
Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer
isDumpable
-
-
-
-
Method Detail
-
doStart
protected void doStart() throws java.lang.Exception
Starts the managed lifecycle beans in the order they were added.- Overrides:
doStart
in classAbstractLifeCycle
- Throws:
AbstractLifeCycle.StopException
- If thrown, the lifecycle will immediately be stopped.java.lang.Exception
- If there was a problem starting. Will cause a transition to FAILED state
-
start
protected void start(LifeCycle l) throws java.lang.Exception
Starts the given lifecycle.- Parameters:
l
- the lifecycle to start- Throws:
java.lang.Exception
- if unable to start lifecycle
-
stop
protected void stop(LifeCycle l) throws java.lang.Exception
Stops the given lifecycle.- Parameters:
l
- the lifecycle to stop- Throws:
java.lang.Exception
- if unable to stop the lifecycle
-
doStop
protected void doStop() throws java.lang.Exception
Stops the managed lifecycle beans in the reverse order they were added.- Overrides:
doStop
in classAbstractLifeCycle
- Throws:
java.lang.Exception
- If there was a problem stopping. Will cause a transition to FAILED state
-
destroy
public void destroy()
Destroys the managed Destroyable beans in the reverse order they were added.- Specified by:
destroy
in interfaceDestroyable
-
contains
public boolean contains(java.lang.Object bean)
- Parameters:
bean
- the bean to test- Returns:
- whether this aggregate contains the bean
-
isManaged
public boolean isManaged(java.lang.Object bean)
Description copied from interface:Container
Test if this container manages a bean
-
isAuto
public boolean isAuto(java.lang.Object bean)
- Parameters:
bean
- the bean to test- Returns:
- whether this aggregate contains the bean in auto state
-
isUnmanaged
public boolean isUnmanaged(java.lang.Object bean)
- Parameters:
bean
- the bean to test- Returns:
- whether this aggregate contains the bean in auto state
-
addBean
public boolean addBean(java.lang.Object o)
Adds the given bean, detecting whether to manage it or not. If the bean is aLifeCycle
, then it will be managed if it is not already started and not managed if it is already started. TheaddBean(Object, boolean)
method should be used if this is not correct, or themanage(Object)
andunmanage(Object)
methods may be used after an add to change the status.
-
addBean
public boolean addBean(java.lang.Object o, boolean managed)
Adds the given bean, explicitly managing it or not.
-
addManaged
public void addManaged(LifeCycle lifecycle)
Adds a managed lifecycle.This is a convenience method that uses addBean(lifecycle,true) and then ensures that the added bean is started iff this container is running. Exception from nested calls to start are caught and wrapped as RuntimeExceptions
- Parameters:
lifecycle
- the managed lifecycle to add
-
addEventListener
public boolean addEventListener(java.util.EventListener listener)
Description copied from interface:Container
Add an event listener. EventListeners added by this method are also added as beans.- Specified by:
addEventListener
in interfaceContainer
- Specified by:
addEventListener
in interfaceLifeCycle
- Overrides:
addEventListener
in classAbstractLifeCycle
- Parameters:
listener
- the listener to add- Returns:
- true if the listener was added
- See Also:
Container.Listener
,LifeCycle.Listener
,Container.addBean(Object)
-
removeEventListener
public boolean removeEventListener(java.util.EventListener listener)
Description copied from interface:Container
Remove an event listener.- Specified by:
removeEventListener
in interfaceContainer
- Specified by:
removeEventListener
in interfaceLifeCycle
- Overrides:
removeEventListener
in classAbstractLifeCycle
- Parameters:
listener
- the listener to remove- Returns:
- true if the listener was removed
- See Also:
Container.removeBean(Object)
-
manage
public void manage(java.lang.Object bean)
Manages a bean already contained by this aggregate, so that it is started/stopped/destroyed with this aggregate.
-
unmanage
public void unmanage(java.lang.Object bean)
Unmanages a bean already contained by this aggregate, so that it is not started/stopped/destroyed with this aggregate.
-
setBeans
public void setBeans(java.util.Collection<java.lang.Object> beans)
-
getBeans
public java.util.Collection<java.lang.Object> getBeans()
-
getBeans
public <T> java.util.Collection<T> getBeans(java.lang.Class<T> clazz)
- Specified by:
getBeans
in interfaceContainer
- Type Parameters:
T
- the Bean type- Parameters:
clazz
- the class of the beans- Returns:
- a list of beans of the given class (or subclass), in the order they were added.
- See Also:
Container.getBeans()
,Container.getContainedBeans(Class)
-
getBean
public <T> T getBean(java.lang.Class<T> clazz)
-
removeBeans
public void removeBeans()
Removes all bean
-
removeBean
public boolean removeBean(java.lang.Object o)
Description copied from interface:Container
Removes the given bean. If the bean is-aEventListener
, then also do an implicitContainer.removeEventListener(EventListener)
.- Specified by:
removeBean
in interfaceContainer
- Parameters:
o
- the bean to remove- Returns:
- whether the bean was removed
-
dumpStdErr
@ManagedOperation("Dump the object to stderr") public void dumpStdErr()
Dumps toSystem.err
.- See Also:
dump()
-
dump
@ManagedOperation("Dump the object to a string") public java.lang.String dump()
-
dump
public void dump(java.lang.Appendable out, java.lang.String indent) throws java.io.IOException
Description copied from interface:Dumpable
Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.
-
dump
public void dump(java.lang.Appendable out) throws java.io.IOException
Dump this object to an Appendable with no indent.- Parameters:
out
- The appendable to dump to.- Throws:
java.io.IOException
- May be thrown by the Appendable
-
dumpObjects
protected void dumpObjects(java.lang.Appendable out, java.lang.String indent, java.lang.Object... items) throws java.io.IOException
Dump this object, it's contained beans and additional items to an Appendable- Parameters:
out
- The appendable to dump toindent
- The indent to apply after any new linesitems
- Additional items to be dumped as contained.- Throws:
java.io.IOException
- May be thrown by the Appendable
-
updateBean
public void updateBean(java.lang.Object oldBean, java.lang.Object newBean)
-
updateBean
public void updateBean(java.lang.Object oldBean, java.lang.Object newBean, boolean managed)
-
updateBeans
public void updateBeans(java.lang.Object[] oldBeans, java.lang.Object[] newBeans)
-
updateBeans
public void updateBeans(java.util.Collection<?> oldBeans, java.util.Collection<?> newBeans)
-
getContainedBeans
public <T> java.util.Collection<T> getContainedBeans(java.lang.Class<T> clazz)
- Specified by:
getContainedBeans
in interfaceContainer
- Type Parameters:
T
- the Bean type- Parameters:
clazz
- the class of the beans- Returns:
- the list of beans of the given class from the entire Container hierarchy. The order is by depth first and then the order beans were added.
-
getContainedBeans
protected <T> void getContainedBeans(java.lang.Class<T> clazz, java.util.Collection<T> beans)
-
-