Package org.axonframework.messaging.commandhandling

Interface CommandBus

All Superinterfaces:

CommandHandlerRegistry<CommandBus>, DescribableComponent

All Known Implementing Classes:

DistributedCommandBus, InterceptingCommandBus, RecordingCommandBus, RecordingCommandBus, RetryingCommandBus, SimpleCommandBus, TracingCommandBus

public interface CommandBus
extends CommandHandlerRegistry<CommandBus>, DescribableComponent

The mechanism that dispatches commands to their appropriate command handler.

Command handlers can subscribe to the command bus to handle commands matching the QualifiedName in the command type.

Hence, commands dispatched match a command handler based on "command name."

Only a single handler may be subscribed for a given command name at any time.

Since:

0.5

Author:

Allard Buijze

Method Summary

Modifier and Type	Method	Description
CompletableFuture<CommandResultMessage>	dispatch(CommandMessage command, ProcessingContext processingContext)	Dispatch the given command to the command handler subscribed to the given command's name.

Methods inherited from interface org.axonframework.messaging.commandhandling.CommandHandlerRegistry

subscribe, subscribe, subscribe

Methods inherited from interface org.axonframework.common.infra.DescribableComponent

describeTo

Method Details

dispatch

CompletableFuture<CommandResultMessage> dispatch(@Nonnull
 CommandMessage command,
 @Nullable
 ProcessingContext processingContext)

Dispatch the given command to the command handler subscribed to the given command's name. The name is typically deferred from the Message.type(), which contains a MessageType.qualifiedName().

Parameters:

command - The command to dispatch.

processingContext - The processing context under which the command is being published (can be null).

Returns:

The CompletableFuture providing the result of the command, once finished.

Throws:

NoHandlerForCommandException - when no command handler is registered for the given command's name.