org.springframework.boot.actuate.health

Class DefaultHealthIndicatorRegistry

java.lang.Object

org.springframework.boot.actuate.health.DefaultHealthIndicatorRegistry

All Implemented Interfaces:

HealthIndicatorRegistry

public class DefaultHealthIndicatorRegistry
extends Object
implements HealthIndicatorRegistry

Default implementation of HealthIndicatorRegistry.

Since:

2.1.0

Author:

Vedran Pavic, Stephane Nicoll

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HealthIndicator	get(String name) Returns the HealthIndicator registered with the given name.
Map<String,HealthIndicator>	getAll() Returns a snapshot of the registered health indicators and their names.
void	register(String name, HealthIndicator healthIndicator) Registers the given HealthIndicator, associating it with the given name.
HealthIndicator	unregister(String name) Unregisters the HealthIndicator previously registered with the given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHealthIndicatorRegistry

public DefaultHealthIndicatorRegistry()

Create a new DefaultHealthIndicatorRegistry.

DefaultHealthIndicatorRegistry

public DefaultHealthIndicatorRegistry(Map<String,HealthIndicator> healthIndicators)

Create a new DefaultHealthIndicatorRegistry from the specified indicators.

Parameters:

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

Method Detail

register

public void register(String name,
                     HealthIndicator healthIndicator)

Description copied from interface: HealthIndicatorRegistry

Registers the given HealthIndicator, associating it with the given name.

Specified by:

register in interface HealthIndicatorRegistry

Parameters:

name - the name of the indicator

healthIndicator - the indicator

unregister

public HealthIndicator unregister(String name)

Description copied from interface: HealthIndicatorRegistry

Unregisters the HealthIndicator previously registered with the given name.

Specified by:

unregister in interface HealthIndicatorRegistry

Parameters:

name - the name of the indicator

Returns:

the unregistered indicator, or null if no indicator was found in the registry for the given name.

get

public HealthIndicator get(String name)

Description copied from interface: HealthIndicatorRegistry

Returns the HealthIndicator registered with the given name.

Specified by:

get in interface HealthIndicatorRegistry

Parameters:

name - the name of the indicator

Returns:

the health indicator, or null if no indicator was registered with the given name.

getAll

public Map<String,HealthIndicator> getAll()

Description copied from interface: HealthIndicatorRegistry

Returns a snapshot of the registered health indicators and their names. The contents of the map do not reflect subsequent changes to the registry.

Specified by:

getAll in interface HealthIndicatorRegistry

Returns:

the snapshot of registered health indicators