org.springframework.boot.actuate.health

Class DefaultReactiveHealthIndicatorRegistry

java.lang.Object

org.springframework.boot.actuate.health.DefaultReactiveHealthIndicatorRegistry

All Implemented Interfaces:

ReactiveHealthIndicatorRegistry

public class DefaultReactiveHealthIndicatorRegistry
extends Object
implements ReactiveHealthIndicatorRegistry

Default implementation of ReactiveHealthIndicatorRegistry.

Since:

2.1.0

Author:

Vedran Pavic, Stephane Nicoll

Constructor Summary

Constructors

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

Method Summary

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

DefaultReactiveHealthIndicatorRegistry

public DefaultReactiveHealthIndicatorRegistry()

Create a new DefaultReactiveHealthIndicatorRegistry.

DefaultReactiveHealthIndicatorRegistry

public DefaultReactiveHealthIndicatorRegistry(Map<String,ReactiveHealthIndicator> healthIndicators)

Create a new DefaultReactiveHealthIndicatorRegistry 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,
                     ReactiveHealthIndicator healthIndicator)

Description copied from interface: ReactiveHealthIndicatorRegistry

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

Specified by:

register in interface ReactiveHealthIndicatorRegistry

Parameters:

name - the name of the indicator

healthIndicator - the indicator

unregister

public ReactiveHealthIndicator unregister(String name)

Description copied from interface: ReactiveHealthIndicatorRegistry

Unregisters the ReactiveHealthIndicator previously registered with the given name.

Specified by:

unregister in interface ReactiveHealthIndicatorRegistry

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 ReactiveHealthIndicator get(String name)

Description copied from interface: ReactiveHealthIndicatorRegistry

Returns the ReactiveHealthIndicator registered with the given name.

Specified by:

get in interface ReactiveHealthIndicatorRegistry

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,ReactiveHealthIndicator> getAll()

Description copied from interface: ReactiveHealthIndicatorRegistry

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 ReactiveHealthIndicatorRegistry

Returns:

the snapshot of registered health indicators