org.apache.polygene.api.metrics

Class MetricsHealthCheck.Result

java.lang.Object

org.apache.polygene.api.metrics.MetricsHealthCheck.Result

Enclosing interface:

MetricsHealthCheck

public static final class MetricsHealthCheck.Result
extends Object

Method Summary

Modifier and Type	Method and Description
static MetricsHealthCheck.Result	exception(String message, Throwable exception) Factory method for reporting a state where an exception has occurred.
Throwable	getException()
String	getMessage()
static MetricsHealthCheck.Result	healthOk() Factory method for reporting an Ok health.
boolean	isHealthy()
static MetricsHealthCheck.Result	unhealthy(String message) Factory method for reporting an unhealthy state.

Methods inherited from class java.lang.Object

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

Method Detail

healthOk

public static MetricsHealthCheck.Result healthOk()

Factory method for reporting an Ok health.

Returns:

A healthy result.

unhealthy

public static MetricsHealthCheck.Result unhealthy(String message)

Factory method for reporting an unhealthy state.

Parameters:

message - The message to relay in the result.

Returns:

An unhealthy result.

exception

public static MetricsHealthCheck.Result exception(String message,
                                                  Throwable exception)

Factory method for reporting a state where an exception has occurred.

Parameters:

message - The message to relay in the result.

exception - the exception that has occurred.

Returns:

A failing health state.

isHealthy

public boolean isHealthy()

getMessage

public String getMessage()

getException

public Throwable getException()