org.kuali.rice.web.health

Class HealthStatus

java.lang.Object

org.kuali.rice.web.health.HealthStatus

public class HealthStatus
extends Object

Indicates the health status of the application. Can be one of either OK or FAILED. This class is designed to be serializable to JSON if using the Jackson library.

Author:

Eric Westfall

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAILED
static String	OK

Constructor Summary

Constructors

Constructor and Description
HealthStatus()
HealthStatus(String statusCode)

Method Summary

Modifier and Type	Method and Description
void	appendMessage(String metricName, String message)
String	getMessage()
List<HealthMetric>	getMetrics()
String	getStatusCode()
boolean	isOk()
void	setMessage(String message)
void	setMetrics(List<HealthMetric> metrics)
void	setStatusCode(String statusCode)

Methods inherited from class java.lang.Object

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

Field Detail

OK

public static final String OK

See Also:

Constant Field Values

FAILED

public static final String FAILED

See Also:

Constant Field Values

Constructor Detail

HealthStatus

public HealthStatus()

HealthStatus

public HealthStatus(String statusCode)

Method Detail

isOk

public boolean isOk()

getStatusCode

public String getStatusCode()

setStatusCode

public void setStatusCode(String statusCode)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getMetrics

public List<HealthMetric> getMetrics()

setMetrics

public void setMetrics(List<HealthMetric> metrics)

appendMessage

public void appendMessage(String metricName,
                          String message)