org.springframework.boot.actuate.health

Class CompositeHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.CompositeHealthIndicator

All Implemented Interfaces:

HealthIndicator<Map<String,Object>>

public class CompositeHealthIndicator
extends Object
implements HealthIndicator<Map<String,Object>>

HealthIndicator that returns health indications from all registered delegates.

Since:

1.1.0

Author:

Tyler J. Frederick, Phillip Webb

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addHealthIndicator(String name, HealthIndicator<?> indicator)
Map<String,Object>	health()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeHealthIndicator

public CompositeHealthIndicator()

Create a new CompositeHealthIndicator.

CompositeHealthIndicator

public CompositeHealthIndicator(Map<String,HealthIndicator<?>> indicators)

Create a new CompositeHealthIndicator from the specified indicators.

Parameters:

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 Map<String,Object> health()

Specified by:

health in interface HealthIndicator<Map<String,Object>>

Returns:

an indication of health