org.springframework.boot.actuate.health

Class DefaultHealthContributorRegistry

java.lang.Object

org.springframework.boot.actuate.health.DefaultHealthContributorRegistry

All Implemented Interfaces:

Iterable<NamedContributor<HealthContributor>>, ContributorRegistry<HealthContributor>, HealthContributorRegistry, NamedContributors<HealthContributor>

public class DefaultHealthContributorRegistry
extends Object
implements HealthContributorRegistry

Default HealthContributorRegistry implementation.

Since:

2.2.0

Author:

Phillip Webb

Constructor Summary

Constructors

Constructor and Description
DefaultHealthContributorRegistry()
DefaultHealthContributorRegistry(Map<String,HealthContributor> contributors)
DefaultHealthContributorRegistry(Map<String,HealthContributor> contributors, Function<String,String> nameFactory)

Method Summary

Modifier and Type	Method and Description
C	getContributor(String name) Return the contributor with the given name.
Iterator<NamedContributor<C>>	iterator()
void	registerContributor(String name, C contributor) Register a contributor with the given name.
C	unregisterContributor(String name) Unregister a previously registered contributor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.actuate.health.ContributorRegistry

registerContributor, unregisterContributor

Methods inherited from interface org.springframework.boot.actuate.health.NamedContributors

getContributor, stream

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

DefaultHealthContributorRegistry

public DefaultHealthContributorRegistry()

DefaultHealthContributorRegistry

public DefaultHealthContributorRegistry(Map<String,HealthContributor> contributors)

DefaultHealthContributorRegistry

public DefaultHealthContributorRegistry(Map<String,HealthContributor> contributors,
                                        Function<String,String> nameFactory)

Method Detail

registerContributor

public void registerContributor(String name,
                                C contributor)

Description copied from interface: ContributorRegistry

Register a contributor with the given name.

Specified by:

registerContributor in interface ContributorRegistry<C>

Parameters:

name - the name of the contributor

contributor - the contributor to register

unregisterContributor

public C unregisterContributor(String name)

Description copied from interface: ContributorRegistry

Unregister a previously registered contributor.

Specified by:

unregisterContributor in interface ContributorRegistry<C>

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.

getContributor

public C getContributor(String name)

Description copied from interface: NamedContributors

Return the contributor with the given name.

Specified by:

getContributor in interface NamedContributors<C>

Parameters:

name - the name of the contributor

Returns:

a contributor instance or null

iterator

public Iterator<NamedContributor<C>> iterator()

Specified by:

iterator in interface Iterable<NamedContributor<C>>