Package org.keycloak.cluster.infinispan

Class DatabaseAwareClusterProvider

java.lang.Object
org.keycloak.cluster.infinispan.DatabaseAwareClusterProvider
All Implemented Interfaces:
ClusterProvider, Provider
public class DatabaseAwareClusterProvider extends Object implements ClusterProvider
Wraps an InfinispanClusterProvider and additionally persists events to the database for cross-cluster communication.
Author:
Alexander Schwartz

  • Constructor Details

  • Method Details

    • getClusterStartupTime

      public int getClusterStartupTime()
      Description copied from interface: ClusterProvider
      Same value for all cluster nodes. It will use startup time of this server in non-cluster environment.
      Specified by:
      getClusterStartupTime in interface ClusterProvider

    • executeIfNotExecuted

      public <T> ExecutionResult<T> executeIfNotExecuted(String taskKey, int taskTimeoutInSeconds, Callable<T> task)
      Description copied from interface: ClusterProvider
      Execute given task just if it's not already in progress (either on this or any other cluster node).
      Specified by:
      executeIfNotExecuted in interface ClusterProvider
      taskTimeoutInSeconds - timeout for given task. If there is existing task in progress for longer time, it's considered outdated so we will start our task.
      Returns:
      result with "executed" flag specifying if execution was executed or ignored.

    • isPrimaryCluster

      public boolean isPrimaryCluster()
      Description copied from interface: ClusterProvider
      Checks if the current cluster is the primary cluster.
      Specified by:
      isPrimaryCluster in interface ClusterProvider
      Returns:
      true if this node is the coordinator.

    • isPrimaryClusterSupported

      public boolean isPrimaryClusterSupported()
      Description copied from interface: ClusterProvider
      Checks if the primary cluster check is supported.

      Not all configurations use JDBC_PING and can determine this information.

      Specified by:
      isPrimaryClusterSupported in interface ClusterProvider
      Returns:
      true if the coordinator check is supported.

    • executeIfNotExecutedAsync

      public Future<Boolean> executeIfNotExecutedAsync(String taskKey, int taskTimeoutInSeconds, Callable task)
      Description copied from interface: ClusterProvider
      Execute given task just if it's not already in progress (either on this or any other cluster node). It will return corresponding future to every caller and this future is fulfilled if: - The task is successfully finished. In that case Future will be true - The task wasn't successfully finished. For example because cluster node failover. In that case Future will be false
      Specified by:
      executeIfNotExecutedAsync in interface ClusterProvider
      taskTimeoutInSeconds - timeout for given task. If there is existing task in progress for longer time, it's considered outdated so we will start our task.
      Returns:
      Future, which will be completed once the running task is finished. Returns true if task was successfully finished. Otherwise (for example if cluster node when task was running leaved cluster) returns false

    • registerListener

      public void registerListener(String taskKey, ClusterListener task)
      Description copied from interface: ClusterProvider
      Register task (listener) under given key. When this key will be put to the cache on any cluster node, the task will be executed.
      Specified by:
      registerListener in interface ClusterProvider

    • notify

      public void notify(String taskKey, ClusterEvent event, boolean ignoreSender, ClusterProvider.DCNotify dcNotify)
      Description copied from interface: ClusterProvider
      Notify registered listeners on all cluster nodes in all datacenters. It will notify listeners registered under given taskKey
      Specified by:
      notify in interface ClusterProvider
      ignoreSender - if true, then sender node itself won't receive the notification
      dcNotify - Specify which DCs to notify. See ClusterProvider.DCNotify enum values for more info

    • notify

      public void notify(String taskKey, ClusterEvent event, boolean ignoreSender)
      Specified by:
      notify in interface ClusterProvider

    • notify

      public void notify(String taskKey, Collection<? extends ClusterEvent> events, boolean ignoreSender, ClusterProvider.DCNotify dcNotify)
      Description copied from interface: ClusterProvider
      An alternative to ClusterProvider.notify(String, ClusterEvent, boolean, DCNotify) that sends multiple events in a single network call.

      Notifies registered listeners on all cluster nodes in all datacenters. It will notify listeners registered under given taskKey

      Specified by:
      notify in interface ClusterProvider
      See Also:

    • notify

      public void notify(String taskKey, Collection<? extends ClusterEvent> events, boolean ignoreSender)
      Specified by:
      notify in interface ClusterProvider

    • close

      public void close()
      Specified by:
      close in interface Provider