org.keycloak.cluster

Interface ClusterProvider

All Superinterfaces:

Provider

public interface ClusterProvider
extends Provider

Various utils related to clustering and concurrent tasks on cluster nodes

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL Special value to be used with registerListener(java.lang.String, org.keycloak.cluster.ClusterListener) to specify that particular listener will be always triggered for all notifications with any key.

Method Summary

Modifier and Type	Method and Description
<T> ExecutionResult<T>	executeIfNotExecuted(String taskKey, int taskTimeoutInSeconds, Callable<T> task) Execute given task just if it's not already in progress (either on this or any other cluster node).
int	getClusterStartupTime() Same value for all cluster nodes.
void	notify(String taskKey, ClusterEvent event, boolean ignoreSender) Notify registered listeners on all cluster nodes.
void	registerListener(String taskKey, ClusterListener task) Register task (listener) under given key.

Methods inherited from interface org.keycloak.provider.Provider

close

Field Detail

ALL

static final String ALL

Special value to be used with registerListener(java.lang.String, org.keycloak.cluster.ClusterListener) to specify that particular listener will be always triggered for all notifications with any key.

See Also:

Constant Field Values

Method Detail

getClusterStartupTime

int getClusterStartupTime()

Same value for all cluster nodes. It will use startup time of this server in non-cluster environment.

executeIfNotExecuted

<T> ExecutionResult<T> executeIfNotExecuted(String taskKey,
                                            int taskTimeoutInSeconds,
                                            Callable<T> task)

Execute given task just if it's not already in progress (either on this or any other cluster node).

Type Parameters:

T -

Parameters:

taskKey -

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.

task -

Returns:

result with "executed" flag specifying if execution was executed or ignored.

registerListener

void registerListener(String taskKey,
                      ClusterListener task)

Register task (listener) under given key. When this key will be put to the cache on any cluster node, the task will be executed. When using ALL as the taskKey, then listener will be always triggered for any value put into the cache.

Parameters:

taskKey -

task -

notify

void notify(String taskKey,
            ClusterEvent event,
            boolean ignoreSender)

Notify registered listeners on all cluster nodes. It will notify listeners registered under given taskKey AND also listeners registered with ALL key (those are always executed)

Parameters:

taskKey -

event -

ignoreSender - if true, then sender node itself won't receive the notification