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
,HealthIndicator
public class DataSourceHealthIndicator extends AbstractHealthIndicator implements org.springframework.beans.factory.InitializingBean
HealthIndicator
that tests the status of aDataSource
and optionally runs a test query.- Since:
- 2.0.0
Constructor Summary
Constructors Constructor Description DataSourceHealthIndicator()
Create a newDataSourceHealthIndicator
instance.DataSourceHealthIndicator(DataSource dataSource)
Create a newDataSourceHealthIndicator
using the specifiedDataSource
.DataSourceHealthIndicator(DataSource dataSource, String query)
Create a newDataSourceHealthIndicator
using the specifiedDataSource
and validation query.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
protected void
doHealthCheck(Health.Builder builder)
Actual health check logic.String
getQuery()
Return the validation query ornull
.protected String
getValidationQuery(String product)
void
setDataSource(DataSource dataSource)
Set theDataSource
to use.void
setQuery(String query)
Set a specific validation query to use to validate a connection.Methods inherited from class org.springframework.boot.actuate.health.AbstractHealthIndicator
health
Constructor Detail
DataSourceHealthIndicator
public DataSourceHealthIndicator()
Create a newDataSourceHealthIndicator
instance.
DataSourceHealthIndicator
public DataSourceHealthIndicator(DataSource dataSource)
Create a newDataSourceHealthIndicator
using the specifiedDataSource
.- Parameters:
dataSource
- the data source
DataSourceHealthIndicator
public DataSourceHealthIndicator(DataSource dataSource, String query)
Create a newDataSourceHealthIndicator
using the specifiedDataSource
and validation query.- Parameters:
dataSource
- the data sourcequery
- the validation query to use (can benull
)
Method Detail
afterPropertiesSet
public void afterPropertiesSet() throws Exception
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
Exception
doHealthCheck
protected void doHealthCheck(Health.Builder builder) throws Exception
Description copied from class:AbstractHealthIndicator
Actual health check logic.- Specified by:
doHealthCheck
in classAbstractHealthIndicator
- Parameters:
builder
- theHealth.Builder
to report health status and details- Throws:
Exception
- anyException
that should create aStatus.DOWN
system status.
getValidationQuery
protected String getValidationQuery(String product)
setDataSource
public void setDataSource(DataSource dataSource)
Set theDataSource
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 default validation query is used.- Parameters:
query
- the query