org.axonframework.commandhandling.gateway

Class AbstractCommandGateway.Builder

java.lang.Object

org.axonframework.commandhandling.gateway.AbstractCommandGateway.Builder

Direct Known Subclasses:

DefaultCommandGateway.Builder

Enclosing class:

AbstractCommandGateway

public abstract static class AbstractCommandGateway.Builder
extends Object

Abstract Builder class to instantiate AbstractCommandGateway implementations.

The dispatchInterceptors are defaulted to an empty list. The CommandBus is a hard requirement and as such should be provided.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AbstractCommandGateway.Builder	commandBus(CommandBus commandBus) Sets the CommandBus used to dispatch commands.
AbstractCommandGateway.Builder	dispatchInterceptors(List<MessageDispatchInterceptor<? super CommandMessage<?>>> dispatchInterceptors) Sets the List of MessageDispatchInterceptors for CommandMessages.
AbstractCommandGateway.Builder	dispatchInterceptors(MessageDispatchInterceptor<? super CommandMessage<?>>... dispatchInterceptors) Sets the List of MessageDispatchInterceptors for CommandMessages.
AbstractCommandGateway.Builder	retryScheduler(RetryScheduler retryScheduler) Sets the RetryScheduler capable of performing retries of failed commands.
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

commandBus

public AbstractCommandGateway.Builder commandBus(@Nonnull
                                                 CommandBus commandBus)

Sets the CommandBus used to dispatch commands.

Parameters:

commandBus - a CommandBus used to dispatch commands

Returns:

the current Builder instance, for fluent interfacing

retryScheduler

public AbstractCommandGateway.Builder retryScheduler(@Nonnull
                                                     RetryScheduler retryScheduler)

Sets the RetryScheduler capable of performing retries of failed commands. May be null when to prevent retries.

Parameters:

retryScheduler - a RetryScheduler capable of performing retries of failed commands

Returns:

the current Builder instance, for fluent interfacing

dispatchInterceptors

public AbstractCommandGateway.Builder dispatchInterceptors(MessageDispatchInterceptor<? super CommandMessage<?>>... dispatchInterceptors)

Sets the List of MessageDispatchInterceptors for CommandMessages. Are invoked when a command is being dispatched.

Parameters:

dispatchInterceptors - which are invoked when a command is being dispatched

Returns:

the current Builder instance, for fluent interfacing

dispatchInterceptors

public AbstractCommandGateway.Builder dispatchInterceptors(List<MessageDispatchInterceptor<? super CommandMessage<?>>> dispatchInterceptors)

Sets the List of MessageDispatchInterceptors for CommandMessages. Are invoked when a command is being dispatched.

Parameters:

dispatchInterceptors - which are invoked when a command is being dispatched

Returns:

the current Builder instance, for fluent interfacing

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