org.axonframework.commandhandling.distributed

Class DistributedCommandBus.Builder

java.lang.Object

org.axonframework.commandhandling.distributed.DistributedCommandBus.Builder

Enclosing class:

DistributedCommandBus

public static class DistributedCommandBus.Builder
extends Object

Builder class to instantiate a DistributedCommandBus.

The CommandCallback is defaulted to a LoggingCallback. The MessageMonitor is defaulted to a NoOpMessageMonitor. The CommandBusSpanFactory is defaulted to a DefaultCommandBusSpanFactory backed by a NoOpSpanFactory. The CommandRouter and CommandBusConnector are hard requirements and as such should be provided.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DistributedCommandBus	build() Initializes a DistributedCommandBus as specified through this Builder.
DistributedCommandBus.Builder	commandRouter(CommandRouter commandRouter) Sets the CommandRouter used to determine the target node for each dispatched command.
DistributedCommandBus.Builder	connector(CommandBusConnector connector) Sets the CommandBusConnector which performs the actual transport of the message to the destination node.
DistributedCommandBus.Builder	defaultCommandCallback(CommandCallback<Object,Object> defaultCommandCallback) Sets the callback to use when commands are dispatched in a "fire and forget" method, such as DistributedCommandBus.dispatch(CommandMessage).
DistributedCommandBus.Builder	messageMonitor(MessageMonitor<? super CommandMessage<?>> messageMonitor) Sets the MessageMonitor for generic types implementing CommandMessage, which is used to monitor incoming messages and their execution result.
DistributedCommandBus.Builder	spanFactory(CommandBusSpanFactory spanFactory) Sets the CommandBusSpanFactory implementation to use for providing tracing capabilities.
DistributedCommandBus.Builder	spanFactory(SpanFactory spanFactory) Deprecated. Use spanFactory(CommandBusSpanFactory) instead as it provides more configurability.
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

commandRouter

public DistributedCommandBus.Builder commandRouter(CommandRouter commandRouter)

Sets the CommandRouter used to determine the target node for each dispatched command.

Parameters:

commandRouter - a CommandRouter used to determine the target node for each dispatched command

Returns:

the current Builder instance, for fluent interfacing

connector

public DistributedCommandBus.Builder connector(CommandBusConnector connector)

Sets the CommandBusConnector which performs the actual transport of the message to the destination node.

Parameters:

connector - a CommandBusConnector which performs the actual transport of the message to the destination node

Returns:

the current Builder instance, for fluent interfacing

messageMonitor

public DistributedCommandBus.Builder messageMonitor(MessageMonitor<? super CommandMessage<?>> messageMonitor)

Sets the MessageMonitor for generic types implementing CommandMessage, which is used to monitor incoming messages and their execution result.

Parameters:

messageMonitor - a MessageMonitor used to monitor incoming messages and their execution result

Returns:

the current Builder instance, for fluent interfacing

defaultCommandCallback

public DistributedCommandBus.Builder defaultCommandCallback(CommandCallback<Object,Object> defaultCommandCallback)

Sets the callback to use when commands are dispatched in a "fire and forget" method, such as DistributedCommandBus.dispatch(CommandMessage). Defaults to using a logging callback, which requests the connectors to use a fire-and-forget strategy for dispatching event.

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 DistributedCommandBus.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 DistributedCommandBus.Builder spanFactory(@Nonnull
                                                 CommandBusSpanFactory spanFactory)

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

Parameters:

spanFactory - The CommandBusSpanFactory implementation

Returns:

The current Builder instance, for fluent interfacing.

build

public DistributedCommandBus build()

Initializes a DistributedCommandBus as specified through this Builder.

Returns:

a DistributedCommandBus 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