org.springframework.boot.actuate.health

Class DataSourceHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.boot.actuate.health.DataSourceHealthIndicator

All Implemented Interfaces:

HealthIndicator

public class DataSourceHealthIndicator
extends AbstractHealthIndicator

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

Since:

1.1.0

Author:

Dave Syer, Christian Dupuis, Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
DataSourceHealthIndicator() Create a new DataSourceHealthIndicator instance.
DataSourceHealthIndicator(DataSource dataSource) Create a new DataSourceHealthIndicator using the specified datasource.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	detectQuery(String product)
protected void	doHealthCheck(Health.Builder builder) Actual health check logic.
void	setDataSource(DataSource dataSource)
void	setQuery(String query)

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

Constructor Detail

DataSourceHealthIndicator

public DataSourceHealthIndicator()

Create a new DataSourceHealthIndicator instance.

DataSourceHealthIndicator

public DataSourceHealthIndicator(DataSource dataSource)

Create a new DataSourceHealthIndicator using the specified datasource.

Parameters:

dataSource - the data source

Method Detail

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws 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:

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

detectQuery

protected String detectQuery(String product)

setDataSource

public void setDataSource(DataSource dataSource)

setQuery

public void setQuery(String query)