org.springframework.boot.actuate.jdbc

Class DataSourceHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.boot.actuate.jdbc.DataSourceHealthIndicator

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, HealthContributor, HealthIndicator

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

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

Since:

2.0.0

Constructor Summary

Constructors

Constructor and Description
DataSourceHealthIndicator() Create a new DataSourceHealthIndicator instance.
DataSourceHealthIndicator(javax.sql.DataSource dataSource) Create a new DataSourceHealthIndicator using the specified DataSource.
DataSourceHealthIndicator(javax.sql.DataSource dataSource, java.lang.String query) Create a new DataSourceHealthIndicator using the specified DataSource and validation query.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	doHealthCheck(Health.Builder builder) Actual health check logic.
java.lang.String	getQuery() Return the validation query or null.
void	setDataSource(javax.sql.DataSource dataSource) Set the DataSource to use.
void	setQuery(java.lang.String query) Set a specific validation query to use to validate a connection.

Methods inherited from class org.springframework.boot.actuate.health.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.actuate.health.HealthIndicator

getHealth

Constructor Detail

DataSourceHealthIndicator

public DataSourceHealthIndicator()

Create a new DataSourceHealthIndicator instance.

DataSourceHealthIndicator

public DataSourceHealthIndicator(javax.sql.DataSource dataSource)

Create a new DataSourceHealthIndicator using the specified DataSource.

Parameters:

dataSource - the data source

DataSourceHealthIndicator

public DataSourceHealthIndicator(javax.sql.DataSource dataSource,
                                 java.lang.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 Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

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

Throws:

java.lang.Exception

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws java.lang.Exception

Description copied from class: AbstractHealthIndicator

Actual health check logic.

Specified by:

doHealthCheck in class AbstractHealthIndicator

Parameters:

builder - the Health.Builder to report health status and details

Throws:

java.lang.Exception - any Exception that should create a Status.DOWN system status.

setDataSource

public void setDataSource(javax.sql.DataSource dataSource)

Set the DataSource to use.

Parameters:

dataSource - the data source

setQuery

public void setQuery(java.lang.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 java.lang.String getQuery()

Return the validation query or null.

Returns:

the query