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

package org.apache.juneau.rest.server.health

Built-in health, readiness, and liveness probe support for Juneau REST servers.

Provides the HealthIndicator SPI for reporting per-component health, an HealthAggregator that combines results, and servlet, child-resource, and mixin flavors (HealthServlet, HealthResource, HealthMixin) that expose the probe endpoints.

Related Packages

Package	Description
org.apache.juneau.rest.server	REST Server API

Class	Description
Health	Component health result returned from a HealthIndicator.
Health.Builder	Builder for Health.
HealthAggregator	Shared health-probe aggregation worker bean.
HealthAggregator.ComponentHealth	Component payload in the response.
HealthAggregator.HealthResponse	Probe response payload.
HealthIndicator	Functional SPI for reporting health of one component.
HealthMixin	Mixin flavor of the built-in health/readiness/liveness probe capability.
HealthProbe	Probe categories supported by the built-in health probe resource.
HealthProbeSettings	Settings for the built-in health probe resource.
HealthProbeSettings.Builder	Builder for HealthProbeSettings.
HealthResource	Child-resource flavor of the built-in health/readiness/liveness probe capability.
HealthServlet	Servlet flavor of the built-in health/readiness/liveness probe capability.
HealthStatus	Status values returned by HealthIndicator checks.
ReadinessState	Shared, observable readiness flag consumed by HealthAggregator to gate the readiness probe.
ReadinessStateAware	Implemented by servlets that want to be told the embedded server's per-service ReadinessState, so they can react when shutdown begins (see ReadinessState.onOutOfService(Object, Runnable)).