org.infinispan.manager

Interface ClusterExecutor

All Superinterfaces:

Executor

public interface ClusterExecutor
extends Executor

A cluster executor that can be used to invoke a given command across the cluster. Note this executor is not tied to any cache.

This executor also implements Executor so that it may be used with methods such as CompletableFuture.runAsync(Runnable, Executor) or CompletableFuture.supplyAsync(Supplier, Executor). Unfortunately though these invocations do not have explicitly defined Serializable Runnable or Supplier arguments and manual casting is required when using a lambda. Something like the following: CompletableFuture.runAsync((Serializable && Runnable)() -> doSomething(), clusterExecutor). Although note that the submit(SerializableRunnable) does this automatically for you.

Any method that returns a value should make sure the returned value is properly serializable or else it will be replaced with a NotSerializableException

Since:

8.2

Author:

wburns

Method Summary

Modifier and Type	Method and Description
void	execute(Runnable command)
void	execute(SerializableRunnable command) The same as Executor.execute(Runnable), except the Runnable must also implement Serializable.
ClusterExecutor	filterTargets(Collection<Address> addresses) Allows for filtering of address nodes by only allowing addresses in this collection from being contacted.
ClusterExecutor	filterTargets(Predicate<? super Address> predicate) Allows for filtering of address nodes dynamically per invocation.
ClusterExecutor	noFilter() Applies no filtering and will send any invocations to all current nodes.
CompletableFuture<Void>	submit(Runnable command) Submits the runnable to the desired nodes and returns a CompletableFuture that will be completed when all desired nodes complete the given command
CompletableFuture<Void>	submit(SerializableRunnable command) The same as submit(Runnable), except the Runnable must also implement Serializable.
<V> CompletableFuture<Void>	submitConsumer(Function<? super EmbeddedCacheManager,? extends V> callable, TriConsumer<? super Address,? super V,? super Throwable> triConsumer) Submits the given command to the desired nodes and allows for handling of results as they return.
<V> CompletableFuture<Void>	submitConsumer(SerializableFunction<? super EmbeddedCacheManager,? extends V> callable, TriConsumer<? super Address,? super V,? super Throwable> triConsumer) The same as submitConsumer(Function, TriConsumer), except the Callable must also implement Serializable.
ClusterExecutor	timeout(long time, TimeUnit unit) The timeout parameter is not adhered to when executing the command locally and is only for remote nodes.

Method Detail

execute

void execute(Runnable command)

This command will be ran in the desired nodes, but no result is returned to notify the user of completion or failure.

Specified by:

execute in interface Executor

Parameters:

command - the command to execute

execute

void execute(SerializableRunnable command)

The same as Executor.execute(Runnable), except the Runnable must also implement Serializable.

This method will be used automatically by lambdas, which prevents users from having to manually cast to a Serializable lambda.

Parameters:

command - the command to execute

submit

CompletableFuture<Void> submit(Runnable command)

Submits the runnable to the desired nodes and returns a CompletableFuture that will be completed when all desired nodes complete the given command

If a node encounters an exception, the first one to respond with such an exception will set the responding future to an exceptional state passing the given exception.

Parameters:

command - the command to execute.

Returns:

a completable future that will signify the command is finished on all desired nodes when completed

submit

CompletableFuture<Void> submit(SerializableRunnable command)

The same as submit(Runnable), except the Runnable must also implement Serializable.

This method will be used automatically by lambdas, which prevents users from having to manually cast to a Serializable lambda.

Parameters:

command - the command to execute

Returns:

a completable future that will signify the command is finished on all desired nodes when completed

submitConsumer

<V> CompletableFuture<Void> submitConsumer(Function<? super EmbeddedCacheManager,? extends V> callable,
                                           TriConsumer<? super Address,? super V,? super Throwable> triConsumer)

Submits the given command to the desired nodes and allows for handling of results as they return. The user provides a TriConsumer which will be called back each time for each desired node. Note that these callbacks can be called from different threads at the same time. A completable future is returned to the caller used for the sole purpose of being completed when all nodes have sent responses back.

Note the TriConsumer is only ran on the node where the task was submitted and thus doesn't need to be serialized.

Type Parameters:

V - the type of the task's result

Parameters:

callable - the task to execute

triConsumer - the tri-consumer to be called back upon for each node's result

Returns:

a completable future that will be completed after all results have been processed

submitConsumer

<V> CompletableFuture<Void> submitConsumer(SerializableFunction<? super EmbeddedCacheManager,? extends V> callable,
                                           TriConsumer<? super Address,? super V,? super Throwable> triConsumer)

The same as submitConsumer(Function, TriConsumer), except the Callable must also implement Serializable.

This method will be used automatically by lambdas, which prevents users from having to manually cast to a Serializable lambda.

Type Parameters:

V - the type of the task's result

Parameters:

callable - the task to execute

triConsumer - the tri-consumer to be called back upon for each node's result

Returns:

a completable future that will be completed after all results have been processed

timeout

ClusterExecutor timeout(long time,
                        TimeUnit unit)

The timeout parameter is not adhered to when executing the command locally and is only for remote nodes.

Parameters:

time -

unit -

Returns:

filterTargets

ClusterExecutor filterTargets(Predicate<? super Address> predicate)

Allows for filtering of address nodes dynamically per invocation. The predicate is applied to each member in the cluster at invocation to determine which targets to contact. Note that this method overrides any previous filtering that was done (ie. calling filterTargets(Collection)).

Parameters:

predicate - the dynamic predicate applied each time an invocation is done

Returns:

this executor again with the predicate filter applied to determine which nodes are contacted

filterTargets

ClusterExecutor filterTargets(Collection<Address> addresses)

Allows for filtering of address nodes by only allowing addresses in this collection from being contacted. Note that this method overrides any previous filtering that was done (ie. calling filterTargets(Predicate).

Parameters:

addresses - which nodes the executor invocations should go to

Returns:

this executor again which will only contact nodes whose address are in the given collection

noFilter

ClusterExecutor noFilter()

Applies no filtering and will send any invocations to all current nodes.

Returns:

this executor again with no filtering applied to target nodes