org.jasig.cas.monitor
Class CacheStatus

java.lang.Object
  org.jasig.cas.monitor.Status
      org.jasig.cas.monitor.CacheStatus

public class CacheStatus
extends Status

Describes meaningful health metrics on the status of a cache.

Since:

3.5.1

Author:

Marvin S. Addison

Field Summary

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

ERROR, INFO, OK, UNKNOWN, WARN

Constructor Summary

CacheStatus(Exception e)
Creates a new instance when cache statistics are unavailable due to given exception.

CacheStatus(StatusCode code, String description, CacheStatistics... statistics)
Creates a new instance describing cache status.

Method Summary

CacheStatistics[]

getStatistics() Gets the current cache statistics.

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

getCode, getDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheStatus

public CacheStatus(StatusCode code,
                   String description,
                   CacheStatistics... statistics)

Creates a new instance describing cache status.

Parameters:

code - Status code.

description - Optional status description.

statistics - One or more sets of cache statistics.

CacheStatus

public CacheStatus(Exception e)

Creates a new instance when cache statistics are unavailable due to given exception.

Parameters:

e - Cause of unavailable statistics.

Method Detail

getStatistics

public CacheStatistics[] getStatistics()

Gets the current cache statistics.

Returns:

Cache statistics.