Package org.forgerock.openig.health

Interface HealthProbe

All Known Subinterfaces:
HealthService
All Known Implementing Classes:
BooleanProbe
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface HealthProbe
A HealthProbe is a simple interface that returns a boolean status.

This can be used to return the health of a service.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    status()
    Returns the status of the probe.

  • Method Details

    • status

      boolean status()
      Returns the status of the probe.
      Returns:
      true if the probe is healthy, false otherwise