org.apereo.cas.monitor

Class PooledLdapConnectionFactoryHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.apereo.cas.monitor.AbstractPoolHealthIndicator

org.apereo.cas.monitor.PooledLdapConnectionFactoryHealthIndicator

All Implemented Interfaces:

org.springframework.boot.actuate.health.HealthIndicator

public class PooledLdapConnectionFactoryHealthIndicator
extends AbstractPoolHealthIndicator

Monitors an ldaptive PooledConnectionFactory.

Since:

4.0.0

Constructor Summary

Constructors

Constructor and Description
PooledLdapConnectionFactoryHealthIndicator(long maxWait, org.ldaptive.pool.PooledConnectionFactory factory, java.util.concurrent.ExecutorService executor, org.ldaptive.pool.Validator<org.ldaptive.Connection> validator)

Method Summary

Modifier and Type	Method and Description
protected 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 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.apereo.cas.monitor.AbstractPoolHealthIndicator

doHealthCheck

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

PooledLdapConnectionFactoryHealthIndicator

public PooledLdapConnectionFactoryHealthIndicator(long maxWait,
                                                  org.ldaptive.pool.PooledConnectionFactory factory,
                                                  java.util.concurrent.ExecutorService executor,
                                                  org.ldaptive.pool.Validator<org.ldaptive.Connection> validator)

Method Detail

checkPool

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

Description copied from class: AbstractPoolHealthIndicator

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.

Specified by:

checkPool in class AbstractPoolHealthIndicator

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()

Description copied from class: AbstractPoolHealthIndicator

Gets the number of pool resources idle at present.

Overrides:

getIdleCount in class AbstractPoolHealthIndicator

Returns:

Number of idle pool resources.

getActiveCount

protected int getActiveCount()

Description copied from class: AbstractPoolHealthIndicator

Gets the number of pool resources active at present.

Overrides:

getActiveCount in class AbstractPoolHealthIndicator

Returns:

Number of active pool resources.