org.apereo.cas.monitor

Class AbstractPoolHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.apereo.cas.monitor.AbstractPoolHealthIndicator

All Implemented Interfaces:

org.springframework.boot.actuate.health.HealthIndicator

Direct Known Subclasses:

JdbcDataSourceHealthIndicator, PooledLdapConnectionFactoryHealthIndicator

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

Describes a monitor that observes a pool of resources.

Since:

3.5.0

Constructor Summary

Constructors

Constructor and Description
AbstractPoolHealthIndicator()

Method Summary

Modifier and Type	Method and Description
protected abstract org.springframework.boot.actuate.health.Health.Builder	checkPool(org.springframework.boot.actuate.health.Health.Builder builder) Performs a health check on a the pool.
protected void	doHealthCheck(org.springframework.boot.actuate.health.Health.Builder builder)
protected int	getActiveCount() Gets the number of pool resources active at present.
protected int	getIdleCount() Gets the number of pool resources idle at present.

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

Constructor Detail

AbstractPoolHealthIndicator

public AbstractPoolHealthIndicator()

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

checkPool

protected abstract org.springframework.boot.actuate.health.Health.Builder checkPool(org.springframework.boot.actuate.health.Health.Builder builder)
                                                                             throws java.lang.Exception

Performs a health check on a the pool. The recommended implementation is to obtain a pool resource, validate it, and return it to the pool.

Parameters:

builder - the builder

Returns:

Status code describing pool health.

Throws:

java.lang.Exception - Thrown to indicate a serious problem with pool validation.

getIdleCount

protected int getIdleCount()

Gets the number of pool resources idle at present.

Returns:

Number of idle pool resources.

getActiveCount

protected int getActiveCount()

Gets the number of pool resources active at present.

Returns:

Number of active pool resources.