Package org.springframework.geode.boot.actuate

Class GeodeRegionsHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

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

org.springframework.geode.boot.actuate.GeodeRegionsHealthIndicator

All Implemented Interfaces:

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

public class GeodeRegionsHealthIndicator
extends AbstractGeodeHealthIndicator

The GeodeRegionsHealthIndicator class is a Spring Boot HealthIndicator providing details about the health of the GemFireCache Regions.

Since:

1.0.0

See Also:

• GemFireCache
• Region
• Health
• HealthIndicator
• AbstractGeodeHealthIndicator

Field Summary

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

UNKNOWN

Constructor Summary

Constructors

Constructor	Description
GeodeRegionsHealthIndicator()	Default constructor to construct an uninitialized instance of GeodeRegionsHealthIndicator, which will not provide any health information.
GeodeRegionsHealthIndicator(org.apache.geode.cache.GemFireCache gemfireCache)	Constructs an instance of the GeodeRegionsHealthIndicator 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 BiConsumer<org.apache.geode.cache.Region<?,?>,org.springframework.boot.actuate.health.Health.Builder>	getGemfireRegionHealthIndicatorConsumers()	Returns the collection of BiConsumer objects that applies health details about the GemFireCache Regions to the Health 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

GeodeRegionsHealthIndicator

public GeodeRegionsHealthIndicator()

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

GeodeRegionsHealthIndicator

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

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

getGemfireRegionHealthIndicatorConsumers

protected BiConsumer<org.apache.geode.cache.Region<?,?>,org.springframework.boot.actuate.health.Health.Builder> getGemfireRegionHealthIndicatorConsumers()

Returns the collection of BiConsumer objects that applies health details about the GemFireCache Regions to the Health object.

Returns:

the collection of BiConsumer objects that applies health details about the GemFireCache Regions to the Health object.

See Also:

• Health
• Region
• BiConsumer

doHealthCheck

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

Specified by:

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