Modifier and Type	Class and Description
private class	DefaultLifecycleProcessor.CracDelegate Inner class to avoid a hard dependency on Project CRaC at runtime.
private class	DefaultLifecycleProcessor.CracResourceAdapter Resource adapter for Project CRaC, triggering a stop-and-restart cycle for Spring-managed lifecycle beans around a JVM checkpoint/restore.
private class	DefaultLifecycleProcessor.LifecycleGroup Helper class for maintaining a group of Lifecycle beans that should be started and stopped together based on their 'phase' value (or the default value of 0).
private static record	DefaultLifecycleProcessor.LifecycleGroupMember A simple record of a LifecycleGroup member.

Modifier and Type	Field and Description
private volatile ConfigurableListableBeanFactory	beanFactory
public static final String	CHECKPOINT_PROPERTY_NAME Property name for a common context checkpoint: spring.context.checkpoint.
private static final boolean	checkpointOnRefresh
private Object	cracResource
public static final String	EXIT_PROPERTY_NAME Property name for terminating the JVM when the context reaches a specific phase: spring.context.exit.
private static final boolean	exitOnRefresh
private final Log	logger
public static final String	ON_REFRESH_VALUE Recognized value for the context checkpoint and exit properties: onRefresh.
private volatile boolean	running
private volatile Set<String>	stoppedBeans
private volatile long	timeoutPerShutdownPhase

Access	Constructor and Description
public	DefaultLifecycleProcessor()

Method Summary

Modifier and Type	Method and Description
private void	doStart(Map<String, ? extends Lifecycle> a Map with bean name as key and Lifecycle instance as value lifecycleBeans, String the name of the bean to start beanName, boolean autoStartupOnly) Start the specified bean as part of the given set of Lifecycle beans, making sure that any beans that it depends on are started first.
private void	doStop(Map<String, ? extends Lifecycle> a Map with bean name as key and Lifecycle instance as value lifecycleBeans, final String the name of the bean to stop beanName, final CountDownLatch latch, final Set<String> countDownBeanNames) Stop the specified bean as part of the given set of Lifecycle beans, making sure that any beans that depends on it are stopped first.
private ConfigurableListableBeanFactory	getBeanFactory()
protected Map<String, Lifecycle>	Returns: the Map of applicable beans, with bean names as keys and bean instances as values 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).
protected int	Returns: the phase (an integer value) getPhase(Lifecycle the bean to introspect bean) Determine the lifecycle phase of the given bean.
private boolean	isAutoStartupCandidate(String beanName, Lifecycle bean)
public boolean	isRunning() Implements org.springframework.context.Lifecycle.isRunning. Check whether this component is currently running.
private boolean	matchesBeanType(Class<?> targetType, String beanName, BeanFactory beanFactory)
public void	onClose() Implements org.springframework.context.LifecycleProcessor.onClose. Notification of context close phase, e.g. for auto-stopping components.
public void	onRefresh() Implements org.springframework.context.LifecycleProcessor.onRefresh. Notification of context refresh, e.g. for auto-starting components.
pack-priv void	restartAfterStop()
public void	setBeanFactory(BeanFactory owning BeanFactory (never `null`). The bean can immediately call methods on the factory. beanFactory) Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. Callback that supplies the owning factory to a bean instance.
public void	setTimeoutPerShutdownPhase(long timeoutPerShutdownPhase) Specify the maximum time allotted in milliseconds for the shutdown of any phase (group of `SmartLifecycle` beans with the same 'phase' value).
public void	start() Implements org.springframework.context.Lifecycle.start. Start all registered beans that implement `Lifecycle` and are not already running.
private void	startBeans(boolean autoStartupOnly)
public void	stop() Implements org.springframework.context.Lifecycle.stop. Stop all registered beans that implement `Lifecycle` and are currently running.
private void	stopBeans()
pack-priv void	stopForRestart()
private boolean	toBeStarted(String beanName, Lifecycle bean)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

beanFactory	back to summary
private volatile ConfigurableListableBeanFactory beanFactory Annotations @Nullable

