public interface HealthChecker extends HealthStatusProvider
HealthStatusProvider
that computes its health status based on the registered
HealthStatusProvider
.Modifier and Type | Interface and Description |
---|---|
static class |
HealthChecker.HealthCheckerImpl
A
HealthChecker implementation that is safe for using with multiple threads provided that the
aggregated HealthStatusProvider are thread-safe. |
Modifier and Type | Method and Description |
---|---|
void |
deregister(HealthStatusProvider healthStatusProvider)
Deregisters a
HealthStatusProvider . |
static HealthChecker |
newHealthChecker()
Returns a thread safe implementation of
HealthChecker . |
void |
register(HealthStatusProvider healthStatusProvider)
Registers a
HealthStatusProvider . |
getHealthStatus
static HealthChecker newHealthChecker()
HealthChecker
.HealthChecker
.void register(HealthStatusProvider healthStatusProvider)
HealthStatusProvider
. After calling this method, the HealthStatus
given by the healthStatusProvider
will be taken into account for computing this HealthStatus
. This method must be
idempotent.healthStatusProvider
- The HealthStatusProvider
to be registered.void deregister(HealthStatusProvider healthStatusProvider)
HealthStatusProvider
. After calling this method, the HealthStatus
given by the
healthStatusProvider
won't be taken into account for computing this HealthStatus
. This method
must be idempotent. Calling this method with a HealthStatusProvider
that was not registered should have
no effect.healthStatusProvider
- The HealthStatusProvider
to be deregistered.Copyright 2010-2022 ForgeRock AS.