Interface HealthContributorRegistry

All Superinterfaces:

HealthContributors, Iterable<HealthContributors.Entry>

All Known Implementing Classes:

DefaultHealthContributorRegistry

public interface HealthContributorRegistry
extends HealthContributors

A mutable registry of health contributors.

Since:

4.0.0

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from interface HealthContributors

HealthContributors.Entry

Method Summary

Modifier and Type	Method	Description
void	registerContributor(String name, HealthContributor contributor)	Register a contributor with the given name.
@Nullable HealthContributor	unregisterContributor(String name)	Unregister a previously registered contributor.

Methods inherited from interface HealthContributors

getContributor, iterator, stream

Methods inherited from interface Iterable

forEach, spliterator

Method Details

registerContributor

void registerContributor(String name,
 HealthContributor contributor)

Register a contributor with the given name.

Parameters:

name - the name of the contributor

contributor - the contributor to register

Throws:

IllegalStateException - if the contributor cannot be registered with the given name.

unregisterContributor

@Nullable HealthContributor unregisterContributor(String name)

Unregister a previously registered contributor.

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.