CHECKPOINT_PROPERTY_NAME back to summary

CHECKPOINT_PROPERTY_NAME	back to summary
public static final String CHECKPOINT_PROPERTY_NAME Property name for a common context checkpoint: spring.context.checkpoint. Since 6.1 See Also `ON_REFRESH_VALUE`, `org.crac.Core#checkpointRestore()`

public static final String CHECKPOINT_PROPERTY_NAME

Property name for a common context checkpoint: spring.context.checkpoint.

Since: 6.1
See Also: ON_REFRESH_VALUE, org.crac.Core#checkpointRestore()

checkpointOnRefresh	back to summary
private static final boolean checkpointOnRefresh

cracResource	back to summary
private Object cracResource Annotations @Nullable

EXIT_PROPERTY_NAME back to summary

EXIT_PROPERTY_NAME	back to summary
public static final String EXIT_PROPERTY_NAME Property name for terminating the JVM when the context reaches a specific phase: spring.context.exit. Since 6.1 See Also `ON_REFRESH_VALUE`

public static final String EXIT_PROPERTY_NAME

Property name for terminating the JVM when the context reaches a specific phase: spring.context.exit.

Since: 6.1
See Also: ON_REFRESH_VALUE

exitOnRefresh	back to summary
private static final boolean exitOnRefresh

logger	back to summary
private final Log logger

ON_REFRESH_VALUE back to summary

ON_REFRESH_VALUE	back to summary
public static final String ON_REFRESH_VALUE Recognized value for the context checkpoint and exit properties: onRefresh. Since 6.1 See Also `CHECKPOINT_PROPERTY_NAME`, `EXIT_PROPERTY_NAME`

public static final String ON_REFRESH_VALUE

Recognized value for the context checkpoint and exit properties: onRefresh.

Since: 6.1
See Also: CHECKPOINT_PROPERTY_NAME, EXIT_PROPERTY_NAME

running	back to summary
private volatile boolean running

stoppedBeans	back to summary
private volatile Set<String> stoppedBeans Annotations @Nullable

timeoutPerShutdownPhase	back to summary
private volatile long timeoutPerShutdownPhase

Constructor Detail

DefaultLifecycleProcessor	back to summary
public DefaultLifecycleProcessor()

Method Detail

doStart	back to summary
private void doStart(Map<String, ? extends Lifecycle> lifecycleBeans, String beanName, boolean autoStartupOnly) Start the specified bean as part of the given set of Lifecycle beans, making sure that any beans that it depends on are started first. Parameters lifecycleBeans:Map<String, ? extends Lifecycle> a Map with bean name as key and Lifecycle instance as value beanName:String the name of the bean to start

doStart

back to summary

private void doStart(Map<String, ? extends Lifecycle> lifecycleBeans, String beanName, boolean autoStartupOnly)

Start the specified bean as part of the given set of Lifecycle beans, making sure that any beans that it depends on are started first.

Parameters

lifecycleBeans:Map<String, ? extends Lifecycle>: a Map with bean name as key and Lifecycle instance as value
beanName:String: the name of the bean to start

doStop	back to summary
private void doStop(Map<String, ? extends Lifecycle> lifecycleBeans, final String beanName, final CountDownLatch latch, final Set<String> countDownBeanNames) Stop the specified bean as part of the given set of Lifecycle beans, making sure that any beans that depends on it are stopped first. Parameters lifecycleBeans:Map<String, ? extends Lifecycle> a Map with bean name as key and Lifecycle instance as value beanName:String the name of the bean to stop

doStop

back to summary

private void doStop(Map<String, ? extends Lifecycle> lifecycleBeans, final String beanName, final CountDownLatch latch, final Set<String> countDownBeanNames)

Stop the specified bean as part of the given set of Lifecycle beans, making sure that any beans that depends on it are stopped first.

Parameters

lifecycleBeans:Map<String, ? extends Lifecycle>: a Map with bean name as key and Lifecycle instance as value
beanName:String: the name of the bean to stop

getBeanFactory	back to summary
private ConfigurableListableBeanFactory getBeanFactory()

