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

Class HealthResource

java.lang.Object
org.apache.juneau.rest.server.servlet.RestResource
org.apache.juneau.rest.server.servlet.BasicRestResource
org.apache.juneau.rest.server.health.HealthResource
All Implemented Interfaces:
BasicUniversalConfig, DefaultConfig, DefaultHtmlConfig
public class HealthResource extends BasicRestResource
Child-resource flavor of the built-in health/readiness/liveness probe capability.

Mounts as a routed child via @Rest(children=HealthResource.class) under a parent at the subtree /health and serves the /healthz, /readyz, and /livez probe endpoints by delegating to a shared HealthAggregator worker bean — the same logic the servlet and mixin flavors use, so the three forms cannot drift.

Indicators are resolved from the host's bean store, so a host registers its own HealthIndicator beans (e.g. via Spring @Bean or a Juneau BeanStore).

Extends BasicRestResource — the child-flavor mirror of BasicRestServlet that the HealthServlet servlet flavor extends — so the HealthAggregator.HealthResponse bean returned by the probe ops is serialized out of the box via the BasicUniversalConfig serializer set (JSON/XML/HTML/…). A bare RestResource child would carry no serializers and force every consumer to re-declare one; deriving from BasicRestResource keeps the child flavor at parity with its servlet twin.

See Also:
Since:
10.0.0