Interface Lifecycle
- All Known Subinterfaces:
ConfigurableApplicationContext
,ConfigurableWebApplicationContext
,LifecycleProcessor
,MessageListenerContainer
,SmartLifecycle
- All Known Implementing Classes:
AbstractApplicationContext
,AbstractBrokerMessageHandler
,AbstractHandshakeHandler
,AbstractJmsListeningContainer
,AbstractMessageListenerContainer
,AbstractPollingMessageListenerContainer
,AbstractRefreshableApplicationContext
,AbstractRefreshableConfigApplicationContext
,AbstractRefreshableWebApplicationContext
,AbstractXmlApplicationContext
,AnnotatedEndpointConnectionManager
,AnnotationConfigApplicationContext
,AnnotationConfigWebApplicationContext
,ClassPathXmlApplicationContext
,ConnectionManagerSupport
,DefaultHandshakeHandler
,DefaultLifecycleProcessor
,DefaultMessageListenerContainer
,DefaultSockJsService
,EndpointConnectionManager
,FileSystemXmlApplicationContext
,GenericApplicationContext
,GenericGroovyApplicationContext
,GenericMessageEndpointManager
,GenericWebApplicationContext
,GenericXmlApplicationContext
,GroovyWebApplicationContext
,HandshakeWebSocketService
,JettyRequestUpgradeStrategy
,JettyRequestUpgradeStrategy
,JettyWebSocketClient
,JettyWebSocketClient
,JettyXhrTransport
,JmsListenerEndpointRegistry
,JmsMessageEndpointManager
,ResourceAdapterApplicationContext
,SchedulerFactoryBean
,SimpAnnotationMethodMessageHandler
,SimpleBrokerMessageHandler
,SimpleMessageListenerContainer
,SockJsClient
,SockJsHttpRequestHandler
,StaticApplicationContext
,StaticWebApplicationContext
,StompBrokerRelayMessageHandler
,SubProtocolWebSocketHandler
,TimerManagerAccessor
,TimerManagerFactoryBean
,TimerManagerTaskScheduler
,TransportHandlingSockJsService
,UserDestinationMessageHandler
,WebSocketAnnotationMethodMessageHandler
,WebSocketConnectionManager
,WebSocketHandlerMapping
,WebSocketHttpRequestHandler
,WebSocketStompClient
,WebSocketTransport
,WebSocketTransportHandler
,XmlWebApplicationContext
public interface Lifecycle
A common interface defining methods for start/stop lifecycle control. The typical use case for this is to control asynchronous processing. NOTE: This interface does not imply specific auto-startup semantics. Consider implementingSmartLifecycle
for that purpose.Can be implemented by both components (typically a Spring bean defined in a Spring context) and containers (typically a Spring
ApplicationContext
itself). Containers will propagate start/stop signals to all components that apply within each container, e.g. for a stop/restart scenario at runtime.Can be used for direct invocations or for management operations via JMX. In the latter case, the
MBeanExporter
will typically be defined with anInterfaceBasedMBeanInfoAssembler
, restricting the visibility of activity-controlled components to the Lifecycle interface.Note that the present
Lifecycle
interface is only supported on top-level singleton beans. On any other component, theLifecycle
interface will remain undetected and hence ignored. Also, note that the extendedSmartLifecycle
interface provides sophisticated integration with the application context's startup and shutdown phases.- Since:
- 2.0
- Author:
- Juergen Hoeller
- See Also:
SmartLifecycle
,ConfigurableApplicationContext
,AbstractMessageListenerContainer
,SchedulerFactoryBean
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
isRunning()
Check whether this component is currently running.void
start()
Start this component.void
stop()
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.
Method Detail
start
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.
- See Also:
SmartLifecycle.isAutoStartup()
stop
void stop()
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementingSmartLifecycle
and itsstop(Runnable)
variant when asynchronous stop behavior is necessary.Note that this stop notification is not guaranteed to come before destruction: On regular shutdown,
Lifecycle
beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.Should not throw an exception if the component is not running (not started yet).
In the case of a container, this will propagate the stop signal to all components that apply.
isRunning
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