getLifecycleBeans	back to summary
protected Map<String, Lifecycle> 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:Map<String, Lifecycle> the Map of applicable beans, with bean names as keys and bean instances as values

getLifecycleBeans

back to summary

protected Map<String, Lifecycle> 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:Map<String, Lifecycle>: the Map of applicable beans, with bean names as keys and bean instances as values

getPhase back to summary

getPhase	back to summary
protected int getPhase(Lifecycle bean) 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:Lifecycle the bean to introspect Returns:int the phase (an integer value) See Also `Phased#getPhase()`, `SmartLifecycle`

protected int getPhase(Lifecycle bean)

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:Lifecycle: the bean to introspect

Returns:int

the phase (an integer value)

See Also

Phased#getPhase(), SmartLifecycle

isAutoStartupCandidate	back to summary
private boolean isAutoStartupCandidate(String beanName, Lifecycle bean)

isRunning back to summary

isRunning	back to summary
public boolean isRunning() Implements org.springframework.context.Lifecycle.isRunning. Doc from org.springframework.context.Lifecycle.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:boolean whether the component is currently running Annotations @Override

public boolean isRunning()

Implements org.springframework.context.Lifecycle.isRunning.

Doc from org.springframework.context.Lifecycle.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:boolean

whether the component is currently running

Annotations

@Override

matchesBeanType	back to summary
private boolean matchesBeanType(Class<?> targetType, String beanName, BeanFactory beanFactory)

onClose	back to summary
public void onClose() Implements org.springframework.context.LifecycleProcessor.onClose. Doc from org.springframework.context.LifecycleProcessor.onClose. Notification of context close phase, e.g. for auto-stopping components. Annotations @Override

onClose

back to summary

public void onClose()

Implements org.springframework.context.LifecycleProcessor.onClose.

Doc from org.springframework.context.LifecycleProcessor.onClose.

Notification of context close phase, e.g. for auto-stopping components.

Annotations

@Override

onRefresh	back to summary
public void onRefresh() Implements org.springframework.context.LifecycleProcessor.onRefresh. Doc from org.springframework.context.LifecycleProcessor.onRefresh. Notification of context refresh, e.g. for auto-starting components. Annotations @Override

onRefresh

back to summary

public void onRefresh()

Implements org.springframework.context.LifecycleProcessor.onRefresh.

Doc from org.springframework.context.LifecycleProcessor.onRefresh.

Notification of context refresh, e.g. for auto-starting components.

Annotations

@Override

restartAfterStop	back to summary
pack-priv void restartAfterStop()

setBeanFactory back to summary

setBeanFactory	back to summary
public void setBeanFactory(BeanFactory beanFactory) Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. Doc from org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. 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. Parameters beanFactory:BeanFactory owning BeanFactory (never `null`). The bean can immediately call methods on the factory. Annotations @Override

public void setBeanFactory(BeanFactory beanFactory)

Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

Doc from org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

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.

Parameters

beanFactory:BeanFactory: owning BeanFactory (never null). The bean can immediately call methods on the factory.

Annotations

@Override

setTimeoutPerShutdownPhase back to summary

setTimeoutPerShutdownPhase	back to summary
public void setTimeoutPerShutdownPhase(long timeoutPerShutdownPhase) Specify the maximum time allotted in milliseconds for the shutdown of any phase (group of `SmartLifecycle` beans with the same 'phase' value). The default value is 30000 milliseconds (30 seconds). See Also `SmartLifecycle#getPhase()`

public void setTimeoutPerShutdownPhase(long timeoutPerShutdownPhase)

Specify the maximum time allotted in milliseconds for the shutdown of any phase (group of SmartLifecycle beans with the same 'phase' value).

The default value is 30000 milliseconds (30 seconds).

See Also: SmartLifecycle#getPhase()

start back to summary

start	back to summary
public void start() Implements org.springframework.context.Lifecycle.start. Start all registered beans that implement `Lifecycle` and are not already running. Any bean that implements `SmartLifecycle` will be started within its 'phase', and all phases will be ordered from lowest to highest value. All beans that do not implement `SmartLifecycle` 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. Annotations @Override

