com.cerner.beadledom.health

Class HealthStatus

java.lang.Object

com.cerner.beadledom.health.HealthStatus

public abstract class HealthStatus
extends Object

Represents the result of checking a service dependency's health.

Constructor Summary

Constructors

Constructor and Description
HealthStatus()

Method Summary

Modifier and Type	Method and Description
static HealthStatus	create(int status, String message) Create an instance with the given message and status code.
static HealthStatus	create(int status, String message, Throwable exception) Create an instance with the given message, status code, and exception.
abstract Optional<Throwable>	getException() Returns the health check exception, or Optional.empty() if no exception occurred.
abstract String	getMessage() Returns a description of the status of the dependency (eg.
abstract int	getStatus() Returns the HTTP status code returned by the dependency, as seen from the location of the health check resource (eg.

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthStatus

public HealthStatus()

Method Detail

create

public static HealthStatus create(int status,
                                  String message)

Create an instance with the given message and status code.

create

public static HealthStatus create(int status,
                                  String message,
                                  Throwable exception)

Create an instance with the given message, status code, and exception.

getMessage

public abstract String getMessage()

Returns a description of the status of the dependency (eg. `"example-service is available"`)

getStatus

public abstract int getStatus()

Returns the HTTP status code returned by the dependency, as seen from the location of the health check resource (eg. `200`).

For dependencies without an HTTP health check, this should simulate what such a health check would return - e.g. 200 for healthy, 503 for unavailable.

getException

public abstract Optional<Throwable> getException()

Returns the health check exception, or Optional.empty() if no exception occurred.