org.infinispan.distexec

Class DefaultExecutorService

java.lang.Object

java.util.concurrent.AbstractExecutorService

org.infinispan.distexec.DefaultExecutorService

All Implemented Interfaces:

java.util.concurrent.Executor, java.util.concurrent.ExecutorService, DistributedExecutorService

public class DefaultExecutorService
extends java.util.concurrent.AbstractExecutorService
implements DistributedExecutorService

Infinispan's implementation of an ExecutorService and DistributedExecutorService. This ExecutorService provides methods to submit tasks for an execution on a cluster of Infinispan nodes.

Note that due to potential task migration to another nodes every Callable, Runnable and/or DistributedCallable submitted must be either Serializable or Externalizable. Also the value returned from a callable must be Serializable or Externalizable. Unfortunately if the value returned is not serializable then a NotSerializableException will be thrown.

Since:

5.0

Author:

Vladimir Blagojevic

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DefaultExecutorService.DefaultDistributedTaskBuilder<T>
private class	DefaultExecutorService.DistributedTaskPart<V> DistributedTaskPart represents a unit of work sent to remote VM and executed there
(package private) static interface	DefaultExecutorService.NodeFilter NodeFilter allows selection of nodes according to DistributedTaskExecutionPolicy
private static class	DefaultExecutorService.NoTaskFailoverPolicy
private static class	DefaultExecutorService.RandomNodeTaskFailoverPolicy
private static class	DefaultExecutorService.RunnableAdapter<T>

Field Summary

Fields

Modifier and Type	Field and Description
private static DefaultExecutorService.NodeFilter	ALL_FILTER
protected AdvancedCache	cache
protected org.infinispan.commands.CancellationService	cancellationService
protected org.infinispan.interceptors.locking.ClusteringDependentLogic	clusterDependentLogic
protected org.infinispan.commands.CommandsFactory	factory
protected org.infinispan.interceptors.InterceptorChain	invoker
protected java.util.concurrent.atomic.AtomicBoolean	isShutdown
protected java.util.concurrent.ExecutorService	localExecutorService
private static org.infinispan.util.logging.Log	log
protected Marshaller	marshaller
static DistributedTaskFailoverPolicy	NO_FAILOVER
static DistributedTaskFailoverPolicy	RANDOM_NODE_FAILOVER
protected org.infinispan.remoting.rpc.RpcManager	rpc
private static DefaultExecutorService.NodeFilter	SAME_MACHINE_FILTER
private static DefaultExecutorService.NodeFilter	SAME_RACK_FILTER
private static DefaultExecutorService.NodeFilter	SAME_SITE_FILTER
protected boolean	takeExecutorOwnership
private org.infinispan.util.TimeService	timeService
private static boolean	trace

Constructor Summary

Constructors

Constructor and Description
DefaultExecutorService(Cache<?,?> masterCacheNode) Creates a new DefaultExecutorService given a master cache node for local task execution.
DefaultExecutorService(Cache<?,?> masterCacheNode, java.util.concurrent.ExecutorService localExecutorService) Creates a new DefaultExecutorService given a master cache node and an ExecutorService for parallel execution of tasks ran on this node.
DefaultExecutorService(Cache<?,?> masterCacheNode, java.util.concurrent.ExecutorService localExecutorService, boolean takeExecutorOwnership) Creates a new DefaultExecutorService given a master cache node and an ExecutorService for parallel execution of task ran on this node.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit)
private <T,K> void	checkExecutionPolicy(DistributedTask<T> task, java.util.Map<org.infinispan.remoting.transport.Address,java.util.List<K>> nodesKeysMap, K... input)
protected <T> java.util.concurrent.Callable<T>	clone(java.util.concurrent.Callable<T> task)
<T> DistributedTaskBuilder<T>	createDistributedTaskBuilder(java.util.concurrent.Callable<T> callable) Returns DistributedTaskBuilder for this DistributedExecutorService and a given Callable.
protected <T,K> DefaultExecutorService.DistributedTaskPart<T>	createDistributedTaskPart(DistributedTask<T> task, org.infinispan.commands.read.DistributedExecuteCommand<T> c, org.infinispan.remoting.transport.Address target, int failoverCount)
protected <T,K> DefaultExecutorService.DistributedTaskPart<T>	createDistributedTaskPart(DistributedTask<T> task, org.infinispan.commands.read.DistributedExecuteCommand<T> c, java.util.List<K> inputKeys, org.infinispan.remoting.transport.Address target, int failoverCount)
private <T> T	doInvokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks, boolean timed, long nanos) the main mechanics of invokeAny.
private void	ensureProperCacheState(AdvancedCache<?,?> cache)
void	execute(java.lang.Runnable command)
protected <T> java.util.List<org.infinispan.remoting.transport.Address>	executionCandidates(DistributedTask<T> task)
private java.util.List<org.infinispan.remoting.transport.Address>	filterMembers(DistributedTaskExecutionPolicy policy, java.util.List<org.infinispan.remoting.transport.Address> members)
private org.infinispan.remoting.transport.Address	getAddress()
protected java.util.List<org.infinispan.remoting.transport.Address>	getMembers()
private <K> boolean	inputKeysSpecified(K... input)
<T> T	invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
<T> T	invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks, long timeout, java.util.concurrent.TimeUnit unit)
boolean	isShutdown()
boolean	isTerminated()
protected <K> java.util.Map<org.infinispan.remoting.transport.Address,java.util.List<K>>	keysToExecutionNodes(DistributedTaskExecutionPolicy policy, K... input)
protected <T> java.util.concurrent.RunnableFuture<T>	newTaskFor(java.util.concurrent.Callable<T> callable)
protected <T> java.util.concurrent.RunnableFuture<T>	newTaskFor(java.lang.Runnable runnable, T value)
protected java.util.List<org.infinispan.remoting.transport.Address>	randomClusterMembers(java.util.List<org.infinispan.remoting.transport.Address> members, int numNeeded)
private java.util.List<java.lang.Runnable>	realShutdown(boolean interrupt)
protected <T> org.infinispan.remoting.transport.Address	selectExecutionNode(DistributedTask<T> task)
protected org.infinispan.remoting.transport.Address	selectExecutionNode(java.util.List<org.infinispan.remoting.transport.Address> candidates)
void	shutdown()
java.util.List<java.lang.Runnable>	shutdownNow()
<T> java.util.concurrent.Future<T>	submit(org.infinispan.remoting.transport.Address target, java.util.concurrent.Callable<T> task) Submits the given Callable task for execution on the specified target Infinispan node.
<T> java.util.concurrent.Future<T>	submit(org.infinispan.remoting.transport.Address target, DistributedTask<T> task) Submits the given DistributedTask for execution on the specified target Infinispan node.
<T>	submit(java.util.concurrent.Callable<T> task)
<T,K> java.util.concurrent.Future<T>	submit(java.util.concurrent.Callable<T> task, K... input) Submits the given Callable task for execution on a single Infinispan node.
<T,K> java.util.concurrent.Future<T>	submit(DistributedTask<T> task, K... input) Submits the given DistributedTask for execution on a single Infinispan node.
<T>	submit(java.lang.Runnable task, T result)
<T> java.util.List<java.util.concurrent.Future<T>>	submitEverywhere(java.util.concurrent.Callable<T> task) Submits the given Callable task for execution on all available Infinispan nodes.
<T,K> java.util.List<java.util.concurrent.Future<T>>	submitEverywhere(java.util.concurrent.Callable<T> task, K... input) Submits the given Callable task for execution on all available Infinispan nodes using input keys specified by K input.
<T> java.util.List<java.util.concurrent.Future<T>>	submitEverywhere(DistributedTask<T> task) Submits the given DistributedTask for execution on all available Infinispan nodes.
<T,K> java.util.List<java.util.concurrent.Future<T>>	submitEverywhere(DistributedTask<T> task, K... input) Submits the given DistributedTask for execution on all available Infinispan nodes using input keys specified by K input.

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, submit

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.ExecutorService

invokeAll, invokeAll, submit

Field Detail

SAME_MACHINE_FILTER

private static final DefaultExecutorService.NodeFilter SAME_MACHINE_FILTER

SAME_RACK_FILTER

private static final DefaultExecutorService.NodeFilter SAME_RACK_FILTER

SAME_SITE_FILTER

private static final DefaultExecutorService.NodeFilter SAME_SITE_FILTER

ALL_FILTER

private static final DefaultExecutorService.NodeFilter ALL_FILTER

NO_FAILOVER

public static final DistributedTaskFailoverPolicy NO_FAILOVER

RANDOM_NODE_FAILOVER

public static final DistributedTaskFailoverPolicy RANDOM_NODE_FAILOVER

log

private static final org.infinispan.util.logging.Log log

trace

private static final boolean trace

isShutdown

protected final java.util.concurrent.atomic.AtomicBoolean isShutdown

cache

protected final AdvancedCache cache

rpc

protected final org.infinispan.remoting.rpc.RpcManager rpc

invoker

protected final org.infinispan.interceptors.InterceptorChain invoker

factory

protected final org.infinispan.commands.CommandsFactory factory

marshaller

protected final Marshaller marshaller

localExecutorService

protected final java.util.concurrent.ExecutorService localExecutorService

cancellationService

protected final org.infinispan.commands.CancellationService cancellationService

clusterDependentLogic

protected final org.infinispan.interceptors.locking.ClusteringDependentLogic clusterDependentLogic

takeExecutorOwnership

protected final boolean takeExecutorOwnership

timeService

private final org.infinispan.util.TimeService timeService

Constructor Detail

DefaultExecutorService

public DefaultExecutorService(Cache<?,?> masterCacheNode)

Creates a new DefaultExecutorService given a master cache node for local task execution. All distributed task executions will be initiated from this Infinispan cache node

Parameters:

masterCacheNode - Cache node initiating distributed task

DefaultExecutorService

public DefaultExecutorService(Cache<?,?> masterCacheNode,
                      java.util.concurrent.ExecutorService localExecutorService)

Creates a new DefaultExecutorService given a master cache node and an ExecutorService for parallel execution of tasks ran on this node. All distributed task executions will be initiated from this Infinispan cache node.

Note that DefaultExecutorService will not shutdown client supplied localExecutorService once this DefaultExecutorService is shutdown. Lifecycle management of a supplied ExecutorService is left to the client Also note that client supplied ExecutorService should not execute tasks in the caller's thread ( i.e rejectionHandler of ThreadPoolExecutor configured with {link ThreadPoolExecutor.CallerRunsPolicy)

Parameters:

masterCacheNode - Cache node initiating distributed task

localExecutorService - ExecutorService to run local tasks

DefaultExecutorService

public DefaultExecutorService(Cache<?,?> masterCacheNode,
                      java.util.concurrent.ExecutorService localExecutorService,
                      boolean takeExecutorOwnership)

Creates a new DefaultExecutorService given a master cache node and an ExecutorService for parallel execution of task ran on this node. All distributed task executions will be initiated from this Infinispan cache node.

Parameters:

masterCacheNode - Cache node initiating distributed task

localExecutorService - ExecutorService to run local tasks

takeExecutorOwnership - if true ExecutorService.shutdown() and ExecutorService.shutdownNow() method will shutdown localExecutorService as well

Method Detail

createDistributedTaskBuilder

public <T> DistributedTaskBuilder<T> createDistributedTaskBuilder(java.util.concurrent.Callable<T> callable)

Description copied from interface: DistributedExecutorService

Returns DistributedTaskBuilder for this DistributedExecutorService and a given Callable. As it name implies clients can use DistributedTaskBuilder to create DistributedTask instances.

Specified by:

createDistributedTaskBuilder in interface DistributedExecutorService

Parameters:

callable - the execution unit of DistributedTask

Returns:

DistributedTaskBuilder to create DistributedTask

submit

public <T>  submit(java.lang.Runnable task,
               T result)

Specified by:

submit in interface java.util.concurrent.ExecutorService

Overrides:

submit in class java.util.concurrent.AbstractExecutorService

submit

public <T>  submit(java.util.concurrent.Callable<T> task)

Specified by:

submit in interface java.util.concurrent.ExecutorService

Overrides:

submit in class java.util.concurrent.AbstractExecutorService

shutdown

public void shutdown()

Specified by:

shutdown in interface java.util.concurrent.ExecutorService

getMembers

protected java.util.List<org.infinispan.remoting.transport.Address> getMembers()

executionCandidates

protected <T> java.util.List<org.infinispan.remoting.transport.Address> executionCandidates(DistributedTask<T> task)

getAddress

private org.infinispan.remoting.transport.Address getAddress()

realShutdown

private java.util.List<java.lang.Runnable> realShutdown(boolean interrupt)

shutdownNow

public java.util.List<java.lang.Runnable> shutdownNow()

