Package org.springframework.boot.actuate.health

Class CompositeHealth

java.lang.Object

org.springframework.boot.actuate.health.HealthComponent

org.springframework.boot.actuate.health.CompositeHealth

All Implemented Interfaces:

OperationResponseBody

Direct Known Subclasses:

SystemHealth

public class CompositeHealth
extends HealthComponent

A HealthComponent that is composed of other HealthComponent instances. Used to provide a unified view of related components. For example, a database health indicator may be a composite containing the Health of each datasource connection.

Since:

2.2.0

Author:

Phillip Webb

Method Summary

Modifier and Type	Method	Description
Map<String,HealthComponent>	getComponents()
Map<String,HealthComponent>	getDetails()
Status	getStatus()	Return the status of the component.

Methods inherited from class java.lang.Object

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

Method Details

getStatus

public Status getStatus()

Description copied from class: HealthComponent

Return the status of the component.

Specified by:

getStatus in class HealthComponent

Returns:

the component status

getComponents

public Map<String,HealthComponent> getComponents()

getDetails

public Map<String,HealthComponent> getDetails()