org.springframework.boot.actuate.health

Class CompositeHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.CompositeHealthIndicator

All Implemented Interfaces:

HealthIndicator

public class CompositeHealthIndicator
extends Object
implements HealthIndicator

HealthIndicator that returns health indications from all registered delegates.

Since:

1.1.0

Author:

Tyler J. Frederick, Phillip Webb, Christian Dupuis

Constructor Summary

Constructors

Constructor and Description
CompositeHealthIndicator(HealthAggregator healthAggregator) Create a new CompositeHealthIndicator.
CompositeHealthIndicator(HealthAggregator healthAggregator, Map<String,HealthIndicator> indicators) Create a new CompositeHealthIndicator from the specified indicators.

Method Summary

Modifier and Type	Method and Description
void	addHealthIndicator(String name, HealthIndicator indicator)
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

CompositeHealthIndicator

public CompositeHealthIndicator(HealthAggregator healthAggregator)

Create a new CompositeHealthIndicator.

Parameters:

healthAggregator - the health aggregator

CompositeHealthIndicator

public CompositeHealthIndicator(HealthAggregator healthAggregator,
                                Map<String,HealthIndicator> indicators)

Create a new CompositeHealthIndicator from the specified indicators.

Parameters:

healthAggregator - the health aggregator

indicators - a map of HealthIndicators with the key being used as an indicator name.

Method Detail

addHealthIndicator

public void addHealthIndicator(String name,
                               HealthIndicator indicator)

health

public Health health()

Description copied from interface: HealthIndicator

Return an indication of health.

Specified by:

health in interface HealthIndicator

Returns:

the health for