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 Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	UNKNOWN

Constructor Summary

Constructors

Constructor and Description
AbstractGeodeHealthIndicator(org.apache.geode.cache.GemFireCache gemfireCache) Constructs an instance of the AbstractGeodeHealthIndicator initialized with a reference to the GemFireCache instance.
AbstractGeodeHealthIndicator(java.lang.String healthCheckedFailedMessage) Default constructor to construct an uninitialized instance of AbstractGeodeHealthIndicator, which will not provide any health information.

Method Summary

Modifier and Type	Method and Description
protected java.util.Optional<org.apache.geode.cache.GemFireCache>	getGemFireCache() Returns a reference to the GemFireCache instance.
protected java.lang.String	nullSafeClassName(java.lang.Class<?> type) Determines the name of the Class type safely by handling null.
protected java.lang.String	toYesNoString(java.lang.Boolean value) Converts a Boolean value into a yes / no String.

Methods inherited from class org.springframework.boot.actuate.health.AbstractHealthIndicator

doHealthCheck, health

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.actuate.health.HealthIndicator

getHealth

Field Detail

UNKNOWN

protected static final java.lang.String UNKNOWN

See Also:

Constant Field Values

Constructor Detail

AbstractGeodeHealthIndicator

public AbstractGeodeHealthIndicator(java.lang.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:

java.lang.IllegalArgumentException - if GemFireCache is null.

See Also:

GemFireCache

Method Detail

getGemFireCache

protected java.util.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 java.lang.String nullSafeClassName(java.lang.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:

Class.getName()

toYesNoString

protected java.lang.String toYesNoString(java.lang.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.