org.axonframework.test.utils

Class RecordingCommandBus

java.lang.Object

org.axonframework.test.utils.RecordingCommandBus

All Implemented Interfaces:

org.axonframework.commandhandling.CommandBus, org.axonframework.messaging.MessageDispatchInterceptorSupport<org.axonframework.commandhandling.CommandMessage<?>>, org.axonframework.messaging.MessageHandlerInterceptorSupport<org.axonframework.commandhandling.CommandMessage<?>>

public class RecordingCommandBus
extends Object
implements org.axonframework.commandhandling.CommandBus

CommandBus implementation that does not perform any actions on subscriptions or dispatched commands, but records them instead. This implementation is not a stand-in replacement for a mock, but might prove useful in many simple cases.

Since:

1.1

Author:

Allard Buijze

Constructor Summary

Constructors

Constructor and Description
RecordingCommandBus()

Method Summary

Modifier and Type	Method and Description
void	clearCommands() Clears all the commands recorded by this Command Bus.
void	clearSubscriptions() Clears all subscribed handlers on this command bus.
<C> void	dispatch(org.axonframework.commandhandling.CommandMessage<C> command)
<C,R> void	dispatch(org.axonframework.commandhandling.CommandMessage<C> command, org.axonframework.commandhandling.CommandCallback<? super C,? super R> callback)
List<org.axonframework.commandhandling.CommandMessage<?>>	getDispatchedCommands() Returns a list with all commands that have been dispatched by this command bus.
Map<String,org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>>>	getSubscriptions() Returns a Map will all Command Names and their Command Handler that have been subscribed to this command bus.
boolean	isSubscribed(org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>> commandHandler) Indicates whether the given commandHandler is subscribed to this command bus.
<C> boolean	isSubscribed(String commandName, org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>> commandHandler) Indicates whether the given commandHandler is subscribed to commands of the given commandType on this command bus.
org.axonframework.common.Registration	registerDispatchInterceptor(org.axonframework.messaging.MessageDispatchInterceptor<? super org.axonframework.commandhandling.CommandMessage<?>> dispatchInterceptor)
org.axonframework.common.Registration	registerHandlerInterceptor(org.axonframework.messaging.MessageHandlerInterceptor<? super org.axonframework.commandhandling.CommandMessage<?>> handlerInterceptor)
void	setCallbackBehavior(CallbackBehavior callbackBehavior) Sets the instance that defines the behavior of the Command Bus when a command is dispatched with a callback.
org.axonframework.common.Registration	subscribe(String commandName, org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>> handler)

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordingCommandBus

public RecordingCommandBus()

Method Detail

dispatch

public <C> void dispatch(org.axonframework.commandhandling.CommandMessage<C> command)

Specified by:

dispatch in interface org.axonframework.commandhandling.CommandBus

dispatch

public <C,R> void dispatch(org.axonframework.commandhandling.CommandMessage<C> command,
                           org.axonframework.commandhandling.CommandCallback<? super C,? super R> callback)

Specified by:

dispatch in interface org.axonframework.commandhandling.CommandBus

subscribe

public org.axonframework.common.Registration subscribe(String commandName,
                                                       org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>> handler)

Specified by:

subscribe in interface org.axonframework.commandhandling.CommandBus

clearCommands

public void clearCommands()

Clears all the commands recorded by this Command Bus.

clearSubscriptions

public void clearSubscriptions()

Clears all subscribed handlers on this command bus.

isSubscribed

public boolean isSubscribed(org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>> commandHandler)

Indicates whether the given commandHandler is subscribed to this command bus.

Parameters:

commandHandler - The command handler to verify the subscription for

Returns:

true if the handler is subscribed, otherwise false.

isSubscribed

public <C> boolean isSubscribed(String commandName,
                                org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>> commandHandler)

Indicates whether the given commandHandler is subscribed to commands of the given commandType on this command bus.

Type Parameters:

C - The type of command to verify the subscription for

Parameters:

commandName - The name of the command to verify the subscription for

commandHandler - The command handler to verify the subscription for

Returns:

true if the handler is subscribed, otherwise false.

getSubscriptions

public Map<String,org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>>> getSubscriptions()

Returns a Map will all Command Names and their Command Handler that have been subscribed to this command bus.

Returns:

a Map will all Command Names and their Command Handler

getDispatchedCommands

public List<org.axonframework.commandhandling.CommandMessage<?>> getDispatchedCommands()

Returns a list with all commands that have been dispatched by this command bus.

Returns:

a list with all commands that have been dispatched

setCallbackBehavior

public void setCallbackBehavior(CallbackBehavior callbackBehavior)

Sets the instance that defines the behavior of the Command Bus when a command is dispatched with a callback.

Parameters:

callbackBehavior - The instance deciding to how the callback should be invoked.

registerDispatchInterceptor

public org.axonframework.common.Registration registerDispatchInterceptor(org.axonframework.messaging.MessageDispatchInterceptor<? super org.axonframework.commandhandling.CommandMessage<?>> dispatchInterceptor)

Specified by:

registerDispatchInterceptor in interface org.axonframework.messaging.MessageDispatchInterceptorSupport<org.axonframework.commandhandling.CommandMessage<?>>

registerHandlerInterceptor

public org.axonframework.common.Registration registerHandlerInterceptor(org.axonframework.messaging.MessageHandlerInterceptor<? super org.axonframework.commandhandling.CommandMessage<?>> handlerInterceptor)

Specified by:

registerHandlerInterceptor in interface org.axonframework.messaging.MessageHandlerInterceptorSupport<org.axonframework.commandhandling.CommandMessage<?>>