Package org.apache.juneau.rest.server.health

Class Health

java.lang.Object

org.apache.juneau.rest.server.health.Health

public final class Health
extends Object

Component health result returned from a HealthIndicator.

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Health.Builder	Builder for Health.

Method Summary

Modifier and Type	Method	Description
static Health.Builder	down(String name, Throwable error)	Creates an HealthStatus.DOWN builder.
Map<String,Object>	getDetails()
Throwable	getError()
String	getName()
HealthStatus	getStatus()
static Health.Builder	unknown(String name)	Creates an HealthStatus.UNKNOWN builder.
static Health.Builder	up(String name)	Creates an HealthStatus.UP builder.

Methods inherited from class java.lang.Object

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

Method Details

up

public static Health.Builder up(String name)

Creates an HealthStatus.UP builder.

Parameters:

name - Component name. Must not be null or empty.

Returns:

A new builder.

down

public static Health.Builder down(String name,
 Throwable error)

Creates an HealthStatus.DOWN builder.

Parameters:

name - Component name. Must not be null or empty.

error - Optional error causing the down state. Can be null (no error is recorded).

Returns:

A new builder.

unknown

public static Health.Builder unknown(String name)

Creates an HealthStatus.UNKNOWN builder.

Parameters:

name - Component name. Must not be null or empty.

Returns:

A new builder.

getName

public String getName()

Returns:

Component name.

getStatus

public HealthStatus getStatus()

Returns:

Health status.

getDetails

public Map<String,Object> getDetails()

Returns:

Structured details map.

getError

public Throwable getError()

Returns:

Optional error.