Class HikariCheckpointRestoreLifecycle

java.lang.Object

org.springframework.boot.jdbc.HikariCheckpointRestoreLifecycle

All Implemented Interfaces:

Lifecycle

public class HikariCheckpointRestoreLifecycle
extends Object
implements Lifecycle

Lifecycle for a HikariDataSource allowing it to participate in checkpoint-restore. When stopped, and the data source allows it, its pool is suspended, blocking any attempts to borrow connections. Open and idle connections are then evicted. When subsequently started, the pool is resumed if necessary.

Since:

3.2.0

Author:

Christoph Strobl, Andy Wilkinson, Moritz Halbritter

Constructor Summary

Constructors

Constructor	Description
HikariCheckpointRestoreLifecycle(DataSource dataSource, ConfigurableApplicationContext applicationContext)	Creates a new HikariCheckpointRestoreLifecycle that will allow the given dataSource to participate in checkpoint-restore.

Method Summary

Modifier and Type	Method	Description
boolean	isRunning()
void	start()
void	stop()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HikariCheckpointRestoreLifecycle

public HikariCheckpointRestoreLifecycle(DataSource dataSource,
 ConfigurableApplicationContext applicationContext)

Creates a new HikariCheckpointRestoreLifecycle that will allow the given dataSource to participate in checkpoint-restore. The dataSource is unwrapped to a HikariDataSource. If such unwrapping is not possible, the lifecycle will have no effect.

Parameters:

dataSource - the checkpoint-restore participant

applicationContext - the application context

Since:

3.4.0

Method Details

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle