ReadinessCheckEndpoint (OpenAM Server Only 7.3.1 Documentation)

java.lang.Object
- org.forgerock.am.health.ReadinessCheckEndpoint

```
public class ReadinessCheckEndpoint
extends Object
```
CHF endpoint that reports AMs readiness, pertaining to the characteristics laid out in the Kubernetes documentation for the readiness probe. This endpoint calls out to the HealthCheckService to ascertain whether AM is ready.

Since:

7.1.0

- Constructor Summary
  
  Constructors
  Constructor Description
  
  ReadinessCheckEndpoint(org.forgerock.am.health.HealthCheckService service)
  Creates a new instance of the readiness endpoint.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Response isReady()
  Checks the AM instance is ready.
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReadinessCheckEndpoint
```
@Inject
public ReadinessCheckEndpoint(org.forgerock.am.health.HealthCheckService service)
```
    Creates a new instance of the readiness endpoint.
    
    Parameters:
    
    service - the health check service
- Method Detail
  - isReady
```
public Response isReady()
```
    Checks the AM instance is ready.
    
    Returns:
    
    the readiness status of the AM instance