Package org.springframework.geode.boot.actuate

Class GeodeCacheHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.geode.boot.actuate.health.AbstractGeodeHealthIndicator

org.springframework.geode.boot.actuate.GeodeCacheHealthIndicator

All Implemented Interfaces:

org.springframework.boot.actuate.health.HealthContributor, org.springframework.boot.actuate.health.HealthIndicator

public class GeodeCacheHealthIndicator
extends AbstractGeodeHealthIndicator

The GeodeCacheHealthIndicator class is a Spring Boot HealthIndicator providing details about the health of the GemFireCache, the DistributedSystem, this DistributedMember and the ResourceManager.

Since:

1.0.0

See Also:

• URL
• Optional
• Function
• GemFireCache
• ResourceManager
• DistributedMember
• DistributedSystem
• Health
• HealthIndicator
• AbstractGeodeHealthIndicator

Field Summary

Fields inherited from class org.springframework.geode.boot.actuate.health.AbstractGeodeHealthIndicator

UNKNOWN

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	doHealthCheck(org.springframework.boot.actuate.health.Health.Builder builder)
protected Function<org.springframework.boot.actuate.health.Health.Builder,org.springframework.boot.actuate.health.Health.Builder>	getGemfireHealthIndicatorFunctions()	Return a collection of Functions that apply HealthIndicator information about the GemFireCache to the Health aggregate object.

Methods inherited from class org.springframework.geode.boot.actuate.health.AbstractGeodeHealthIndicator

getGemFireCache, nullSafeClassName, toYesNoString

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

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

Constructor Details

GeodeCacheHealthIndicator

public GeodeCacheHealthIndicator()

Default constructor to construct an uninitialized instance of GeodeCacheHealthIndicator, which will not provide any health information.

GeodeCacheHealthIndicator

public GeodeCacheHealthIndicator(org.apache.geode.cache.GemFireCache gemfireCache)

Constructs an instance of the GeodeCacheHealthIndicator 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

getGemfireHealthIndicatorFunctions

protected Function<org.springframework.boot.actuate.health.Health.Builder,org.springframework.boot.actuate.health.Health.Builder> getGemfireHealthIndicatorFunctions()

Return a collection of Functions that apply HealthIndicator information about the GemFireCache to the Health aggregate object.

Returns:

a collection of Functions applying HealthIndicator information about the GemFireCache to a Health object.

See Also:

• Health.Builder
• Function

doHealthCheck

protected void doHealthCheck(org.springframework.boot.actuate.health.Health.Builder builder)

Specified by:

doHealthCheck in class org.springframework.boot.actuate.health.AbstractHealthIndicator