Core :: Utilities 12.0.6 · org.eclipse.jetty.util.component.ContainerLifeCycle

A ContainerLifeCycle is an LifeCycle 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 the container is started, then all contained managed beans will also be started. Any contained AUTO beans will be check for their status and if already started will be switched unmanaged beans, else they will be started and switched to managed beans. Beans added after a container is started are not started and their state needs to be explicitly managed.

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) and unmanage(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 EventListeners added via addEventListener(EventListener) are also added as beans and all beans added via an addBean(Object) method that are also EventListeners are added as listeners via a call to addEventListener(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 and Inner Type Summary

Modifier and Type	Class and Description
private static class	ContainerLifeCycle.Bean
pack-priv static enum	ContainerLifeCycle.Managed

Field Summary

Modifier and Type	Field and Description
private final List<ContainerLifeCycle.Bean>	_beans
private boolean	_destroyed
private boolean	_doStarted
private final List<Container.Listener>	_listeners
private static final Logger	LOG Hides org.eclipse.jetty.util.component.AbstractLifeCycle.LOG.

Inherited from org.eclipse.jetty.util.component.AbstractLifeCycle:: FAILED STARTED STARTING STOPPED STOPPING

Constructor Summary

Access	Constructor and Description
public	ContainerLifeCycle()

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the bean was added, false if it was already present addBean(Object the bean object to add o) Implements org.eclipse.jetty.util.component.Container.addBean. Adds the given bean, detecting whether to manage it or not.
public boolean	Returns: true if the bean was added, false if it was already present addBean(Object The bean object to add o, boolean whether to managed the lifecycle of the bean managed) Implements org.eclipse.jetty.util.component.Container.addBean. Adds the given bean, explicitly managing it or not.
private boolean	addBean(Object o, ContainerLifeCycle.Managed managed)
public boolean	addEventListener(EventListener the listener to add listener) Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.addEventListener. Implements org.eclipse.jetty.util.component.Container.addEventListener, org.eclipse.jetty.util.component.LifeCycle.addEventListener. Add an event listener.
public void	addManaged(LifeCycle the managed lifecycle to add lifecycle) Adds a managed lifecycle.
public boolean	Returns: whether this aggregate contains the bean contains(Object the bean to test bean)
public void	destroy() Implements org.eclipse.jetty.util.component.Destroyable.destroy. Destroys the managed Destroyable beans in the reverse order they were added.
protected void	doStart() Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added.
protected void	doStop() Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added.
public String	dump() Overrides default org.eclipse.jetty.util.component.Dumpable.dump.
public void	dump(Appendable The appendable to dump to out, String The indent to apply after any new lines. indent) Implements org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines.
public void	dump(Appendable The appendable to dump to. out) Dump this object to an Appendable with no indent.
protected void	dumpObjects(Appendable The appendable to dump to out, String The indent to apply after any new lines indent, Object... Additional items to be dumped as contained. items) Dump this object, it's contained beans and additional items to an Appendable
public void	dumpStdErr() Dumps to `System#err`.
public <T> T	getBean(Class<T> the class of the bean clazz) Implements org.eclipse.jetty.util.component.Container.getBean.
private ContainerLifeCycle.Bean	getBean(Object o)
public Collection<Object>	getBeans() Implements org.eclipse.jetty.util.component.Container.getBeans.
public <T> Collection<T>	getBeans(Class<T> the class of the beans clazz) Implements org.eclipse.jetty.util.component.Container.getBeans.
public <T> Collection<T>	getContainedBeans(Class<T> the class of the beans clazz) Implements org.eclipse.jetty.util.component.Container.getContainedBeans.
protected <T> void	getContainedBeans(Class<T> clazz, Collection<T> beans)
public boolean	Returns: whether this aggregate contains the bean in auto state isAuto(Object the bean to test bean)
public boolean	Returns: whether this aggregate contains and manages the bean isManaged(Object the bean to test bean) Implements org.eclipse.jetty.util.component.Container.isManaged. Test if this container manages a bean
public boolean	Returns: whether this aggregate contains the bean in auto state isUnmanaged(Object the bean to test bean)
public void	manage(Object The bean to manage (must already have been added). bean) Implements org.eclipse.jetty.util.component.Container.manage. Manages a bean already contained by this aggregate, so that it is started/stopped/destroyed with this aggregate.
private void	manage(ContainerLifeCycle.Bean bean)
private boolean	remove(ContainerLifeCycle.Bean bean)
public boolean	removeBean(Object the bean to remove o) Implements org.eclipse.jetty.util.component.Container.removeBean. Removes the given bean.
public void	removeBeans() Removes all bean
public boolean	removeEventListener(EventListener the listener to remove listener) Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.removeEventListener. Implements org.eclipse.jetty.util.component.Container.removeEventListener, org.eclipse.jetty.util.component.LifeCycle.removeEventListener. Remove an event listener.
public void	setBeans(Collection<Object> beans)
protected void	start(LifeCycle the lifecycle to start l) Starts the given lifecycle.
protected void	stop(LifeCycle the lifecycle to stop l) Stops the given lifecycle.
public void	unmanage(Object The bean to unmanage (must already have been added). bean) Implements org.eclipse.jetty.util.component.Container.unmanage. Unmanages a bean already contained by this aggregate, so that it is not started/stopped/destroyed with this aggregate.
private void	unmanage(ContainerLifeCycle.Bean bean)
public void	updateBean(Object oldBean, final Object newBean)
public void	updateBean(Object oldBean, final Object newBean, boolean managed)
public void	updateBeans(Object[] oldBeans, final Object[] newBeans)
public void	updateBeans(final Collection<?> oldBeans, final Collection<?> newBeans)

Inherited from org.eclipse.jetty.util.component.AbstractLifeCycle:: getEventListeners getState getState isFailed isRunning isStarted isStarting isStopped isStopping setEventListeners start stop toString

Field Detail

_beans	back to summary
private final List<ContainerLifeCycle.Bean> _beans

_destroyed	back to summary
private boolean _destroyed

_doStarted	back to summary
private boolean _doStarted

_listeners	back to summary
private final List<Container.Listener> _listeners

LOG	back to summary
private static final Logger LOG Hides org.eclipse.jetty.util.component.AbstractLifeCycle.LOG.

Constructor Detail

ContainerLifeCycle	back to summary
public ContainerLifeCycle()

Method Detail

addBean back to summary

addBean	back to summary
public boolean addBean(Object o) Implements org.eclipse.jetty.util.component.Container.addBean. Adds the given bean, detecting whether to manage it or not. If the bean is a `LifeCycle`, then it will be managed if it is not already started and not managed if it is already started. The `addBean(Object, boolean)` method should be used if this is not correct, or the `manage(Object)` and `unmanage(Object)` methods may be used after an add to change the status. Parameters o:Object the bean object to add Returns:boolean true if the bean was added, false if it was already present Annotations @Override

public boolean addBean(Object o)

Implements org.eclipse.jetty.util.component.Container.addBean.

Adds the given bean, detecting whether to manage it or not. If the bean is a LifeCycle, then it will be managed if it is not already started and not managed if it is already started. The addBean(Object, boolean) method should be used if this is not correct, or the manage(Object) and unmanage(Object) methods may be used after an add to change the status.

Parameters

o:Object: the bean object to add

Returns:boolean

true if the bean was added, false if it was already present

Annotations

@Override

addBean	back to summary
public boolean addBean(Object o, boolean managed) Implements org.eclipse.jetty.util.component.Container.addBean. Adds the given bean, explicitly managing it or not. Parameters o:Object The bean object to add managed:boolean whether to managed the lifecycle of the bean Returns:boolean true if the bean was added, false if it was already present Annotations @Override

addBean

Modifier and Type	Field and Description
private final Object	_bean
private volatile ContainerLifeCycle.Managed	_managed

Modifier and Type	Method and Description
public boolean	isManageable()
public boolean	isManaged()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Modifier and Type	Field and Description
public static final ContainerLifeCycle.Managed	AUTO
public static final ContainerLifeCycle.Managed	MANAGED
public static final ContainerLifeCycle.Managed	POJO
public static final ContainerLifeCycle.Managed	UNMANAGED

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

public Class ContainerLifeCycle

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ContainerLifeCycle.Bean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum ContainerLifeCycle.Managed

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail