org.springframework.boot.actuate.health

Class AbstractHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

All Implemented Interfaces:

HealthIndicator

Direct Known Subclasses:

ApplicationHealthIndicator, CassandraHealthIndicator, CouchbaseHealthIndicator, DataSourceHealthIndicator, DiskSpaceHealthIndicator, ElasticsearchHealthIndicator, ElasticsearchJestHealthIndicator, InfluxDbHealthIndicator, JmsHealthIndicator, LdapHealthIndicator, MailHealthIndicator, MongoHealthIndicator, Neo4jHealthIndicator, RabbitHealthIndicator, RedisHealthIndicator, SolrHealthIndicator

public abstract class AbstractHealthIndicator
extends Object
implements HealthIndicator

Base HealthIndicator implementations that encapsulates creation of Health instance and error handling.

This implementation is only suitable if an Exception raised from doHealthCheck(org.springframework.boot.actuate.health.Health.Builder) should create a Status.DOWN health status.

Since:

1.1.0

Author:

Christian Dupuis

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractHealthIndicator() Create a new AbstractHealthIndicator instance with a default healthCheckFailedMessage.
protected	AbstractHealthIndicator(Function<Exception,String> healthCheckFailedMessage) Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.
protected	AbstractHealthIndicator(String healthCheckFailedMessage) Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.

Method Summary

Modifier and Type	Method and Description
protected abstract void	doHealthCheck(Health.Builder builder) Actual health check logic.
Health	health() Return an indication of health.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHealthIndicator

public AbstractHealthIndicator()

Create a new AbstractHealthIndicator instance with a default healthCheckFailedMessage.

AbstractHealthIndicator

protected AbstractHealthIndicator(String healthCheckFailedMessage)

Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.

Parameters:

healthCheckFailedMessage - the message to log on health check failure

Since:

2.0.0

AbstractHealthIndicator

protected AbstractHealthIndicator(Function<Exception,String> healthCheckFailedMessage)

Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.

Parameters:

healthCheckFailedMessage - the message to log on health check failure

Since:

2.0.0

Method Detail

health

public final Health health()

Description copied from interface: HealthIndicator

Return an indication of health.

Specified by:

health in interface HealthIndicator

Returns:

the health for

doHealthCheck

protected abstract void doHealthCheck(Health.Builder builder)
                               throws Exception

Actual health check logic.

Parameters:

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

Throws:

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