org.opends.server.monitors

Class HealthStatus

java.lang.Object

org.opends.server.monitors.HealthStatus

public final class HealthStatus
extends Object

An unmodifiable health diagnostic.

Method Summary

Modifier and Type	Method and Description
static HealthStatus	aliveAndHealthy() Returns the ALIVE and HEALTHY HealthStatus.
static HealthStatus	combine(HealthStatus healthStatus1, HealthStatus healthStatus2) Creates a new HealthStatus by combining the provided HealthStatus errors.
List<LocalizableMessage>	getAliveErrors() Returns the list of serious errors.
List<LocalizableMessage>	getHealthyErrors() Returns the list of transient errors.
boolean	isAlive() Returns true if there are no serious errors as provided by getAliveErrors(), false otherwise.
boolean	isHealthy() Returns true if there are no serious errors as provided by getAliveErrors() nor transient errors as provided by getHealthyErrors(), false otherwise.
static HealthStatus	notAlive(List<LocalizableMessage> errors) Returns a NOT_ALIVE HealthStatus.
static HealthStatus	notAlive(LocalizableMessage error) Returns a NOT_ALIVE HealthStatus.
static HealthStatus	notHealthy(List<LocalizableMessage> errors) Returns a NOT_HEALTHY HealthStatus.
static HealthStatus	notHealthy(LocalizableMessage error) Returns a NOT_HEALTHY HealthStatus.

Methods inherited from class java.lang.Object

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

Method Detail

aliveAndHealthy

public static HealthStatus aliveAndHealthy()

Returns the ALIVE and HEALTHY HealthStatus.

Returns:

the ALIVE and HEALTHY HealthStatus.

notAlive

public static HealthStatus notAlive(LocalizableMessage error)

Returns a NOT_ALIVE HealthStatus.

Parameters:

error - A LocalizableMessage describing the serious error.

Returns:

A NOT_ALIVE HealthStatus.

notHealthy

public static HealthStatus notHealthy(LocalizableMessage error)

Returns a NOT_HEALTHY HealthStatus.

Parameters:

error - A LocalizableMessage describing the transient error.

Returns:

A NOT_HEALTHY HealthStatus.

notAlive

public static HealthStatus notAlive(List<LocalizableMessage> errors)

Returns a NOT_ALIVE HealthStatus.

Parameters:

errors - A non-empty list of messages describing the serious errors.

Returns:

A NOT_ALIVE HealthStatus.

notHealthy

public static HealthStatus notHealthy(List<LocalizableMessage> errors)

Returns a NOT_HEALTHY HealthStatus.

Parameters:

errors - A non-empty list of messages describing the transient errors.

Returns:

A NOT_HEALTHY HealthStatus.

combine

public static HealthStatus combine(HealthStatus healthStatus1,
                                   HealthStatus healthStatus2)

Creates a new HealthStatus by combining the provided HealthStatus errors.

Parameters:

healthStatus1 - The first health status to be combined.

healthStatus2 - The second health status to be combined.

Returns:

The combination of the provided health statuses.

isAlive

public boolean isAlive()

Returns true if there are no serious errors as provided by getAliveErrors(), false otherwise.

Returns:

true if there are no serious errors, false otherwise.

isHealthy

public boolean isHealthy()

Returns true if there are no serious errors as provided by getAliveErrors() nor transient errors as provided by getHealthyErrors(), false otherwise.

Returns:

true if there are no serious errors nor transient errors, false otherwise.

getAliveErrors

public List<LocalizableMessage> getAliveErrors()

Returns the list of serious errors.

Returns:

The list of serious errors.

getHealthyErrors

public List<LocalizableMessage> getHealthyErrors()

Returns the list of transient errors.

Returns:

The list of transient errors.