org.axonframework.commandhandling

Class AsynchronousCommandBus

java.lang.Object

org.axonframework.commandhandling.SimpleCommandBus

org.axonframework.commandhandling.AsynchronousCommandBus

All Implemented Interfaces:

CommandBus, MessageDispatchInterceptorSupport<CommandMessage<?>>, MessageHandlerInterceptorSupport<CommandMessage<?>>

public class AsynchronousCommandBus
extends SimpleCommandBus

Specialization of the SimpleCommandBus that processed Commands asynchronously from the calling thread. By default, the AsynchronousCommandBus uses a Cached Thread Pool (see Executors.newCachedThreadPool()). It will reuse threads while possible, and shut them down after 60 seconds of inactivity.

Each Command is dispatched in a separate task, which is processed by the Executor.

Note that you should call shutdown() to stop any threads waiting for new tasks. Failure to do so may cause the JVM to hang for up to 60 seconds on JVM shutdown.

Since:

1.3.4

Author:

Allard Buijze

Constructor Summary

Constructors

Constructor and Description
AsynchronousCommandBus() Initialize the AsynchronousCommandBus, using a Cached Thread Pool.
AsynchronousCommandBus(Executor executor) Initialize the AsynchronousCommandBus using the given executor.
AsynchronousCommandBus(Executor executor, TransactionManager transactionManager, MessageMonitor<? super CommandMessage<?>> messageMonitor) Initialize the AsynchronousCommandBus using the given executor, transactionManager and messageMonitor.

Method Summary

Modifier and Type	Method and Description
protected <C,R> void	handle(CommandMessage<C> command, MessageHandler<? super CommandMessage<?>> handler, CommandCallback<? super C,R> callback) Performs the actual handling logic.
void	shutdown() Shuts down the Executor used to asynchronously dispatch incoming commands.

Methods inherited from class org.axonframework.commandhandling.SimpleCommandBus

dispatch, doDispatch, intercept, registerDispatchInterceptor, registerHandlerInterceptor, setRollbackConfiguration, subscribe

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.commandhandling.CommandBus

dispatch

Constructor Detail

AsynchronousCommandBus

public AsynchronousCommandBus()

Initialize the AsynchronousCommandBus, using a Cached Thread Pool.

AsynchronousCommandBus

public AsynchronousCommandBus(Executor executor)

Initialize the AsynchronousCommandBus using the given executor.

Parameters:

executor - The executor that processes Command dispatching threads

AsynchronousCommandBus

public AsynchronousCommandBus(Executor executor,
                              TransactionManager transactionManager,
                              MessageMonitor<? super CommandMessage<?>> messageMonitor)

Initialize the AsynchronousCommandBus using the given executor, transactionManager and messageMonitor.

Parameters:

executor - The executor that processes Command dispatching threads

transactionManager - The transactionManager to manage transaction with

messageMonitor - The message monitor to monitor the command bus

Method Detail

handle

protected <C,R> void handle(CommandMessage<C> command,
                            MessageHandler<? super CommandMessage<?>> handler,
                            CommandCallback<? super C,R> callback)

Description copied from class: SimpleCommandBus

Performs the actual handling logic.

Overrides:

handle in class SimpleCommandBus

Type Parameters:

C - The type of payload of the command

R - The type of result expected from the command handler

Parameters:

command - The actual command to handle

handler - The handler that must be invoked for this command

callback - The callback to notify of the result

shutdown

public void shutdown()

Shuts down the Executor used to asynchronously dispatch incoming commands. If the Executor provided in the constructor does not implement ExecutorService, this method does nothing.