Package org.opends.server.monitors

Interface HealthChecker

All Superinterfaces:

HealthStatusProvider

All Known Implementing Classes:

HealthChecker.HealthCheckerImpl

public interface HealthChecker
extends HealthStatusProvider

A composite HealthStatusProvider that computes its health status based on the registered HealthStatusProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HealthChecker.HealthCheckerImpl	A HealthChecker implementation that is safe for using with multiple threads provided that the aggregated HealthStatusProvider are thread-safe.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface org.opends.server.monitors.HealthStatusProvider

getHealthStatus

Method Details

newHealthChecker

static HealthChecker newHealthChecker()

Returns a thread safe implementation of HealthChecker.

Returns:

a thread safe implementation of HealthChecker.

register

void register(HealthStatusProvider healthStatusProvider)

Registers a 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.

Parameters:

healthStatusProvider - The HealthStatusProvider to be registered.

deregister

void deregister(HealthStatusProvider healthStatusProvider)

Deregisters a 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.

Parameters:

healthStatusProvider - The HealthStatusProvider to be deregistered.