Package org.forgerock.am.health

Contains consumable services and endpoints used for monitoring AMs health.

Interface Summary

Interface	Description
LivenessCheck	This interface defines the contract for checking whether an AM service or component is alive and able to function independent of the state of any 3rd party dependencies or whether the service or component has fallen over to the point of being beyond recovery.
ReadinessCheck	This interface defines the contract for checking whether an AM service or component is ready to service requests successfully, independent of the state of any 3rd party dependencies.

Class Summary

Class	Description
HealthCheckRestRouteProvider	A RestRouteProvider that add routes for the AM health check endpoints.
HealthGuiceModule	Guice module for binding together AM health services and endpoints.
LivenessCheckEndpoint	CHF endpoint that reports AMs liveness, pertaining to the characteristics laid out in the Kubernetes documentation for the liveness probe.
ReadinessCheckEndpoint	CHF endpoint that reports AMs readiness, pertaining to the characteristics laid out in the Kubernetes documentation for the readiness probe.