org.wisdom.monitor.extensions.dashboard

Class HealthState

java.lang.Object

org.wisdom.monitor.extensions.dashboard.HealthState

class HealthState
extends Object

Represents the result of a health check. A health check denotes the status of a part of the system. When a health check returns a KO state, the system does not operate correctly.

Field Summary

Fields

Modifier and Type	Field and Description
Exception	error The error associated with a KO state.
boolean	ok Is the state OK or KO.

Constructor Summary

Constructors

Constructor and Description
HealthState(boolean ok, Exception error) Creates a new instance of Health State.

Method Summary

Modifier and Type	Method and Description
static HealthState	ko() Creates a new KO Health State instance, without any information about the failure.
static HealthState	ko(Exception e) Creates a new KO Health State instance with an exception attached.
static HealthState	ok() Creates a new OK Health State instance.

Methods inherited from class java.lang.Object

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

Field Detail

ok

public final boolean ok

Is the state OK or KO.

error

public final Exception error

The error associated with a KO state.

Constructor Detail

HealthState

HealthState(boolean ok,
            Exception error)

Creates a new instance of Health State.

Parameters:

ok - whether or not the health is ok

error - an optional error when the health check is KO.

Method Detail

ok

public static HealthState ok()

Creates a new OK Health State instance.

Returns:

the new instance.

ko

public static HealthState ko()

Creates a new KO Health State instance, without any information about the failure.

Returns:

the new instance.

ko

public static HealthState ko(Exception e)

Creates a new KO Health State instance with an exception attached.

Parameters:

e - the exception

Returns:

the new instance.