DistributedExecutorService

All Superinterfaces:

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

All Known Implementing Classes:

DefaultExecutorService
```
public interface DistributedExecutorService
extends java.util.concurrent.ExecutorService
```
An ExecutorService that provides methods to submit tasks for execution on a cluster of Infinispan nodes.
Every DistributedExecutorService is bound to one particular cache. Tasks submitted will have access to key/value pairs from that particular cache if and only if the task submitted is an instance of DistributedCallable. Also note that there is nothing preventing a user from submitting a familiar Runnable or Callable just like to any other ExecutorService. However, DistributedExecutorService, as it name implies, will likely migrate submitted Callable or Runnable to another JVM in Infinispan cluster, execute it and return a result to task invoker.
Note that due to potential task migration to other 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:

Manik Surtani, Vladimir Blagojevic

See Also:
DefaultExecutorService, DistributedCallable

Method Summary

Methods
Modifier and Type	Method and Description
`<T> DistributedTaskBuilder<T>`	`createDistributedTaskBuilder(java.util.concurrent.Callable<T> callable)` Returns DistributedTaskBuilder for this DistributedExecutorService and a given Callable.
`<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,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> 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 interface java.util.concurrent.ExecutorService
awaitTermination, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow, submit, submit, submit

Methods inherited from interface java.util.concurrent.Executor
execute

- Method Detail
  - submit
```
<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.
    
    Type Parameters:
    T -
    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
```
<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.
    
    Type Parameters:
    T -
    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
```
<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.
    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.
    
    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
```
<T,K> java.util.concurrent.Future<T> submit(DistributedTask<T> task,
                                          K... input)
```
    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.
    
    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
```
<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.
    
    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
```
<T> java.util.List<java.util.concurrent.Future<T>> submitEverywhere(DistributedTask<T> task)
```
    Submits the given DistributedTask for execution on all available Infinispan nodes.
    
    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
```
<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.
    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
    
    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
```
<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.
    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
    
    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
  - createDistributedTaskBuilder
```
<T> DistributedTaskBuilder<T> createDistributedTaskBuilder(java.util.concurrent.Callable<T> callable)
```
    Returns DistributedTaskBuilder for this DistributedExecutorService and a given Callable. As it name implies clients can use DistributedTaskBuilder to create DistributedTask instances.
    
    Type Parameters:
    T -
    Parameters:
    callable - the execution unit of DistributedTask
    
    Returns:
    DistributedTaskBuilder to create DistributedTask

Interface DistributedExecutorService

Method Summary

Methods inherited from interface java.util.concurrent.ExecutorService

Methods inherited from interface java.util.concurrent.Executor

Method Detail

submit

submit

submit

submit

submitEverywhere

submitEverywhere

submitEverywhere

submitEverywhere

createDistributedTaskBuilder