public void start()

Implements org.springframework.context.Lifecycle.start.

Start all registered beans that implement Lifecycle and are not already running. Any bean that implements SmartLifecycle will be started within its 'phase', and all phases will be ordered from lowest to highest value. All beans that do not implement SmartLifecycle 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.

Annotations

@Override

startBeans	back to summary
private void startBeans(boolean autoStartupOnly)

stop back to summary

stop	back to summary
public void stop() Implements org.springframework.context.Lifecycle.stop. Stop all registered beans that implement `Lifecycle` and are currently running. Any bean that implements `SmartLifecycle` will be stopped within its 'phase', and all phases will be ordered from highest to lowest value. All beans that do not implement `SmartLifecycle` 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. Annotations @Override

public void stop()

Implements org.springframework.context.Lifecycle.stop.

Stop all registered beans that implement Lifecycle and are currently running. Any bean that implements SmartLifecycle will be stopped within its 'phase', and all phases will be ordered from highest to lowest value. All beans that do not implement SmartLifecycle 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.

Annotations

@Override

stopBeans	back to summary
private void stopBeans()

stopForRestart	back to summary
pack-priv void stopForRestart()

toBeStarted	back to summary
private boolean toBeStarted(String beanName, Lifecycle bean)

org.springframework.context.support back to summary

private Class DefaultLifecycleProcessor.CracDelegate

Class Inheritance

extends Object

java.lang.Object
org.springframework.context.support.DefaultLifecycleProcessor.CracDelegate

Inner class to avoid a hard dependency on Project CRaC at runtime.

Since: 6.1
See Also: org.crac.Core

Constructor Summary

Access	Constructor and Description
private	CracDelegate()

Method Summary

Modifier and Type	Method and Description
public void	checkpointRestore()
public Object	registerResource()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

CracDelegate	back to summary
private CracDelegate()

Method Detail

checkpointRestore	back to summary
public void checkpointRestore()

registerResource	back to summary
public Object registerResource()

org.springframework.context.support back to summary

private Class DefaultLifecycleProcessor.CracResourceAdapter

Class Inheritance

extends Object
implements Resource

java.lang.Object
org.springframework.context.support.DefaultLifecycleProcessor.CracResourceAdapter

All Implemented Interfaces

org.crac.Resource

Resource adapter for Project CRaC, triggering a stop-and-restart cycle for Spring-managed lifecycle beans around a JVM checkpoint/restore.

Since: 6.1
See Also: stopForRestart(), restartAfterStop()

Field Summary

Modifier and Type	Field and Description
private CyclicBarrier	barrier

Constructor Summary

Access	Constructor and Description
private	CracResourceAdapter()

Method Summary

Modifier and Type	Method and Description
public void	afterRestore(Context<? extends Resource> `Context` providing notification context) Implements org.crac.Resource.afterRestore. Invoked by a `Context` as a notification about restore.
private void	awaitPreventShutdownBarrier()
public void	beforeCheckpoint(Context<? extends Resource> `Context` providing notification context) Implements org.crac.Resource.beforeCheckpoint. Invoked by a `Context` as a notification about checkpoint.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

barrier	back to summary
private CyclicBarrier barrier Annotations @Nullable

Constructor Detail

CracResourceAdapter	back to summary
private CracResourceAdapter()

Method Detail

afterRestore back to summary

afterRestore	back to summary
public void afterRestore(Context<? extends Resource> context) Implements org.crac.Resource.afterRestore. Doc from org.crac.Resource.afterRestore. Invoked by a `Context` as a notification about restore. Parameters context:Context<? extends Resource> `Context` providing notification Annotations @Override

public void afterRestore(Context<? extends Resource> context)

Implements org.crac.Resource.afterRestore.

Doc from org.crac.Resource.afterRestore.

Invoked by a Context as a notification about restore.

Parameters

context:Context<? extends Resource>: Context providing notification

Annotations

@Override

awaitPreventShutdownBarrier	back to summary
private void awaitPreventShutdownBarrier()

