Package org.forgerock.openig.http

Class SystemHealth

java.lang.Object

org.forgerock.openig.http.SystemHealth

public class SystemHealth
extends Object

The overall health of the system as named HealthServices.

Constructor Summary

Constructors

Constructor	Description
SystemHealth(HealthProbe startedHealthService, HealthProbe readinessHealthService, HealthProbe livenessHealthService)	Creates a new instance of SystemHealth.

Method Summary

Modifier and Type	Method	Description
Handler	kubernetesProbes()	Returns a Handler that can be used as a Kubernetes liveness/readiness/startup probe.

Methods inherited from class java.lang.Object

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

Constructor Details

SystemHealth

public SystemHealth(HealthProbe startedHealthService,
 HealthProbe readinessHealthService,
 HealthProbe livenessHealthService)

Creates a new instance of SystemHealth.

Parameters:

startedHealthService - a probe that returns true when the application has started

readinessHealthService - a probe that returns true when the application is ready to serve requests

livenessHealthService - a probe that returns true when the application is alive

Method Details

kubernetesProbes

public Handler kubernetesProbes()

Returns a Handler that can be used as a Kubernetes liveness/readiness/startup probe.

Returns:

a Handler that can be used as a Kubernetes liveness/readiness/startup probe

See Also:

• Kubernetes Probes