Class DefaultLifecycleProcessor
java.lang.Object
org.springframework.context.support.DefaultLifecycleProcessor
- All Implemented Interfaces:
Aware
,BeanFactoryAware
,Lifecycle
,LifecycleProcessor
public class DefaultLifecycleProcessor
extends Object
implements LifecycleProcessor, BeanFactoryAware
Default implementation of the
LifecycleProcessor
strategy.- Since:
- 3.0
- Author:
- Mark Fisher, Juergen Hoeller
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionRetrieve all applicable Lifecycle beans: all singletons that have already been created, as well as all SmartLifecycle beans (even if they are marked as lazy-init).protected int
Determine the lifecycle phase of the given bean.boolean
Check whether this component is currently running.void
onClose()
Notification of context close phase, e.g.void
Notification of context refresh, e.g.void
setBeanFactory
(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.void
setTimeoutPerShutdownPhase
(long timeoutPerShutdownPhase) Specify the maximum time allotted in milliseconds for the shutdown of any phase (group ofSmartLifecycle
beans with the same 'phase' value).void
start()
Start all registered beans that implementLifecycle
and are not already running.void
stop()
Stop all registered beans that implementLifecycle
and are currently running.
-
Constructor Details
-
DefaultLifecycleProcessor
public DefaultLifecycleProcessor()
-
-
Method Details
-
setTimeoutPerShutdownPhase
public void setTimeoutPerShutdownPhase(long timeoutPerShutdownPhase) Specify the maximum time allotted in milliseconds for the shutdown of any phase (group ofSmartLifecycle
beans with the same 'phase' value).The default value is 30000 milliseconds (30 seconds).
- See Also:
-
setBeanFactory
Description copied from interface:BeanFactoryAware
Callback that supplies the owning factory to a bean instance.Invoked after the population of normal bean properties but before an initialization callback such as
InitializingBean.afterPropertiesSet()
or a custom init-method.- Specified by:
setBeanFactory
in interfaceBeanFactoryAware
- Parameters:
beanFactory
- owning BeanFactory (nevernull
). The bean can immediately call methods on the factory.- See Also:
-
start
public void start()Start all registered beans that implementLifecycle
and are not already running. Any bean that implementsSmartLifecycle
will be started within its 'phase', and all phases will be ordered from lowest to highest value. All beans that do not implementSmartLifecycle
will be started in the default phase 0. A bean declared as a dependency of another bean will be started before the dependent bean regardless of the declared phase. -
stop
public void stop()Stop all registered beans that implementLifecycle
and are currently running. Any bean that implementsSmartLifecycle
will be stopped within its 'phase', and all phases will be ordered from highest to lowest value. All beans that do not implementSmartLifecycle
will be stopped in the default phase 0. A bean declared as dependent on another bean will be stopped before the dependency bean regardless of the declared phase. -
onRefresh
public void onRefresh()Description copied from interface:LifecycleProcessor
Notification of context refresh, e.g. for auto-starting components.- Specified by:
onRefresh
in interfaceLifecycleProcessor
-
onClose
public void onClose()Description copied from interface:LifecycleProcessor
Notification of context close phase, e.g. for auto-stopping components.- Specified by:
onClose
in interfaceLifecycleProcessor
-
isRunning
public boolean isRunning()Description copied from interface:Lifecycle
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. -
getLifecycleBeans
Retrieve all applicable Lifecycle beans: all singletons that have already been created, as well as all SmartLifecycle beans (even if they are marked as lazy-init).- Returns:
- the Map of applicable beans, with bean names as keys and bean instances as values
-
getPhase
Determine the lifecycle phase of the given bean.The default implementation checks for the
Phased
interface, using a default of 0 otherwise. Can be overridden to apply other/further policies.- Parameters:
bean
- the bean to introspect- Returns:
- the phase (an integer value)
- See Also:
-