org.jasig.cas.monitor
Class HealthCheckMonitor

java.lang.Object
  org.jasig.cas.monitor.HealthCheckMonitor

All Implemented Interfaces:

Monitor<HealthStatus>

public class HealthCheckMonitor
extends Object
implements Monitor<HealthStatus>

Simple health check monitor that reports the overall health as the greatest reported StatusCode of an arbitrary number of individual checks.

Since:

3.5.0

Author:

Marvin S. Addison

Constructor Summary

HealthCheckMonitor()

Method Summary

String	getName() Gets the name of the monitor.
HealthStatus	observe() Observes the monitored resource and reports the status.
void	setMonitors(Collection<Monitor> monitors) Sets the monitors that comprise the health check.

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckMonitor

public HealthCheckMonitor()

Method Detail

setMonitors

public void setMonitors(Collection<Monitor> monitors)

Sets the monitors that comprise the health check.

Parameters:

monitors - Collection of monitors responsible for observing various aspects of CAS.

getName

public String getName()

Gets the name of the monitor.

Specified by:

getName in interface Monitor<HealthStatus>

Returns:

Monitor name.

observe

public HealthStatus observe()

Observes the monitored resource and reports the status.

Specified by:

observe in interface Monitor<HealthStatus>

Returns:

Status of monitored resource.