org.wildfly.clustering.dispatcher

Interface CommandDispatcher<C>

Type Parameters:

C - the command context type

All Superinterfaces:

AutoCloseable

public interface CommandDispatcher<C>
extends AutoCloseable

Dispatches commands for execution on a group.

Author:

Paul Ferraro

Method Summary

Modifier and Type	Method and Description
void	close() Closes any resources used by this dispatcher.
default <R> Map<Node,CommandResponse<R>>	executeOnCluster(Command<R,? super C> command, Node... excludedNodes) Deprecated. Replaced by executeOnGroup(Command, Node...).
<R> Map<Node,CompletionStage<R>>	executeOnGroup(Command<R,? super C> command, Node... excludedMembers) Executes the specified command on all members of the group, optionally excluding some members.
<R> CompletionStage<R>	executeOnMember(Command<R,? super C> command, Node member) Executes the specified command on the specified group member.
default <R> CommandResponse<R>	executeOnNode(Command<R,? super C> command, Node node) Deprecated. Replaced by executeOnMember(Command, Node).
C	getContext() Returns the context with which this dispatcher was created.
default <R> Map<Node,Future<R>>	submitOnCluster(Command<R,? super C> command, Node... excludedNodes) Deprecated. Replaced by executeOnGroup(Command, Node...).
default <R> Future<R>	submitOnNode(Command<R,? super C> command, Node node) Deprecated. Replaced by executeOnMember(Command, Node).

Method Detail

getContext

C getContext()

Returns the context with which this dispatcher was created.

Returns:

a command execution context

executeOnMember

<R> CompletionStage<R> executeOnMember(Command<R,? super C> command,
                                       Node member)
                                throws CommandDispatcherException

Executes the specified command on the specified group member. If the member has no corresponding dispatcher, the returned completion stage throws a CancellationException.

Type Parameters:

R - the command execution return type

Parameters:

command - the command to execute

member - the group member on which to execute the command

Returns:

the future result of the command execution

Throws:

CommandDispatcherException - if the command could not be sent

executeOnGroup

<R> Map<Node,CompletionStage<R>> executeOnGroup(Command<R,? super C> command,
                                                Node... excludedMembers)
                                         throws CommandDispatcherException

Executes the specified command on all members of the group, optionally excluding some members. If a given member has no corresponding dispatcher, its completion stage throws a CancellationException.

Type Parameters:

R - the command execution return type

Parameters:

command - the command to execute

excludedMembers - the members to be excluded from group command execution

Returns:

a completion stage per member of the group on which the command was executed

Throws:

CommandDispatcherException - if the command could not be sent

executeOnNode

@Deprecated
default <R> CommandResponse<R> executeOnNode(Command<R,? super C> command,
                                                         Node node)
                                                  throws CommandDispatcherException

Deprecated. Replaced by executeOnMember(Command, Node).

Execute the specified command on the specified node.

Type Parameters:

R - the return value type

Parameters:

command - the command to execute

node - the node to execute the command on

Returns:

the result of the command execution

Throws:

CommandDispatcherException - if the command could not be sent

executeOnCluster

@Deprecated
default <R> Map<Node,CommandResponse<R>> executeOnCluster(Command<R,? super C> command,
                                                                      Node... excludedNodes)
                                                               throws CommandDispatcherException

Deprecated. Replaced by executeOnGroup(Command, Node...).

Execute the specified command on all nodes in the group, excluding the specified nodes

Type Parameters:

R - the return value type

Parameters:

command - the command to execute

excludedNodes - the set of nodes to exclude

Returns:

a map of command execution results per node

Throws:

CommandDispatcherException - if the command could not be broadcast

submitOnNode

@Deprecated
default <R> Future<R> submitOnNode(Command<R,? super C> command,
                                               Node node)
                                        throws CommandDispatcherException

Deprecated. Replaced by executeOnMember(Command, Node).

Submits the specified command on the specified node for execution.

Type Parameters:

R - the return value type

Parameters:

command - the command to execute

node - the node to execute the command on

Returns:

the result of the command execution

Throws:

CommandDispatcherException - if the command could not be sent

submitOnCluster

@Deprecated
default <R> Map<Node,Future<R>> submitOnCluster(Command<R,? super C> command,
                                                            Node... excludedNodes)
                                                     throws CommandDispatcherException

Deprecated. Replaced by executeOnGroup(Command, Node...).

Submits the specified command on all nodes in the group, excluding the specified nodes.

Type Parameters:

R - the return value type

Parameters:

command - the command to execute

excludedNodes - the set of nodes to exclude

Returns:

a map of command execution results per node.

Throws:

CommandDispatcherException - if the command could not be broadcast

close

void close()

Closes any resources used by this dispatcher. Once closed, a dispatcher can no longer execute commands.

Specified by:

close in interface AutoCloseable