Class DefaultReactiveHealthContributorRegistry

java.lang.Object

org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry

All Implemented Interfaces:

Iterable<ReactiveHealthContributors.Entry>, ReactiveHealthContributors, ReactiveHealthContributorRegistry

public class DefaultReactiveHealthContributorRegistry
extends Object
implements ReactiveHealthContributorRegistry

Default ReactiveHealthContributorRegistry implementation.

Since:

4.0.0

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from interface ReactiveHealthContributors

ReactiveHealthContributors.Entry

Constructor Summary

Constructors

Constructor	Description
DefaultReactiveHealthContributorRegistry()	Create a new empty DefaultReactiveHealthContributorRegistry instance.
DefaultReactiveHealthContributorRegistry(@Nullable Collection<? extends HealthContributorNameValidator> nameValidators, @Nullable Consumer<BiConsumer<String, ReactiveHealthContributor>> initialRegistrations)	Create a new DefaultReactiveHealthContributorRegistry instance.

Method Summary

Modifier and Type	Method	Description
@Nullable ReactiveHealthContributor	getContributor(String name)	Return the contributor with the given name.
void	registerContributor(String name, ReactiveHealthContributor contributor)	Register a contributor with the given name.
Stream<ReactiveHealthContributors.Entry>	stream()	Return a stream of the contributor entries.
@Nullable ReactiveHealthContributor	unregisterContributor(String name)	Unregister a previously registered contributor.

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface ReactiveHealthContributors

asHealthContributors, iterator

Constructor Details

DefaultReactiveHealthContributorRegistry

public DefaultReactiveHealthContributorRegistry()

Create a new empty DefaultReactiveHealthContributorRegistry instance.

DefaultReactiveHealthContributorRegistry

public DefaultReactiveHealthContributorRegistry(@Nullable Collection<? extends HealthContributorNameValidator> nameValidators,
 @Nullable Consumer<BiConsumer<String, ReactiveHealthContributor>> initialRegistrations)

Create a new DefaultReactiveHealthContributorRegistry instance.

Parameters:

nameValidators - the name validators to apply

initialRegistrations - callback to setup any initial registrations

Method Details

getContributor

public @Nullable ReactiveHealthContributor getContributor(String name)

Description copied from interface: ReactiveHealthContributors

Return the contributor with the given name.

Specified by:

getContributor in interface ReactiveHealthContributors

Parameters:

name - the name of the contributor

Returns:

a contributor instance or null

stream

public Stream<ReactiveHealthContributors.Entry> stream()

Description copied from interface: ReactiveHealthContributors

Return a stream of the contributor entries.

Specified by:

stream in interface ReactiveHealthContributors

Returns:

the stream of named contributors

registerContributor

public void registerContributor(String name,
 ReactiveHealthContributor contributor)

Description copied from interface: ReactiveHealthContributorRegistry

Register a contributor with the given name.

Specified by:

registerContributor in interface ReactiveHealthContributorRegistry

Parameters:

name - the name of the contributor

contributor - the contributor to register

unregisterContributor

public @Nullable ReactiveHealthContributor unregisterContributor(String name)

Description copied from interface: ReactiveHealthContributorRegistry

Unregister a previously registered contributor.

Specified by:

unregisterContributor in interface ReactiveHealthContributorRegistry

Parameters:

name - the name of the contributor to unregister

Returns:

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