org.apereo.cas.monitor

Class AbstractCacheHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.apereo.cas.monitor.AbstractCacheHealthIndicator

All Implemented Interfaces:

org.springframework.boot.actuate.health.HealthIndicator

Direct Known Subclasses:

EhCacheHealthIndicator, HazelcastHealthIndicator, MemcachedHealthIndicator, MongoDbHealthIndicator

public abstract class AbstractCacheHealthIndicator
extends org.springframework.boot.actuate.health.AbstractHealthIndicator

Abstract base class for monitors that observe cache storage systems.

Since:

3.5.1

Field Summary

Fields

Modifier and Type	Field and Description
protected CasConfigurationProperties	casProperties CAS settings.

Constructor Summary

Constructors

Constructor and Description
AbstractCacheHealthIndicator()

Method Summary

Modifier and Type	Method and Description
protected void	doHealthCheck(org.springframework.boot.actuate.health.Health.Builder builder)
protected abstract CacheStatistics[]	getStatistics() Gets the statistics from this monitor.
protected org.springframework.boot.actuate.health.Status	status(CacheStatistics statistics) Computes the status code for a given set of cache statistics.

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

Field Detail

casProperties

protected final CasConfigurationProperties casProperties

CAS settings.

Constructor Detail

AbstractCacheHealthIndicator

public AbstractCacheHealthIndicator()

Method Detail

doHealthCheck

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

Specified by:

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

getStatistics

protected abstract CacheStatistics[] getStatistics()

Gets the statistics from this monitor.

Returns:

the statistics

status

protected org.springframework.boot.actuate.health.Status status(CacheStatistics statistics)

Computes the status code for a given set of cache statistics.

Parameters:

statistics - Cache statistics.

Returns:

WARN or OUT_OF_SERVICE OR UP.