Package org.forgerock.openig.health

Interface HealthService

All Superinterfaces:

HealthProbe

public interface HealthService
extends HealthProbe

A HealthService is a HealthProbe that can register other HealthProbes.

The status of the HealthService is true if the status of all registered probes is true.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HealthService.ProbeRegistration	A handle to unregister a HealthProbe from a HealthService.

Method Summary

Modifier and Type	Method	Description
static HealthService	multiProbeHealthService()	Returns an implementation of the HealthService based on a list of registered probed.
HealthService.ProbeRegistration	register(HealthProbe probe)	Registers a HealthProbe to this HealthService.
static HealthService	singleProbeHealthService(HealthProbe probe)	Returns an implementation of the HealthService that can't be updated with additional probes and has a status that is based only on the status of a single HealthProbe.

Methods inherited from interface org.forgerock.openig.health.HealthProbe

status

Method Details

register

HealthService.ProbeRegistration register(HealthProbe probe)

Registers a HealthProbe to this HealthService.

Parameters:

probe - the HealthProbe to register

Returns:

a HealthService.ProbeRegistration that can be used to unregister the probe

singleProbeHealthService

static HealthService singleProbeHealthService(HealthProbe probe)

Returns an implementation of the HealthService that can't be updated with additional probes and has a status that is based only on the status of a single HealthProbe.

Parameters:

probe - the single HealthProbe to use for the status of the service

Returns:

a new HealthService

multiProbeHealthService

static HealthService multiProbeHealthService()

Returns an implementation of the HealthService based on a list of registered probed. When no probes are registered, the status is always false.

Returns:

a new HealthService