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) Deprecated. since 2.1.0 in favour of CompositeHealthIndicator(HealthAggregator, HealthIndicatorRegistry)
CompositeHealthIndicator(HealthAggregator healthAggregator, HealthIndicatorRegistry registry) Create a new CompositeHealthIndicator from the indicators in the given registry.
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) Deprecated. since 2.1.0 in favour of HealthIndicatorRegistry.register(String, HealthIndicator)
HealthIndicatorRegistry	getRegistry() Return the HealthIndicatorRegistry of this instance.
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

@Deprecated
public CompositeHealthIndicator(HealthAggregator healthAggregator)

Deprecated. since 2.1.0 in favour of CompositeHealthIndicator(HealthAggregator, HealthIndicatorRegistry)

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.

CompositeHealthIndicator

public CompositeHealthIndicator(HealthAggregator healthAggregator,
                                HealthIndicatorRegistry registry)

Create a new CompositeHealthIndicator from the indicators in the given registry.

Parameters:

healthAggregator - the health aggregator

registry - the registry of HealthIndicators.

Method Detail

addHealthIndicator

@Deprecated
public void addHealthIndicator(String name,
                                           HealthIndicator indicator)

Deprecated. since 2.1.0 in favour of HealthIndicatorRegistry.register(String, HealthIndicator)

Adds the given healthIndicator, associating it with the given name.

Parameters:

name - the name of the indicator

indicator - the indicator

Throws:

IllegalStateException - if an indicator with the given name is already registered.

getRegistry

public HealthIndicatorRegistry getRegistry()

Return the HealthIndicatorRegistry of this instance.

Returns:

the registry of nested health indicators

Since:

2.1.0

health

public Health health()

Description copied from interface: HealthIndicator

Return an indication of health.

Specified by:

health in interface HealthIndicator

Returns:

the health for