org.springframework.boot.actuate.health

Interface HealthIndicatorRegistry

All Known Implementing Classes:

DefaultHealthIndicatorRegistry

public interface HealthIndicatorRegistry

A registry of HealthIndicators.

Implementations must be thread-safe.

Since:

2.1.0

Author:

Andy Wilkinson, Vedran Pavic, Stephane Nicoll

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.

Method Detail

register

void register(String name,
              HealthIndicator healthIndicator)

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

Parameters:

name - the name of the indicator

healthIndicator - the indicator

Throws:

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

unregister

HealthIndicator unregister(String name)

Unregisters the HealthIndicator previously registered with the given name.

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

HealthIndicator get(String name)

Returns the HealthIndicator registered with the given name.

Parameters:

name - the name of the indicator

Returns:

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

getAll

Map<String,HealthIndicator> getAll()

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

Returns:

the snapshot of registered health indicators