Specified by:

shutdownNow in interface java.util.concurrent.ExecutorService

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface java.util.concurrent.ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface java.util.concurrent.ExecutorService

awaitTermination

public boolean awaitTermination(long timeout,
                       java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException

Specified by:

awaitTermination in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAny

public <T> T invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
            throws java.lang.InterruptedException,
                   java.util.concurrent.ExecutionException

Specified by:

invokeAny in interface java.util.concurrent.ExecutorService

Overrides:

invokeAny in class java.util.concurrent.AbstractExecutorService

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

invokeAny

public <T> T invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks,
              long timeout,
              java.util.concurrent.TimeUnit unit)
            throws java.lang.InterruptedException,
                   java.util.concurrent.ExecutionException,
                   java.util.concurrent.TimeoutException

Specified by:

invokeAny in interface java.util.concurrent.ExecutorService

Overrides:

invokeAny in class java.util.concurrent.AbstractExecutorService

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

doInvokeAny

private <T> T doInvokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks,
                boolean timed,
                long nanos)
               throws java.lang.InterruptedException,
                      java.util.concurrent.ExecutionException,
                      java.util.concurrent.TimeoutException

the main mechanics of invokeAny. This was essentially copied from AbstractExecutorService doInvokeAny except that we replaced the ExecutorCompletionService with our DistributedExecutionCompletionService.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

execute

public void execute(java.lang.Runnable command)

Specified by:

execute in interface java.util.concurrent.Executor

newTaskFor

protected <T> java.util.concurrent.RunnableFuture<T> newTaskFor(java.lang.Runnable runnable,
                                                    T value)

Overrides:

newTaskFor in class java.util.concurrent.AbstractExecutorService

newTaskFor

protected <T> java.util.concurrent.RunnableFuture<T> newTaskFor(java.util.concurrent.Callable<T> callable)

Overrides:

newTaskFor in class java.util.concurrent.AbstractExecutorService

submit

public <T> java.util.concurrent.Future<T> submit(org.infinispan.remoting.transport.Address target,
                                        java.util.concurrent.Callable<T> task)

Description copied from interface: DistributedExecutorService

Submits the given Callable task for execution on the specified target Infinispan node.

Specified by:

submit in interface DistributedExecutorService

Parameters:

target - address of Infinispan node selected for execution of the task

task - a task to execute on selected Infinispan node

Returns:

a Future representing pending completion of the task

submit

public <T> java.util.concurrent.Future<T> submit(org.infinispan.remoting.transport.Address target,
                                        DistributedTask<T> task)

Description copied from interface: DistributedExecutorService

Submits the given DistributedTask for execution on the specified target Infinispan node.

Specified by:

submit in interface DistributedExecutorService

Parameters:

target - address of Infinispan node selected for execution of the task

task - a task to execute on selected Infinispan node

Returns:

a Future representing pending completion of the task

submit

public <T,K> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> task,
                                          K... input)

Description copied from interface: DistributedExecutorService

Submits the given Callable task for execution on a single Infinispan node.

Execution environment will chose an arbitrary node N hosting some or all of the keys specified as input. If all keys are not available locally at node N they will be retrieved from the cluster.

Specified by:

submit in interface DistributedExecutorService

Parameters:

task - a task to execute across Infinispan cluster

input - input keys for this task, effective if and only if task is instance of DistributedCallable

Returns:

a Future representing pending completion of the task

submit

public <T,K> java.util.concurrent.Future<T> submit(DistributedTask<T> task,
                                          K... input)

Description copied from interface: DistributedExecutorService

Submits the given DistributedTask for execution on a single Infinispan node.

Execution environment will chose an arbitrary node N hosting some or all of the keys specified as input. If all keys are not available locally at node N they will be retrieved from the cluster.

Specified by:

submit in interface DistributedExecutorService

Parameters:

task - a DistributedTask to execute across Infinispan cluster

input - input keys for this task, effective if and only if task's callable is instance of DistributedCallable

Returns:

a Future representing pending completion of the task

submitEverywhere

public <T> java.util.List<java.util.concurrent.Future<T>> submitEverywhere(java.util.concurrent.Callable<T> task)

Description copied from interface: DistributedExecutorService

Submits the given Callable task for execution on all available Infinispan nodes.

Specified by:

submitEverywhere in interface DistributedExecutorService

Parameters:

