Module com.erudika.para.server

Package com.erudika.para.server.utils

Enum Class HealthUtils

java.lang.Object

java.lang.Enum<HealthUtils>

com.erudika.para.server.utils.HealthUtils

All Implemented Interfaces:

com.erudika.para.core.listeners.InitializeListener, Serializable, Comparable<HealthUtils>, Constable, Runnable, EventListener

public enum HealthUtils
extends Enum<HealthUtils>
implements com.erudika.para.core.listeners.InitializeListener, Runnable

A utility for evaluating the health of the Para cluster.

Author:

Jeremy Wiesner [[email protected]]

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	Singleton.

Method Summary

Modifier and Type	Method	Description
static HealthUtils	getInstance()	Provides access to the singleton instance methods.
abstract boolean	isHealthy()	A method to query the general health of the Para server.
abstract void	performHealthCheck()	Evaluate the health of the Para server by querying the root app object from the database, search and cache.
static HealthUtils	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HealthUtils[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.erudika.para.core.listeners.InitializeListener

onInitialize

Methods inherited from interface java.lang.Runnable

run

Enum Constant Details

INSTANCE

public static final HealthUtils INSTANCE

Singleton.

Method Details

values

public static HealthUtils[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HealthUtils valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getInstance

public static HealthUtils getInstance()

Provides access to the singleton instance methods.

Returns:

an instance of this class

isHealthy

public abstract boolean isHealthy()

A method to query the general health of the Para server.

Returns:

true if server is healthy

performHealthCheck

public abstract void performHealthCheck()

Evaluate the health of the Para server by querying the root app object from the database, search and cache.