Interface DistributedExecutorService

  • All Superinterfaces:
    java.util.concurrent.Executor, java.util.concurrent.ExecutorService
    All Known Implementing Classes:
    DefaultExecutorService

    public interface DistributedExecutorService
    extends java.util.concurrent.ExecutorService
    Deprecated.
    since 9.1 Please use ClusterExecutor or CacheStream instead.
    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.

    All CompletableFuture returned to the caller may be cancelled, however if interruption is desired, (ie. mayInterruptIfRunning == true), it will only be performed if done on the original CompletableFuture returned via one of the various submit methods. Any chained futures from the original will only attempt to cancel the task result. If interruption is needed and this task was found to be operating on a remote node it will send a cancellation command to the remote node in an attempt to stop it early using standard java Thread.interrupt() on the thread processing that task.

    Since:
    5.0
    Author:
    Manik Surtani, Vladimir Blagojevic
    See Also:
    DefaultExecutorService, DistributedCallable
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      <T> DistributedTaskBuilder<T> createDistributedTaskBuilder​(java.util.concurrent.Callable<T> callable)
      Deprecated.
      Returns DistributedTaskBuilder for this DistributedExecutorService and a given Callable.
      <T,​K>
      java.util.concurrent.CompletableFuture<T>
      submit​(java.util.concurrent.Callable<T> task, K... input)
      Deprecated.
      Submits the given Callable task for execution on a single Infinispan node.
      <T,​K>
      java.util.concurrent.CompletableFuture<T>
      submit​(DistributedTask<T> task, K... input)
      Deprecated.
      Submits the given DistributedTask for execution on a single Infinispan node.
      <T> java.util.concurrent.CompletableFuture<T> submit​(Address target, java.util.concurrent.Callable<T> task)
      Deprecated.
      Submits the given Callable task for execution on the specified target Infinispan node.
      <T> java.util.concurrent.CompletableFuture<T> submit​(Address target, DistributedTask<T> task)
      Deprecated.
      Submits the given DistributedTask for execution on the specified target Infinispan node.
      <T> java.util.List<java.util.concurrent.CompletableFuture<T>> submitEverywhere​(java.util.concurrent.Callable<T> task)
      Deprecated.
      Submits the given Callable task for execution on all available Infinispan nodes.
      <T,​K>
      java.util.List<java.util.concurrent.CompletableFuture<T>>
      submitEverywhere​(java.util.concurrent.Callable<T> task, K... input)
      Deprecated.
      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.CompletableFuture<T>> submitEverywhere​(DistributedTask<T> task)
      Deprecated.
      Submits the given DistributedTask for execution on all available Infinispan nodes.
      <T,​K>
      java.util.List<java.util.concurrent.CompletableFuture<T>>
      submitEverywhere​(DistributedTask<T> task, K... input)
      Deprecated.
      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.Executor

        execute
      • Methods inherited from interface java.util.concurrent.ExecutorService

        awaitTermination, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow, submit, submit, submit
    • Method Detail

      • submit

        <T> java.util.concurrent.CompletableFuture<T> submit​(Address target,
                                                             java.util.concurrent.Callable<T> task)
        Deprecated.
        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.CompletableFuture<T> submit​(Address target,
                                                             DistributedTask<T> task)
        Deprecated.
        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.CompletableFuture<T> submit​(java.util.concurrent.Callable<T> task,
                                                                     K... input)
        Deprecated.
        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.CompletableFuture<T> submit​(DistributedTask<T> task,
                                                                     K... input)
        Deprecated.
        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.CompletableFuture<T>> submitEverywhere​(java.util.concurrent.Callable<T> task)
        Deprecated.
        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.CompletableFuture<T>> submitEverywhere​(DistributedTask<T> task)
        Deprecated.
        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.CompletableFuture<T>> submitEverywhere​(java.util.concurrent.Callable<T> task,
                                                                                               K... input)
        Deprecated.
        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.CompletableFuture<T>> submitEverywhere​(DistributedTask<T> task,
                                                                                               K... input)
        Deprecated.
        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)
        Deprecated.
        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