Package org.eclipse.microprofile.health

Class HealthCheckResponse

java.lang.Object

org.eclipse.microprofile.health.HealthCheckResponse

public abstract class HealthCheckResponse
extends Object

The response to a health check invocation.

The HealthCheckResponse class is reserved for an extension by implementation providers. An application should use one of the static methods to create a Response instance using a HealthCheckResponseBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HealthCheckResponse.State

Constructor Summary

Constructors

Constructor	Description
HealthCheckResponse()

Method Summary

Modifier and Type	Method	Description
static HealthCheckResponseBuilder	builder()
abstract Optional<Map<String,Object>>	getData()
abstract String	getName()
abstract HealthCheckResponse.State	getState()
static HealthCheckResponseBuilder	named(String name)
static void	setResponseProvider(HealthCheckResponseProvider provider)	Used by OSGi environment while service loader pattern is not supported.

Methods inherited from class java.lang.Object

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

Constructor Details

HealthCheckResponse

public HealthCheckResponse()

Method Details

setResponseProvider

public static void setResponseProvider(HealthCheckResponseProvider provider)

Used by OSGi environment while service loader pattern is not supported.

Parameters:

provider - the provider instance to use.

named

public static HealthCheckResponseBuilder named(String name)

builder

public static HealthCheckResponseBuilder builder()

getName

public abstract String getName()

getState

public abstract HealthCheckResponse.State getState()

getData

public abstract Optional<Map<String,Object>> getData()