Package org.springframework.data.redis.connection

Class ClusterCommandExecutor

java.lang.Object

org.springframework.data.redis.connection.ClusterCommandExecutor

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean

public class ClusterCommandExecutor
extends Object
implements org.springframework.beans.factory.DisposableBean

ClusterCommandExecutor takes care of running commands across the known cluster nodes. By providing an AsyncTaskExecutor the execution behavior can be influenced.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClusterCommandExecutor.ClusterCommandCallback<T,S>	Callback interface for Redis 'low level' code using the cluster client directly.
static interface	ClusterCommandExecutor.MultiKeyClusterCommandCallback<T,S>	Callback interface for Redis 'low level' code using the cluster client to execute multi key commands.
static class	ClusterCommandExecutor.MultiNodeResult<T>	ClusterCommandExecutor.MultiNodeResult holds all ClusterCommandExecutor.NodeResult of a command executed on multiple RedisClusterNode.
static class	ClusterCommandExecutor.NodeResult<T>	ClusterCommandExecutor.NodeResult encapsulates the actual value returned by a ClusterCommandExecutor.ClusterCommandCallback on a given RedisClusterNode.

Constructor Summary

Constructors

Constructor	Description
ClusterCommandExecutor(ClusterTopologyProvider topologyProvider, ClusterNodeResourceProvider resourceProvider, ExceptionTranslationStrategy exceptionTranslation)	Create a new instance of ClusterCommandExecutor.
ClusterCommandExecutor(ClusterTopologyProvider topologyProvider, ClusterNodeResourceProvider resourceProvider, ExceptionTranslationStrategy exceptionTranslation, org.springframework.core.task.AsyncTaskExecutor executor)

Method Summary

Modifier and Type	Method	Description
void	destroy()
<S, T> ClusterCommandExecutor.MultiNodeResult<T>	executeCommandAsyncOnNodes(ClusterCommandExecutor.ClusterCommandCallback<S,T> callback, Iterable<RedisClusterNode> nodes)
<S, T> ClusterCommandExecutor.MultiNodeResult<T>	executeCommandOnAllNodes(ClusterCommandExecutor.ClusterCommandCallback<S,T> cmd)	Run ClusterCommandExecutor.ClusterCommandCallback on all reachable master nodes.
<T> ClusterCommandExecutor.NodeResult<T>	executeCommandOnArbitraryNode(ClusterCommandExecutor.ClusterCommandCallback<?,T> cmd)	Run ClusterCommandExecutor.ClusterCommandCallback on a random node.
<S, T> ClusterCommandExecutor.NodeResult<T>	executeCommandOnSingleNode(ClusterCommandExecutor.ClusterCommandCallback<S,T> cmd, RedisClusterNode node)	Run ClusterCommandExecutor.ClusterCommandCallback on given RedisClusterNode.
<S, T> ClusterCommandExecutor.MultiNodeResult<T>	executeMultiKeyCommand(ClusterCommandExecutor.MultiKeyClusterCommandCallback<S,T> cmd, Iterable<byte[]> keys)	Run ClusterCommandExecutor.MultiKeyClusterCommandCallback with on a curated set of nodes serving one or more keys.
void	setMaxRedirects(int maxRedirects)	Set the maximum number of redirects to follow on MOVED or ASK.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClusterCommandExecutor

public ClusterCommandExecutor(ClusterTopologyProvider topologyProvider,
 ClusterNodeResourceProvider resourceProvider,
 ExceptionTranslationStrategy exceptionTranslation)

Create a new instance of ClusterCommandExecutor.

Parameters:

topologyProvider - must not be null.

resourceProvider - must not be null.

exceptionTranslation - must not be null.

ClusterCommandExecutor

public ClusterCommandExecutor(ClusterTopologyProvider topologyProvider,
 ClusterNodeResourceProvider resourceProvider,
 ExceptionTranslationStrategy exceptionTranslation,
 @Nullable
 org.springframework.core.task.AsyncTaskExecutor executor)

Parameters:

topologyProvider - must not be null.

resourceProvider - must not be null.

exceptionTranslation - must not be null.

executor - can be null. Defaulted to ThreadPoolTaskExecutor.

Method Details

executeCommandOnArbitraryNode

public <T> ClusterCommandExecutor.NodeResult<T> executeCommandOnArbitraryNode(ClusterCommandExecutor.ClusterCommandCallback<?,T> cmd)

Run ClusterCommandExecutor.ClusterCommandCallback on a random node.

Parameters:

cmd - must not be null.

Returns:

never null.

executeCommandOnSingleNode

public <S,
T> ClusterCommandExecutor.NodeResult<T> executeCommandOnSingleNode(ClusterCommandExecutor.ClusterCommandCallback<S,T> cmd,
 RedisClusterNode node)

Run ClusterCommandExecutor.ClusterCommandCallback on given RedisClusterNode.

Parameters:

cmd - must not be null.

node - must not be null.

Returns:

Throws:

IllegalArgumentException - in case no resource can be acquired for given node.

executeCommandOnAllNodes

public <S,
T>
ClusterCommandExecutor.MultiNodeResult<T> executeCommandOnAllNodes(ClusterCommandExecutor.ClusterCommandCallback<S,T> cmd)

Run ClusterCommandExecutor.ClusterCommandCallback on all reachable master nodes.

Parameters:

cmd - must not be null.

Returns:

never null.

Throws:

ClusterCommandExecutionFailureException

executeCommandAsyncOnNodes

public <S,
T>
ClusterCommandExecutor.MultiNodeResult<T> executeCommandAsyncOnNodes(ClusterCommandExecutor.ClusterCommandCallback<S,T> callback,
 Iterable<RedisClusterNode> nodes)

Parameters:

callback - must not be null.

nodes - must not be null.

Returns:

never null.

Throws:

ClusterCommandExecutionFailureException

IllegalArgumentException - in case the node could not be resolved to a topology-known node

executeMultiKeyCommand

public <S,
T>
ClusterCommandExecutor.MultiNodeResult<T> executeMultiKeyCommand(ClusterCommandExecutor.MultiKeyClusterCommandCallback<S,T> cmd,
 Iterable<byte[]> keys)

Run ClusterCommandExecutor.MultiKeyClusterCommandCallback with on a curated set of nodes serving one or more keys.

Parameters:

cmd - must not be null.

Returns:

never null.

Throws:

ClusterCommandExecutionFailureException

setMaxRedirects

public void setMaxRedirects(int maxRedirects)

Set the maximum number of redirects to follow on MOVED or ASK.

Parameters:

maxRedirects - set to zero to suspend redirects.

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception