Class DataSourceHealthIndicator

java.lang.Object

org.springframework.boot.health.contributor.AbstractHealthIndicator

org.springframework.boot.jdbc.health.DataSourceHealthIndicator

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, org.springframework.boot.health.contributor.HealthContributor, org.springframework.boot.health.contributor.HealthIndicator

public class DataSourceHealthIndicator
extends org.springframework.boot.health.contributor.AbstractHealthIndicator
implements org.springframework.beans.factory.InitializingBean

HealthIndicator that tests the status of a DataSource and optionally runs a test query.

Since:

4.0.0

Constructor Summary

Constructors

Constructor	Description
DataSourceHealthIndicator()	Create a new DataSourceHealthIndicator instance.
DataSourceHealthIndicator(@Nullable DataSource dataSource)	Create a new DataSourceHealthIndicator using the specified DataSource.
DataSourceHealthIndicator(@Nullable DataSource dataSource, @Nullable String query)	Create a new DataSourceHealthIndicator using the specified DataSource and validation query.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected void	doHealthCheck(org.springframework.boot.health.contributor.Health.Builder builder)
@Nullable String	getQuery()	Return the validation query or null.
void	setDataSource(DataSource dataSource)	Set the DataSource to use.
void	setQuery(String query)	Set a specific validation query to use to validate a connection.

Methods inherited from class org.springframework.boot.health.contributor.AbstractHealthIndicator

health

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.health.contributor.HealthIndicator

health

Constructor Details

DataSourceHealthIndicator

public DataSourceHealthIndicator()

Create a new DataSourceHealthIndicator instance.

DataSourceHealthIndicator

public DataSourceHealthIndicator(@Nullable DataSource dataSource)

Create a new DataSourceHealthIndicator using the specified DataSource.

Parameters:

dataSource - the data source

DataSourceHealthIndicator

public DataSourceHealthIndicator(@Nullable DataSource dataSource,
 @Nullable String query)

Create a new DataSourceHealthIndicator using the specified DataSource and validation query.

Parameters:

dataSource - the data source

query - the validation query to use (can be null)

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

doHealthCheck

protected void doHealthCheck(org.springframework.boot.health.contributor.Health.Builder builder)
                      throws Exception

Specified by:

doHealthCheck in class org.springframework.boot.health.contributor.AbstractHealthIndicator

Throws:

Exception

setDataSource

public void setDataSource(DataSource dataSource)

Set the DataSource to use.

Parameters:

dataSource - the data source

setQuery

public void setQuery(String query)

Set a specific validation query to use to validate a connection. If none is set, a validation based on Connection.isValid(int) is used.

Parameters:

query - the validation query to use

getQuery

public @Nullable String getQuery()

Return the validation query or null.

Returns:

the query