task - a task to execute across Infinispan cluster

Returns:

a list of Futures, one future per Infinispan cluster node where task was executed

submitEverywhere

public <T> java.util.List<java.util.concurrent.Future<T>> submitEverywhere(DistributedTask<T> task)

Description copied from interface: DistributedExecutorService

Submits the given DistributedTask for execution on all available Infinispan nodes.

Specified by:

submitEverywhere in interface DistributedExecutorService

Parameters:

task - a task to execute across Infinispan cluster

Returns:

a list of Futures, one future per Infinispan cluster node where task was executed

submitEverywhere

public <T,K> java.util.List<java.util.concurrent.Future<T>> submitEverywhere(java.util.concurrent.Callable<T> task,
                                                                    K... input)

Description copied from interface: DistributedExecutorService

Submits the given Callable task for execution on all available Infinispan nodes using input keys specified by K input.

Execution environment will chose all nodes in Infinispan cluster where input keys are local, migrate given Callable instance to those nodes, execute it and return result as a list of Futures

Specified by:

submitEverywhere in interface DistributedExecutorService

Parameters:

task - a task to execute across Infinispan cluster

input - input keys for this task, effective if and only if task is instance of DistributedCallable

Returns:

a list of Futures, one future per Infinispan cluster node where task was executed

submitEverywhere

public <T,K> java.util.List<java.util.concurrent.Future<T>> submitEverywhere(DistributedTask<T> task,
                                                                    K... input)

Description copied from interface: DistributedExecutorService

Submits the given DistributedTask for execution on all available Infinispan nodes using input keys specified by K input.

Execution environment will chose all nodes in Infinispan cluster where input keys are local, migrate given Callable instance to those nodes, execute it and return result as a list of Futures

Specified by:

submitEverywhere in interface DistributedExecutorService

Parameters:

task - a task to execute across Infinispan cluster

input - input keys for this task, effective if and only if task is instance of DistributedCallable

Returns:

a list of Futures, one future per Infinispan cluster node where task was executed

clone

protected <T> java.util.concurrent.Callable<T> clone(java.util.concurrent.Callable<T> task)

createDistributedTaskPart

protected <T,K> DefaultExecutorService.DistributedTaskPart<T> createDistributedTaskPart(DistributedTask<T> task,
                                                                            org.infinispan.commands.read.DistributedExecuteCommand<T> c,
                                                                            java.util.List<K> inputKeys,
                                                                            org.infinispan.remoting.transport.Address target,
                                                                            int failoverCount)

createDistributedTaskPart

protected <T,K> DefaultExecutorService.DistributedTaskPart<T> createDistributedTaskPart(DistributedTask<T> task,
                                                                            org.infinispan.commands.read.DistributedExecuteCommand<T> c,
                                                                            org.infinispan.remoting.transport.Address target,
                                                                            int failoverCount)

checkExecutionPolicy

private <T,K> void checkExecutionPolicy(DistributedTask<T> task,
                              java.util.Map<org.infinispan.remoting.transport.Address,java.util.List<K>> nodesKeysMap,
                              K... input)

inputKeysSpecified

private <K> boolean inputKeysSpecified(K... input)

selectExecutionNode

protected org.infinispan.remoting.transport.Address selectExecutionNode(java.util.List<org.infinispan.remoting.transport.Address> candidates)

selectExecutionNode

protected <T> org.infinispan.remoting.transport.Address selectExecutionNode(DistributedTask<T> task)

randomClusterMembers

protected java.util.List<org.infinispan.remoting.transport.Address> randomClusterMembers(java.util.List<org.infinispan.remoting.transport.Address> members,
                                                                             int numNeeded)

keysToExecutionNodes

protected <K> java.util.Map<org.infinispan.remoting.transport.Address,java.util.List<K>> keysToExecutionNodes(DistributedTaskExecutionPolicy policy,
                                                                                                  K... input)

filterMembers

private java.util.List<org.infinispan.remoting.transport.Address> filterMembers(DistributedTaskExecutionPolicy policy,
                                                                      java.util.List<org.infinispan.remoting.transport.Address> members)

ensureProperCacheState

private void ensureProperCacheState(AdvancedCache<?,?> cache)
                             throws java.lang.NullPointerException,
                                    java.lang.IllegalStateException

Throws:

java.lang.NullPointerException

java.lang.IllegalStateException