Package org.forgerock.am.health

Class LivenessCheckEndpoint

java.lang.Object

org.forgerock.am.health.LivenessCheckEndpoint

public class LivenessCheckEndpoint
extends Object

CHF endpoint that reports AMs liveness, pertaining to the characteristics laid out in the Kubernetes documentation for the liveness probe. This endpoint calls out to the HealthCheckService to ascertain whether AM is alive.

Since:

7.1.0

Constructor Summary

Constructors

Constructor	Description
LivenessCheckEndpoint(org.forgerock.am.health.HealthCheckService service)	Creates a new instance of the liveness endpoint.

Method Summary

Modifier and Type	Method	Description
Response	isAlive()	Checks whether the AM instance is alive.

Methods inherited from class java.lang.Object

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

Constructor Details

LivenessCheckEndpoint

@Inject
public LivenessCheckEndpoint(org.forgerock.am.health.HealthCheckService service)

Creates a new instance of the liveness endpoint.

Parameters:

service - the health check service

Method Details

isAlive

public Response isAlive()

Checks whether the AM instance is alive.

Returns:

the liveness status of the AM instance