beforeCheckpoint back to summary

beforeCheckpoint	back to summary
public void beforeCheckpoint(Context<? extends Resource> context) Implements org.crac.Resource.beforeCheckpoint. Doc from org.crac.Resource.beforeCheckpoint. Invoked by a `Context` as a notification about checkpoint. Parameters context:Context<? extends Resource> `Context` providing notification Annotations @Override

public void beforeCheckpoint(Context<? extends Resource> context)

Implements org.crac.Resource.beforeCheckpoint.

Doc from org.crac.Resource.beforeCheckpoint.

Invoked by a Context as a notification about checkpoint.

Parameters

context:Context<? extends Resource>: Context providing notification

Annotations

@Override

org.springframework.context.support back to summary

private Class DefaultLifecycleProcessor.LifecycleGroup

Class Inheritance

extends Object

java.lang.Object
org.springframework.context.support.DefaultLifecycleProcessor.LifecycleGroup

Helper class for maintaining a group of Lifecycle beans that should be started and stopped together based on their 'phase' value (or the default value of 0). The group is expected to be created in an ad-hoc fashion and group members are expected to always have the same 'phase' value.

Field Summary

Modifier and Type	Field and Description
private final boolean	autoStartupOnly
private final Map<String, ? extends Lifecycle>	lifecycleBeans
private final List<DefaultLifecycleProcessor.LifecycleGroupMember>	members
private final int	phase
private int	smartMemberCount
private final long	timeout

Constructor Summary

Access	Constructor and Description
public	LifecycleGroup(int phase, long timeout, Map<String, ? extends Lifecycle> lifecycleBeans, boolean autoStartupOnly)

Method Summary

Modifier and Type	Method and Description
public void	add(String name, Lifecycle bean)
public void	start()
public void	stop()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

autoStartupOnly	back to summary
private final boolean autoStartupOnly

lifecycleBeans	back to summary
private final Map<String, ? extends Lifecycle> lifecycleBeans

members	back to summary
private final List<DefaultLifecycleProcessor.LifecycleGroupMember> members

phase	back to summary
private final int phase

smartMemberCount	back to summary
private int smartMemberCount

timeout	back to summary
private final long timeout

Constructor Detail

LifecycleGroup	back to summary
public LifecycleGroup(int phase, long timeout, Map<String, ? extends Lifecycle> lifecycleBeans, boolean autoStartupOnly)

Method Detail

add	back to summary
public void add(String name, Lifecycle bean)

start	back to summary
public void start()

stop	back to summary
public void stop()

org.springframework.context.support back to summary

private final Record DefaultLifecycleProcessor.LifecycleGroupMember

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.springframework.context.support.DefaultLifecycleProcessor.LifecycleGroupMember

Record Components

name:String
bean:Lifecycle

A simple record of a LifecycleGroup member.

Field Summary

Modifier and Type	Field and Description
private final Lifecycle	bean Record Component accessed by bean().
private final String	name Record Component accessed by name().

Constructor Summary

Access	Constructor and Description
private	LifecycleGroupMember(String name, Lifecycle bean)

Method Summary

Modifier and Type	Method and Description
public Lifecycle	bean() Record Component getter of bean.
public final boolean	equals(Object the reference object with which to compare. o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public String	name() Record Component getter of name.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

bean	back to summary
private final Lifecycle bean Record Component accessed by bean().

name	back to summary
private final String name Record Component accessed by name().

Constructor Detail

LifecycleGroupMember	back to summary
private LifecycleGroupMember(String name, Lifecycle bean)

Method Detail

bean	back to summary
public Lifecycle bean() Record Component getter of bean.

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int: a hash code value for this record.

name	back to summary
public String name() Record Component getter of name.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String: a string representation of the object.

public Class DefaultLifecycleProcessor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultLifecycleProcessor.CracDelegate

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class DefaultLifecycleProcessor.CracResourceAdapter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultLifecycleProcessor.LifecycleGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record DefaultLifecycleProcessor.LifecycleGroupMember

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail