org.jasig.cas.monitor

Class ConnectionFactoryMonitor

java.lang.Object

org.jasig.cas.monitor.AbstractNamedMonitor<Status>

org.jasig.cas.monitor.ConnectionFactoryMonitor

All Implemented Interfaces:

Monitor<Status>

public class ConnectionFactoryMonitor
extends AbstractNamedMonitor<Status>

Monitors an ldaptive ConnectionFactory. While this class can be used with instances of PooledConnectionFactory, the PooledConnectionFactoryMonitor class is preferable.

Since:

4.0

Author:

Marvin S. Addison

Field Summary

Fields inherited from class org.jasig.cas.monitor.AbstractNamedMonitor

logger, name

Constructor Summary

Constructors

Constructor and Description
ConnectionFactoryMonitor(org.ldaptive.ConnectionFactory factory, org.ldaptive.pool.Validator<org.ldaptive.Connection> validator) Creates a new instance that monitors the given connection factory.

Method Summary

Methods

Modifier and Type	Method and Description
Status	observe() Gets a connection from the underlying connection factory and attempts to validate it.

Methods inherited from class org.jasig.cas.monitor.AbstractNamedMonitor

getName, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionFactoryMonitor

public ConnectionFactoryMonitor(org.ldaptive.ConnectionFactory factory,
                        org.ldaptive.pool.Validator<org.ldaptive.Connection> validator)

Creates a new instance that monitors the given connection factory.

Parameters:

factory - Connection factory to monitor.

validator - Validates connections from the factory.

Method Detail

observe

public Status observe()

Gets a connection from the underlying connection factory and attempts to validate it.

Returns:

Status with code StatusCode.OK on success otherwise StatusCode.ERROR.