Package org.forgerock.openig.health

Class BooleanProbe

java.lang.Object

org.forgerock.openig.health.BooleanProbe

All Implemented Interfaces:

HealthProbe

public class BooleanProbe
extends Object
implements HealthProbe

A simple HealthProbe that returns a boolean status.

Constructor Summary

Constructors

Constructor	Description
BooleanProbe(boolean initialStatus)	Creates a new instance of BooleanProbe.

Method Summary

Modifier and Type	Method	Description
void	ko()	Sets the status of the probe to false.
void	ok()	Sets the status of the probe to true.
boolean	status()	Returns the status of the probe.

Methods inherited from class java.lang.Object

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

Constructor Details

BooleanProbe

public BooleanProbe(boolean initialStatus)

Creates a new instance of BooleanProbe.

Parameters:

initialStatus - the initial status of the probe

Method Details

status

public boolean status()

Description copied from interface: HealthProbe

Returns the status of the probe.

Specified by:

status in interface HealthProbe

Returns:

true if the probe is healthy, false otherwise

ok

public void ok()

Sets the status of the probe to true.

ko

public void ko()

Sets the status of the probe to false.