Package io.helidon.microprofile.health

Class HealthEndpoint

java.lang.Object

io.helidon.microprofile.health.HealthEndpoint

@Path(value="/")
@RequestScoped
public class HealthEndpoint
extends java.lang.Object

A REST endpoint that implements the microprofile health specification. See https://github.com/eclipse/microprofile-health/blob/master/spec/src/main/asciidoc/protocol-wireformat.adoc

Constructor Summary

Constructors

Constructor and Description
HealthEndpoint(Instance<HealthCheck> healthCheckSource, java.util.List<java.lang.String> includedHealthChecks, java.util.List<java.lang.String> excludedHealthChecks) Creates a new HealthEndpoint.

Method Summary

Modifier and Type	Method and Description
Response	getHealth() Gets an HTTP Response in the form of JSON to a request for health.

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthEndpoint

@Inject
public HealthEndpoint(@Health
                      Instance<HealthCheck> healthCheckSource,
                      java.util.List<java.lang.String> includedHealthChecks,
                      java.util.List<java.lang.String> excludedHealthChecks)

Creates a new HealthEndpoint. The supplied healthCheckSource is used to get the list of HealthCheck objects. This list is dynamically constructed by the CDI engine based on which HealthCheck classes are annotated with "Health" and "ApplicationScoped" annotations.

Parameters:

healthCheckSource - The health checks as discovered by CDI

includedHealthChecks - The list of health checks that should be included. Anything not in this list is automatically excluded. Can have splat ('*')

excludedHealthChecks - The list of health checks to exclude.

Method Detail

getHealth

@GET
@Produces(value="application/json")
public Response getHealth()

Gets an HTTP Response in the form of JSON to a request for health.

Returns:

A non-null HTTP Response. May be 200, 500, or 503.