Package org.axonframework.commandhandling.gateway

Class CommandGatewayFactory.Builder

java.lang.Object

org.axonframework.commandhandling.gateway.CommandGatewayFactory.Builder

Enclosing class:

CommandGatewayFactory

public static class CommandGatewayFactory.Builder
extends Object

Builder class to instantiate a CommandGatewayFactory.

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
CommandGatewayFactory	build()	Initializes a CommandGatewayFactory as specified through this Builder.
CommandGatewayFactory.Builder	commandBus(CommandBus commandBus)	Sets the CommandBus on which to dispatch CommandMessages.
CommandGatewayFactory.Builder	dispatchInterceptors(List<MessageDispatchInterceptor<? super CommandMessage<?>>> dispatchInterceptors)	Sets the MessageDispatchInterceptors which are invoked before dispatching a CommandMessage on the CommandBus.
CommandGatewayFactory.Builder	dispatchInterceptors(MessageDispatchInterceptor<? super CommandMessage<?>>... dispatchInterceptors)	Sets the MessageDispatchInterceptors which are invoked before dispatching a CommandMessage on the CommandBus.
CommandGatewayFactory.Builder	retryScheduler(RetryScheduler retryScheduler)	Sets the RetryScheduler which will decide whether to reschedule commands.
protected void	validate()	Validates whether the fields contained in this Builder are set accordingly.

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 CommandGatewayFactory.Builder commandBus(CommandBus commandBus)

Sets the CommandBus on which to dispatch CommandMessages.

Parameters:

commandBus - The CommandBus on which to dispatch CommandMessages.

Returns:

The current Builder instance, for fluent interfacing.

retryScheduler

public CommandGatewayFactory.Builder retryScheduler(RetryScheduler retryScheduler)

Sets the RetryScheduler which will decide whether to reschedule commands. May be null to report failures without rescheduling.

Parameters:

retryScheduler - The RetryScheduler which will decide whether to reschedule commands.

Returns:

The current Builder instance, for fluent interfacing.

dispatchInterceptors

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

Sets the MessageDispatchInterceptors which are invoked before dispatching a CommandMessage on the CommandBus. Note that the given dispatchInterceptors are applied only on commands sent through gateways that have been created using this factory.

Parameters:

dispatchInterceptors - An array of MessageDispatchInterceptors which are invoked before dispatching a CommandMessage on the CommandBus.

Returns:

The current Builder instance, for fluent interfacing.

dispatchInterceptors

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

Sets the MessageDispatchInterceptors which are invoked before dispatching a CommandMessage on the CommandBus. Note that the given dispatchInterceptors are applied only on commands sent through gateways that have been created using this factory.

Parameters:

dispatchInterceptors - A List of MessageDispatchInterceptors which are invoked before dispatching a CommandMessage on the CommandBus.

Returns:

The current Builder instance, for fluent interfacing.

build

public CommandGatewayFactory build()

Initializes a CommandGatewayFactory as specified through this Builder.

Returns:

A CommandGatewayFactory as specified through this Builder.

validate

protected void validate()
                 throws AxonConfigurationException

Validates whether the fields contained in this Builder are set accordingly.

Throws:

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