Package org.springframework.geode.boot.actuate.health

Class AbstractGeodeHealthIndicator

java.lang.Object
org.springframework.boot.actuate.health.AbstractHealthIndicator
org.springframework.geode.boot.actuate.health.AbstractGeodeHealthIndicator
All Implemented Interfaces:
org.springframework.boot.actuate.health.HealthContributor, org.springframework.boot.actuate.health.HealthIndicator
Direct Known Subclasses:
GeodeAsyncEventQueuesHealthIndicator, GeodeCacheHealthIndicator, GeodeCacheServersHealthIndicator, GeodeContinuousQueriesHealthIndicator, GeodeDiskStoresHealthIndicator, GeodeGatewayReceiversHealthIndicator, GeodeGatewaySendersHealthIndicator, GeodeIndexesHealthIndicator, GeodePoolsHealthIndicator, GeodeRegionsHealthIndicator
public abstract class AbstractGeodeHealthIndicator extends org.springframework.boot.actuate.health.AbstractHealthIndicator
The AbstractGeodeHealthIndicator class is an abstract base class encapsulating functionality common to all Apache Geode HealthIndicator objects.
Since:
1.0.0
See Also:
  • GemFireCache
  • AbstractHealthIndicator
  • HealthIndicator

  • Field Details

  • Constructor Details

    • AbstractGeodeHealthIndicator

      public AbstractGeodeHealthIndicator(String healthCheckedFailedMessage)
      Default constructor to construct an uninitialized instance of AbstractGeodeHealthIndicator, which will not provide any health information.

    • AbstractGeodeHealthIndicator

      public AbstractGeodeHealthIndicator(org.apache.geode.cache.GemFireCache gemfireCache)
      Constructs an instance of the AbstractGeodeHealthIndicator initialized with a reference to the GemFireCache instance.
      Parameters:
      gemfireCache - reference to the GemFireCache instance used to collect health information.
      Throws:
      IllegalArgumentException - if GemFireCache is null.
      See Also:
      • GemFireCache

  • Method Details

    • getGemFireCache

      protected Optional<org.apache.geode.cache.GemFireCache> getGemFireCache()
      Returns a reference to the GemFireCache instance.
      Returns:
      a reference to the GemFireCache instance.
      See Also:
      • GemFireCache

    • nullSafeClassName

      protected String nullSafeClassName(Class<?> type)
      Determines the name of the Class type safely by handling null.
      Parameters:
      type - Class type to evaluate.
      Returns:
      the name of the Class type.
      See Also:

    • toYesNoString

      protected String toYesNoString(Boolean value)
      Converts a Boolean value into a yes / no String.
      Parameters:
      value - Boolean value to convert.
      Returns:
      a yes / no response for the given Boolean value.