Summary: Methods | [Expand All]
public interface

Lifecycle

org.springframework.context.Lifecycle
Known Indirect Subclasses

Class Overview

Interface defining methods for start/stop lifecycle control. The typical use case for this is to control asynchronous processing.

Can be implemented by both components (typically a Spring bean defined in a Spring BeanFactory) and containers (typically a Spring ApplicationContext). Containers will propagate start/stop signals to all components that apply.

Can be used for direct invocations or for management operations via JMX. In the latter case, the MBeanExporter will typically be defined with an InterfaceBasedMBeanInfoAssembler, restricting the visibility of activity-controlled components to the Lifecycle interface.

Note that the Lifecycle interface is only supported on top-level singleton beans. On any other component, the Lifecycle interface will remain undetected and hence ignored. Also, note that the extended SmartLifecycle interface provides more sophisticated integration with the container's startup and shutdown phases.

See Also

Summary

Public Methods
abstract boolean isRunning()
Check whether this component is currently running.
abstract void start()
Start this component.
abstract void stop()
Stop this component.

Public Methods

public abstract boolean isRunning ()

Check whether this component is currently running.

In the case of a container, this will return true only if all components that apply are currently running.

Returns
  • whether the component is currently running

public abstract void start ()

Start this component. Should not throw an exception if the component is already running.

In the case of a container, this will propagate the start signal to all components that apply.

public abstract void stop ()

Stop this component. Should not throw an exception if the component isn't started yet.

In the case of a container, this will propagate the stop signal to all components that apply.