Package org.axonframework.commandhandling.gateway

Class DefaultCommandGateway.Builder

java.lang.Object

org.axonframework.commandhandling.gateway.AbstractCommandGateway.Builder

org.axonframework.commandhandling.gateway.DefaultCommandGateway.Builder

Enclosing class:

DefaultCommandGateway

public static class DefaultCommandGateway.Builder
extends AbstractCommandGateway.Builder

Builder class to instantiate a DefaultCommandGateway.

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DefaultCommandGateway	build()	Initializes a DefaultCommandGateway as specified through this Builder.
DefaultCommandGateway.Builder	commandBus(CommandBus commandBus)	Sets the CommandBus used to dispatch commands.
DefaultCommandGateway.Builder	commandCallback(CommandCallback<Object,Object> commandCallback)	Set a CommandCallback on the command bus.
DefaultCommandGateway.Builder	dispatchInterceptors(List<MessageDispatchInterceptor<? super CommandMessage<?>>> dispatchInterceptors)	Sets the List of MessageDispatchInterceptors for CommandMessages.
DefaultCommandGateway.Builder	dispatchInterceptors(MessageDispatchInterceptor<? super CommandMessage<?>>... dispatchInterceptors)	Sets the List of MessageDispatchInterceptors for CommandMessages.
DefaultCommandGateway.Builder	retryScheduler(RetryScheduler retryScheduler)	Sets the RetryScheduler capable of performing retries of failed commands.

Methods inherited from class org.axonframework.commandhandling.gateway.AbstractCommandGateway.Builder

validate

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

commandBus

public DefaultCommandGateway.Builder commandBus(@Nonnull
 CommandBus commandBus)

Description copied from class: AbstractCommandGateway.Builder

Sets the CommandBus used to dispatch commands.

Overrides:

commandBus in class AbstractCommandGateway.Builder

Parameters:

commandBus - a CommandBus used to dispatch commands

Returns:

the current Builder instance, for fluent interfacing

commandCallback

public DefaultCommandGateway.Builder commandCallback(CommandCallback<Object,Object> commandCallback)

Set a CommandCallback on the command bus. This will be used as callback for all asynchronous commands that are sent. By default, the FailureLoggingCallback is used. This will log to the default logger on failure.

Parameters:

commandCallback - The CommandCallback to use for asynchronous commands

Returns:

the current Builder instance, for fluent interfacing

retryScheduler

public DefaultCommandGateway.Builder retryScheduler(@Nonnull
 RetryScheduler retryScheduler)

Description copied from class: AbstractCommandGateway.Builder

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

Overrides:

retryScheduler in class AbstractCommandGateway.Builder

Parameters:

retryScheduler - a RetryScheduler capable of performing retries of failed commands

Returns:

the current Builder instance, for fluent interfacing

dispatchInterceptors

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

Description copied from class: AbstractCommandGateway.Builder

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

Overrides:

dispatchInterceptors in class AbstractCommandGateway.Builder

Parameters:

dispatchInterceptors - which are invoked when a command is being dispatched

Returns:

the current Builder instance, for fluent interfacing

dispatchInterceptors

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

Description copied from class: AbstractCommandGateway.Builder

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

Overrides:

dispatchInterceptors in class AbstractCommandGateway.Builder

Parameters:

dispatchInterceptors - which are invoked when a command is being dispatched

Returns:

the current Builder instance, for fluent interfacing

build

public DefaultCommandGateway build()

Initializes a DefaultCommandGateway as specified through this Builder.

Returns:

a DefaultCommandGateway as specified through this Builder