Package org.eclipse.microprofile.health
Class HealthCheckResponse
- java.lang.Object
-
- org.eclipse.microprofile.health.HealthCheckResponse
-
public class HealthCheckResponse extends java.lang.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 aHealthCheckResponseBuilder
. When used on the consuming end, The class can also be instantiated directly.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HealthCheckResponse.State
-
Constructor Summary
Constructors Constructor Description HealthCheckResponse()
Default constructorHealthCheckResponse(java.lang.String name, HealthCheckResponse.State state, java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> data)
Constructor allowing instantiation from 3rd party framework like MicroProfile Rest client
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HealthCheckResponseBuilder
builder()
Creates an emptyHealthCheckResponseBuilder
.static HealthCheckResponse
down(java.lang.String name)
Creates a failed health check with a name.java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>
getData()
java.lang.String
getName()
HealthCheckResponse.State
getState()
static HealthCheckResponseBuilder
named(java.lang.String name)
Creates aHealthCheckResponseBuilder
with a name.static void
setResponseProvider(HealthCheckResponseProvider provider)
Used by OSGi environment where the service loader pattern is not supported.static HealthCheckResponse
up(java.lang.String name)
Creates a successful health check with a name.
-
-
-
Constructor Detail
-
HealthCheckResponse
public HealthCheckResponse(java.lang.String name, HealthCheckResponse.State state, java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> data)
Constructor allowing instantiation from 3rd party framework like MicroProfile Rest client- Parameters:
name
- Health Check procedure's namestate
- Health Check procedure's statedata
- additional data for Health Check procedure
-
HealthCheckResponse
public HealthCheckResponse()
Default constructor
-
-
Method Detail
-
setResponseProvider
public static void setResponseProvider(HealthCheckResponseProvider provider)
Used by OSGi environment where the service loader pattern is not supported.- Parameters:
provider
- the provider instance to use.
-
named
public static HealthCheckResponseBuilder named(java.lang.String name)
Creates aHealthCheckResponseBuilder
with a name.- Parameters:
name
- the check name- Returns:
- a new health check builder with a name
-
builder
public static HealthCheckResponseBuilder builder()
Creates an emptyHealthCheckResponseBuilder
. Note: The health check response name is required and needs to be set before the response is constructed.- Returns:
- a new, empty health check builder
-
up
public static HealthCheckResponse up(java.lang.String name)
Creates a successful health check with a name.- Parameters:
name
- the check name- Returns:
- a new sucessful health check response with a name
-
down
public static HealthCheckResponse down(java.lang.String name)
Creates a failed health check with a name.- Parameters:
name
- the check name- Returns:
- a new failed health check response with a name
-
getName
public java.lang.String getName()
-
getState
public HealthCheckResponse.State getState()
-
getData
public java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getData()
-
-