Package org.keycloak.infinispan.health

Interface ClusterHealth

All Known Implementing Classes:
JdbcPingClusterHealthImpl
public interface ClusterHealth
Infinispan cluster health checks, to detect network partitions.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isHealthy()
    It checks the cluster health returning true if this node can continue processing requests.
    boolean
    isSupported()
    Determine if the cluster health check is supported.
    void
    triggerClusterHealthCheck()
    Triggers a cluster health check.

  • Method Details

    • isHealthy

      boolean isHealthy()
      It checks the cluster health returning true if this node can continue processing requests.

      If the network and cluster are stable, this method must return true.

      If a network partition is detected, the return value depends on whether this node belongs to the winning partition. It must return true if it belongs to the winning partition or false if it does not. Deciding the winning partition is at the implementation discretion.

      Returns:
      true if the cluster is healthy and this node can continue processing requests, false otherwise.

    • triggerClusterHealthCheck

      void triggerClusterHealthCheck()
      Triggers a cluster health check.

      This method should only trigger the health check logic without blocking or waiting for its outcome.

    • isSupported

      boolean isSupported()
      Determine if the cluster health check is supported.
      Returns:
      false if the current transport setup doesn't provide enough information.