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

Class HealthAggregator

java.lang.Object

org.apache.juneau.rest.server.health.HealthAggregator

public class HealthAggregator
extends Object

Shared health-probe aggregation worker bean.

Holds the capability logic for evaluating HealthIndicator beans and summarizing them into a probe response. The HealthServlet (servlet flavor) and HealthMixin (mixin flavor) are independent @Rest classes that each delegate to a HealthAggregator, so the two deployment forms cannot drift.

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HealthAggregator.ComponentHealth	Component payload in the response.
static class	HealthAggregator.HealthResponse	Probe response payload.

Constructor Summary

Constructors

Constructor	Description
HealthAggregator()

Method Summary

Modifier and Type	Method	Description
HealthAggregator.HealthResponse	aggregate(RestContext context, Map<String,HealthIndicator> indicators, HealthProbe probe, RestResponse res)	Evaluates the supplied indicators, summarizes their statuses, and sets the response status.
Map<String,HealthIndicator>	indicators(RestContext context)	Resolves the HealthIndicator beans registered in the given context's bean store.

Methods inherited from class java.lang.Object

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

Constructor Details

HealthAggregator

public HealthAggregator()

Method Details

indicators

public Map<String,HealthIndicator> indicators(RestContext context)

Resolves the HealthIndicator beans registered in the given context's bean store.

Parameters:

context - The REST context whose bean store supplies the indicators.

Returns:

The indicator beans keyed by bean name.

aggregate

public HealthAggregator.HealthResponse aggregate(RestContext context,
 Map<String,HealthIndicator> indicators,
 HealthProbe probe,
 RestResponse res)

Evaluates the supplied indicators, summarizes their statuses, and sets the response status.

Parameters:

context - The REST context (supplies the HealthProbeSettings timeout).

indicators - The indicators to evaluate.

probe - The probe filter, or null to evaluate all indicators.

res - The response whose status code is set (200 healthy, 503 down).

Returns:

The aggregated health payload.