org.springframework.boot.actuate.health

Class Health

java.lang.Object

org.springframework.boot.actuate.health.Health

public final class Health
extends Object

Carries information about the health of a component or subsystem.

Health contains a Status to express the state of a component or subsystem and some additional details to carry some contextual information.

Health has a fluent API to make it easy to construct instances. Typical usage in a HealthIndicator would be:

 try {
        // do some test to determine state of component
        return Health.up("version", "1.1.2");
 }
 catch (Exception ex) {
        return Health.down(ex);
 }
 

Since:

1.1.0

Author:

Christian Dupuis, Phillip Webb

Constructor Summary

Constructors

Constructor and Description
Health(Status status, Map<String,?> details) Create a new Health instance with the specified status and details.

Method Summary

Methods

Modifier and Type	Method and Description
static Health	down() Create a new Health instance with a Status.DOWN status.
static Health	down(Exception ex) Create a new Health instance with an Status.DOWN status an the specified exception details.
boolean	equals(Object obj)
Map<String,Object>	getDetails()
Status	getStatus()
int	hashCode()
static Health	outOfService() Create a new Health instance with an Status.OUT_OF_SERVICE status.
static Health	status(Status status) Create a new Health instance with a specific Status.
static Health	status(String statusCode) Create a new Health instance with a specific status code.
String	toString()
static Health	unknown() Create a new Health instance with an Status.UNKNOWN status.
static Health	up() Create a new Health instance with an Status.UP status.
Health	withDetail(String key, Object data) Create a new Health object from this one, containing an additional detail.
Health	withException(Exception ex) Create a new Health object from this one, containing an additional exception detail.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Health

public Health(Status status,
      Map<String,?> details)

Create a new Health instance with the specified status and details.

Parameters:

status - the status

details - the details or null

Method Detail

getStatus

public Status getStatus()

Returns:

the status of the health (never null)

getDetails

public Map<String,Object> getDetails()

Returns:

the details of the health or an empty map.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

withException

public Health withException(Exception ex)

Create a new Health object from this one, containing an additional exception detail.

Parameters:

ex - the exception

Returns:

a new Health instance

withDetail

public Health withDetail(String key,
                Object data)

Create a new Health object from this one, containing an additional detail.

Parameters:

key - the detail key

data - the detail data

Returns:

a new Health instance

unknown

public static Health unknown()

Create a new Health instance with an Status.UNKNOWN status.

Returns:

a new Health instance

up

public static Health up()

Create a new Health instance with an Status.UP status.

Returns:

a new Health instance

down

public static Health down(Exception ex)

Create a new Health instance with an Status.DOWN status an the specified exception details.

Parameters:

ex - the exception

Returns:

a new Health instance

down

public static Health down()

Create a new Health instance with a Status.DOWN status.

Returns:

a new Health instance

outOfService

public static Health outOfService()

Create a new Health instance with an Status.OUT_OF_SERVICE status.

Returns:

a new Health instance

status

public static Health status(String statusCode)

Create a new Health instance with a specific status code.

Returns:

a new Health instance

status

public static Health status(Status status)

Create a new Health instance with a specific Status.

Returns:

a new Health instance