org.axonframework.commandhandling

Class SimpleCommandBus.Builder

java.lang.Object

org.axonframework.commandhandling.SimpleCommandBus.Builder

Direct Known Subclasses:

AsynchronousCommandBus.Builder

Enclosing class:

SimpleCommandBus

public static class SimpleCommandBus.Builder
extends Object

Builder class to instantiate a SimpleCommandBus.

The TransactionManager is defaulted to a NoTransactionManager, the MessageMonitor is defaulted to a NoOpMessageMonitor, the RollbackConfiguration defaults to a RollbackConfigurationType.UNCHECKED_EXCEPTIONS, the DuplicateCommandHandlerResolver defaults to DuplicateCommandHandlerResolution.logAndOverride() and the CommandBusSpanFactory defaults to a DefaultCommandBusSpanFactory with a NoOpSpanFactory.

The TransactionManager, MessageMonitor and RollbackConfiguration 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
SimpleCommandBus	build() Initializes a SimpleCommandBus as specified through this Builder.
SimpleCommandBus.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).
SimpleCommandBus.Builder	duplicateCommandHandlerResolver(DuplicateCommandHandlerResolver duplicateCommandHandlerResolver) Sets the DuplicateCommandHandlerResolver used to resolves the road to take when a duplicate command handler is subscribed.
SimpleCommandBus.Builder	messageMonitor(MessageMonitor<? super CommandMessage<?>> messageMonitor) Sets the MessageMonitor of generic type CommandMessage used the to monitor the command bus.
SimpleCommandBus.Builder	rollbackConfiguration(RollbackConfiguration rollbackConfiguration) Sets the RollbackConfiguration which allows you to specify when a UnitOfWork should be rolled back.
SimpleCommandBus.Builder	spanFactory(CommandBusSpanFactory spanFactory) Sets the CommandBusSpanFactory implementation to use for providing tracing capabilities.
SimpleCommandBus.Builder	spanFactory(SpanFactory spanFactory) Deprecated. Use spanFactory(CommandBusSpanFactory) instead as it provides more configurability.
SimpleCommandBus.Builder	transactionManager(TransactionManager transactionManager) Sets the TransactionManager used to manage transactions.
protected void	validate() Validate whether the fields contained in this Builder as set accordingly.

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 SimpleCommandBus.Builder transactionManager(@Nonnull
                                                   TransactionManager transactionManager)

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

Parameters:

transactionManager - a TransactionManager used to manage transactions

Returns:

the current Builder instance, for fluent interfacing

messageMonitor

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

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

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

rollbackConfiguration

public SimpleCommandBus.Builder rollbackConfiguration(@Nonnull
                                                      RollbackConfiguration rollbackConfiguration)

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.

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

duplicateCommandHandlerResolver

public SimpleCommandBus.Builder duplicateCommandHandlerResolver(@Nonnull
                                                                DuplicateCommandHandlerResolver duplicateCommandHandlerResolver)

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

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

defaultCommandCallback

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

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.

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

spanFactory

@Deprecated
public SimpleCommandBus.Builder spanFactory(@Nonnull
                                                        SpanFactory spanFactory)

Deprecated. Use spanFactory(CommandBusSpanFactory) instead as it provides more configurability.

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

Parameters:

spanFactory - The SpanFactory implementation.

Returns:

The current Builder instance, for fluent interfacing.

spanFactory

public SimpleCommandBus.Builder spanFactory(@Nonnull
                                            CommandBusSpanFactory spanFactory)

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

Parameters:

spanFactory - The CommandBusSpanFactory implementation.

Returns:

The current Builder instance, for fluent interfacing.

build

public SimpleCommandBus build()

Initializes a SimpleCommandBus as specified through this Builder.

Returns:

a SimpleCommandBus as specified through this Builder

validate

protected void validate()

Validate whether the fields contained in this Builder as set accordingly.

Throws:

AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications