org.apereo.cas.monitor

Class Status

java.lang.Object

org.apereo.cas.monitor.Status

Direct Known Subclasses:

CacheStatus, HealthStatus, MemoryStatus, PoolStatus, SessionStatus

public class Status
extends java.lang.Object

Describes a generic status condition.

Since:

3.5.0

Field Summary

Fields

Modifier and Type	Field and Description
static Status	ERROR Generic ERROR status.
static Status	INFO Generic INFO status.
static Status	OK Generic OK status.
static Status	UNKNOWN Generic UNKNOWN status.
static Status	WARN Generic WARN status.

Constructor Summary

Constructors

Constructor and Description
Status(StatusCode code) Creates a new status object with the given code.
Status(StatusCode code, java.lang.String desc) Creates a new status object with the given code.

Method Summary

Modifier and Type	Method and Description
StatusCode	getCode() Gets the status code.
java.lang.String	getDescription()

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final Status UNKNOWN

Generic UNKNOWN status.

OK

public static final Status OK

Generic OK status.

INFO

public static final Status INFO

Generic INFO status.

WARN

public static final Status WARN

Generic WARN status.

ERROR

public static final Status ERROR

Generic ERROR status.

Constructor Detail

Status

public Status(StatusCode code)

Creates a new status object with the given code.

Parameters:

code - Status code.

See Also:

getCode()

Status

public Status(StatusCode code,
              java.lang.String desc)

Creates a new status object with the given code.

Parameters:

code - Status code.

desc - Human-readable status description.

See Also:

getCode()

Method Detail

getCode

public StatusCode getCode()

Gets the status code.

Returns:

Status code.

getDescription

public java.lang.String getDescription()

Returns:

Human-readable description of status.