org.springframework.boot.actuate.health

Class AbstractHealthAggregator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthAggregator

All Implemented Interfaces:

HealthAggregator

Direct Known Subclasses:

OrderedHealthAggregator

public abstract class AbstractHealthAggregator
extends Object
implements HealthAggregator

Base HealthAggregator implementation to allow subclasses to focus on aggregating the Status instances and not deal with contextual details etc.

Since:

1.1.0

Author:

Christian Dupuis, Vedran Pavic

Constructor Summary

Constructors

Constructor and Description
AbstractHealthAggregator()

Method Summary

Modifier and Type	Method and Description
Health	aggregate(Map<String,Health> healths) Aggregate several given Health instances into one.
protected Map<String,Object>	aggregateDetails(Map<String,Health> healths) Return the map of 'aggregate' details that should be used from the specified healths.
protected abstract Status	aggregateStatus(List<Status> candidates) Return the single 'aggregate' status that should be used from the specified candidates.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHealthAggregator

public AbstractHealthAggregator()

Method Detail

aggregate

public final Health aggregate(Map<String,Health> healths)

Description copied from interface: HealthAggregator

Aggregate several given Health instances into one.

Specified by:

aggregate in interface HealthAggregator

Parameters:

healths - the health instances to aggregate

Returns:

the aggregated health

aggregateStatus

protected abstract Status aggregateStatus(List<Status> candidates)

Return the single 'aggregate' status that should be used from the specified candidates.

Parameters:

candidates - the candidates

Returns:

a single status

aggregateDetails

protected Map<String,Object> aggregateDetails(Map<String,Health> healths)

Return the map of 'aggregate' details that should be used from the specified healths.

Parameters:

healths - the health instances to aggregate

Returns:

a map of details

Since:

1.3.1