org.axonframework.commandhandling.gateway

Class AbstractCommandGateway

java.lang.Object

org.axonframework.commandhandling.gateway.AbstractCommandGateway

Direct Known Subclasses:

DefaultCommandGateway

public abstract class AbstractCommandGateway
extends Object

Abstract implementation of a CommandGateway, which handles the dispatch interceptors and retrying on failure. The actual dispatching of commands is left to the subclasses.

Since:

2.2

Author:

Allard Buijze

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractCommandGateway.Builder Abstract Builder class to instantiate AbstractCommandGateway implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCommandGateway(AbstractCommandGateway.Builder builder) Instantiate an AbstractCommandGateway based on the fields contained in the AbstractCommandGateway.Builder.

Method Summary

Modifier and Type	Method and Description
CommandBus	getCommandBus() Returns the CommandBus used by this gateway.
protected <C> CommandMessage<? extends C>	processInterceptors(CommandMessage<C> commandMessage) Invokes all the dispatch interceptors and returns the CommandMessage instance that should be dispatched.
protected Registration	registerDispatchInterceptor(MessageDispatchInterceptor<? super CommandMessage<?>> interceptor) Registers a command dispatch interceptor within a CommandGateway.
protected <C,R> void	send(C command, CommandCallback<? super C,? super R> callback) Sends the given command, and invokes the callback when the command is processed.
protected void	sendAndForget(Object command) Dispatches a command without callback.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCommandGateway

protected AbstractCommandGateway(AbstractCommandGateway.Builder builder)

Instantiate an AbstractCommandGateway based on the fields contained in the AbstractCommandGateway.Builder.

Will assert that the CommandBus is not null and throws an AxonConfigurationException if it is.

Parameters:

builder - the AbstractCommandGateway.Builder used to instantiate a AbstractCommandGateway instance

Method Detail

send

protected <C,R> void send(@Nonnull
                          C command,
                          @Nonnull
                          CommandCallback<? super C,? super R> callback)

Sends the given command, and invokes the callback when the command is processed.

Type Parameters:

R - The type of response expected from the command

Parameters:

command - The command to dispatch

callback - The callback to notify with the processing result

sendAndForget

protected void sendAndForget(Object command)

Dispatches a command without callback. When dispatching fails, since there is no callback, the command will not be retried.

Parameters:

command - The command to dispatch

registerDispatchInterceptor

protected Registration registerDispatchInterceptor(@Nonnull
                                                   MessageDispatchInterceptor<? super CommandMessage<?>> interceptor)

Registers a command dispatch interceptor within a CommandGateway.

Parameters:

interceptor - To intercept command messages

Returns:

a registration which can be used to cancel the registration of given interceptor

processInterceptors

protected <C> CommandMessage<? extends C> processInterceptors(CommandMessage<C> commandMessage)

Invokes all the dispatch interceptors and returns the CommandMessage instance that should be dispatched.

Parameters:

commandMessage - The incoming command message

Returns:

The command message to dispatch

getCommandBus

public CommandBus getCommandBus()

Returns the CommandBus used by this gateway. Should be used to monitoring or testing.

Returns:

The CommandBus used by this gateway