Module com.erudika.para.server
Package com.erudika.para.server.utils

Enum HealthUtils

java.lang.Object
java.lang.Enum<HealthUtils>
com.erudika.para.server.utils.HealthUtils
All Implemented Interfaces:
InitializeListener, Serializable, Comparable<HealthUtils>, Runnable, EventListener
public enum HealthUtils extends Enum<HealthUtils> implements InitializeListener, Runnable
A utility for evaluating the health of the Para cluster.
Author:
Jeremy Wiesner [[email protected]]

  • 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 type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static HealthUtils valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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.