org.axonframework.commandhandling

Class AsynchronousCommandBus.Builder

java.lang.Object

org.axonframework.commandhandling.SimpleCommandBus.Builder

org.axonframework.commandhandling.AsynchronousCommandBus.Builder

Enclosing class:

AsynchronousCommandBus

public static class AsynchronousCommandBus.Builder
extends SimpleCommandBus.Builder

Builder class to instantiate a AsynchronousCommandBus.

The TransactionManager, MessageMonitor, RollbackConfiguration, DuplicateCommandHandlerResolver, CommandBusSpanFactory to a DefaultCommandBusSpanFactory backed by a NoOpSpanFactory, and Executor are respectively defaulted to a NoTransactionManager, a NoOpMessageMonitor, a RollbackConfigurationType.UNCHECKED_EXCEPTIONS, a DuplicateCommandHandlerResolution.logAndOverride(), NoOpSpanFactory and a Executors.newCachedThreadPool(). The default executor uses an AxonThreadFactory to create threads with a sensible naming scheme. The TransactionManager, MessageMonitor, RollbackConfiguration and Executor are hard requirements. Thus setting them to null will result in an AxonConfigurationException.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AsynchronousCommandBus	build() Initializes a AsynchronousCommandBus as specified through this Builder.
AsynchronousCommandBus.Builder	defaultCommandCallback(CommandCallback<Object,Object> defaultCommandCallback) Sets the callback to use when commands are dispatched in a "fire and forget" method, such as SimpleCommandBus.dispatch(CommandMessage).
AsynchronousCommandBus.Builder	duplicateCommandHandlerResolver(DuplicateCommandHandlerResolver duplicateCommandHandlerResolver) Sets the DuplicateCommandHandlerResolver used to resolves the road to take when a duplicate command handler is subscribed.
AsynchronousCommandBus.Builder	executor(Executor executor) Sets the Executor which processes the Command dispatching threads.
AsynchronousCommandBus.Builder	messageMonitor(MessageMonitor<? super CommandMessage<?>> messageMonitor) Sets the MessageMonitor of generic type CommandMessage used the to monitor the command bus.
AsynchronousCommandBus.Builder	rollbackConfiguration(RollbackConfiguration rollbackConfiguration) Sets the RollbackConfiguration which allows you to specify when a UnitOfWork should be rolled back.
AsynchronousCommandBus.Builder	spanFactory(CommandBusSpanFactory spanFactory) Sets the CommandBusSpanFactory implementation to use for providing tracing capabilities.
AsynchronousCommandBus.Builder	spanFactory(SpanFactory spanFactory) Sets the SpanFactory implementation to use for providing tracing capabilities.
AsynchronousCommandBus.Builder	transactionManager(TransactionManager transactionManager) Sets the TransactionManager used to manage transactions.

Methods inherited from class org.axonframework.commandhandling.SimpleCommandBus.Builder

validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

transactionManager

public AsynchronousCommandBus.Builder transactionManager(@Nonnull
                                                         TransactionManager transactionManager)

Description copied from class: SimpleCommandBus.Builder

Sets the TransactionManager used to manage transactions. Defaults to a NoTransactionManager.

Overrides:

transactionManager in class SimpleCommandBus.Builder

Parameters:

transactionManager - a TransactionManager used to manage transactions

Returns:

the current Builder instance, for fluent interfacing

messageMonitor

public AsynchronousCommandBus.Builder messageMonitor(@Nonnull
                                                     MessageMonitor<? super CommandMessage<?>> messageMonitor)

Description copied from class: SimpleCommandBus.Builder

Sets the MessageMonitor of generic type CommandMessage used the to monitor the command bus. Defaults to a NoOpMessageMonitor.

Overrides:

messageMonitor in class SimpleCommandBus.Builder

Parameters:

messageMonitor - a MessageMonitor used the message monitor to monitor the command bus

Returns:

the current Builder instance, for fluent interfacing

rollbackConfiguration

public AsynchronousCommandBus.Builder rollbackConfiguration(@Nonnull
                                                            RollbackConfiguration rollbackConfiguration)

Description copied from class: SimpleCommandBus.Builder

Sets the RollbackConfiguration which allows you to specify when a UnitOfWork should be rolled back. Defaults to a RollbackConfigurationType.UNCHECKED_EXCEPTIONS, which triggers a rollback on all unchecked exceptions.

Overrides:

rollbackConfiguration in class SimpleCommandBus.Builder

Parameters:

rollbackConfiguration - a RollbackConfiguration specifying when a UnitOfWork should be rolled back

Returns:

the current Builder instance, for fluent interfacing

defaultCommandCallback

public AsynchronousCommandBus.Builder defaultCommandCallback(@Nonnull
                                                             CommandCallback<Object,Object> defaultCommandCallback)

Description copied from class: SimpleCommandBus.Builder

Sets the callback to use when commands are dispatched in a "fire and forget" method, such as SimpleCommandBus.dispatch(CommandMessage). Defaults to a LoggingCallback. Passing null will result in a NoOpCallback being used.

Overrides:

defaultCommandCallback in class SimpleCommandBus.Builder

Parameters:

defaultCommandCallback - the callback to invoke when no explicit callback is provided for a command

Returns:

the current Builder instance, for fluent interfacing

duplicateCommandHandlerResolver

public AsynchronousCommandBus.Builder duplicateCommandHandlerResolver(@Nonnull
                                                                      DuplicateCommandHandlerResolver duplicateCommandHandlerResolver)

Description copied from class: SimpleCommandBus.Builder

Sets the DuplicateCommandHandlerResolver used to resolves the road to take when a duplicate command handler is subscribed. Defaults to DuplicateCommandHandlerResolution.logAndOverride().

Overrides:

duplicateCommandHandlerResolver in class SimpleCommandBus.Builder

Parameters:

duplicateCommandHandlerResolver - a DuplicateCommandHandlerResolver used to resolves the road to take when a duplicate command handler is subscribed

Returns:

the current Builder instance, for fluent interfacing

spanFactory

public AsynchronousCommandBus.Builder spanFactory(@Nonnull
                                                  SpanFactory spanFactory)

Description copied from class: SimpleCommandBus.Builder

Sets the SpanFactory implementation to use for providing tracing capabilities. Defaults to a NoOpSpanFactory by default, which provides no tracing capabilities.

Overrides:

spanFactory in class SimpleCommandBus.Builder

Parameters:

spanFactory - The SpanFactory implementation.

Returns:

The current Builder instance, for fluent interfacing.

spanFactory

public AsynchronousCommandBus.Builder spanFactory(@Nonnull
                                                  CommandBusSpanFactory spanFactory)

Description copied from class: SimpleCommandBus.Builder

Sets the CommandBusSpanFactory implementation to use for providing tracing capabilities. Defaults to a DefaultCommandBusSpanFactory backed by NoOpSpanFactory by default, which provides no tracing capabilities.

Overrides:

spanFactory in class SimpleCommandBus.Builder

Parameters:

spanFactory - The CommandBusSpanFactory implementation.

Returns:

The current Builder instance, for fluent interfacing.

executor

public AsynchronousCommandBus.Builder executor(Executor executor)

Sets the Executor which processes the Command dispatching threads.

Parameters:

executor - a Executor to processes the Command dispatching threads

Returns:

the current Builder instance, for fluent interfacing

build

public AsynchronousCommandBus build()

Initializes a AsynchronousCommandBus as specified through this Builder.

Overrides:

build in class SimpleCommandBus.Builder

Returns:

a AsynchronousCommandBus as specified through this Builder