Package org.forgerock.am.health

Interface ReadinessCheck

public interface 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.

Implementations should take into account the considerations and best practices detailed around the kubernetes documentation for the readiness probe. This includes: checks should not lock or create any contention; checks should aim to complete in a timely fashion; and checks should avoid taking into account dependencies.

Since:
7.1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isReady()
    Checks whether an AM service or component is ready to service requests successfully.

  • Method Details

    • isReady

      boolean isReady()
      Checks whether an AM service or component is ready to service requests successfully.
      Returns:
      if an AM service or component is ready to service requests