AxonServerCommandBus.Builder (Axon Framework 4.7.6 API)

java.lang.Object
- org.axonframework.axonserver.connector.command.AxonServerCommandBus.Builder

Enclosing class:

AxonServerCommandBus
```
public static class AxonServerCommandBus.Builder
extends Object
```
Builder class to instantiate an AxonServerCommandBus.
The CommandPriorityCalculator is defaulted to CommandPriorityCalculator#defaultCommandPriorityCalculator(), and the {@link TargetContextResolver} defaults to a lambda returning the {@link AxonServerConfiguration#getContext()} as the context. The {@link ExecutorServiceBuilder} defaults to {@link ExecutorServiceBuilder#defaultCommandExecutorServiceBuilder()}. The {@link SpanFactory} defaults to a {@link NoOpSpanFactory}. The {@link AxonServerConnectionManager}, the {@link AxonServerConfiguration}, the local {@link CommandBus}, {@link Serializer} and the {@link RoutingStrategy} are hard requirements and as such should be provided.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AxonServerCommandBus.Builder`	`axonServerConnectionManager(AxonServerConnectionManager axonServerConnectionManager)` Sets the `AxonServerConnectionManager` used to create connections between this application and an Axon Server instance.
`AxonServerCommandBus`	`build()` Initializes a `AxonServerCommandBus` as specified through this Builder.
`protected CommandSerializer`	`buildSerializer()` Build a `CommandSerializer` using the configured `serializer` and `configuration`.
`AxonServerCommandBus.Builder`	`configuration(AxonServerConfiguration configuration)` Sets the `AxonServerConfiguration` used to configure several components within the Axon Server Command Bus, like setting the client id or the number of command handling threads used.
`AxonServerCommandBus.Builder`	`defaultCommandCallback(CommandCallback<Object,Object> defaultCommandCallback)` Sets the callback to use when commands are dispatched in a "fire and forget" method, such as `AxonServerCommandBus.dispatch(CommandMessage)`.
`AxonServerCommandBus.Builder`	`defaultContext(String defaultContext)` Sets the default context for this command bus to connect to.
`AxonServerCommandBus.Builder`	`executorServiceBuilder(ExecutorServiceBuilder executorServiceBuilder)` Sets the `ExecutorServiceBuilder` which builds an `ExecutorService` based on a given `AxonServerConfiguration` and `BlockingQueue` of `Runnable`.
`AxonServerCommandBus.Builder`	`loadFactorProvider(CommandLoadFactorProvider loadFactorProvider)` Sets the `CommandLoadFactorProvider` which provides the load factor values for all commands this client can handle.
`AxonServerCommandBus.Builder`	`localSegment(CommandBus localSegment)` Sets the local `CommandBus` used to dispatch incoming commands to the local environment.
`AxonServerCommandBus.Builder`	`priorityCalculator(CommandPriorityCalculator priorityCalculator)` Sets the `CommandPriorityCalculator` used to deduce the priority of an incoming command among other commands, to give precedence over high(er) valued queries for example.
`AxonServerCommandBus.Builder`	`routingStrategy(RoutingStrategy routingStrategy)` Sets the `RoutingStrategy` used to correctly configure connections between Axon clients and Axon Server.
`AxonServerCommandBus.Builder`	`serializer(Serializer serializer)` Sets the `Serializer` used to de-/serialize incoming and outgoing commands and command results.
`AxonServerCommandBus.Builder`	`spanFactory(SpanFactory spanFactory)` Sets the `SpanFactory` implementation to use for providing tracing capabilities.
`AxonServerCommandBus.Builder`	`targetContextResolver(TargetContextResolver<? super CommandMessage<?>> targetContextResolver)` Sets the `TargetContextResolver` used to resolve the target (bounded) context of an ingested `CommandMessage`.
`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 Detail
  - Builder
```
public Builder()
```
- Method Detail
  - axonServerConnectionManager
```
public AxonServerCommandBus.Builder axonServerConnectionManager(AxonServerConnectionManager axonServerConnectionManager)
```
    Sets the AxonServerConnectionManager used to create connections between this application and an Axon Server instance.
    
    Parameters:
    
    axonServerConnectionManager - an AxonServerConnectionManager used to create connections between this application and an Axon Server instance
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - configuration
```
public AxonServerCommandBus.Builder configuration(AxonServerConfiguration configuration)
```
    Sets the AxonServerConfiguration used to configure several components within the Axon Server Command Bus, like setting the client id or the number of command handling threads used.
    
    Parameters:
    
    configuration - an AxonServerConfiguration used to configure several components within the Axon Server Command Bus
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - localSegment
```
public AxonServerCommandBus.Builder localSegment(CommandBus localSegment)
```
    Sets the local CommandBus used to dispatch incoming commands to the local environment.
    
    Parameters:
    
    localSegment - a CommandBus used to dispatch incoming commands to the local environment
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - serializer
```
public AxonServerCommandBus.Builder serializer(Serializer serializer)
```
    Sets the Serializer used to de-/serialize incoming and outgoing commands and command results.
    
    Parameters:
    
    serializer - a Serializer used to de-/serialize incoming and outgoing commands and command results
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - routingStrategy
```
public AxonServerCommandBus.Builder routingStrategy(RoutingStrategy routingStrategy)
```
    Sets the RoutingStrategy used to correctly configure connections between Axon clients and Axon Server.
    
    Parameters:
    
    routingStrategy - a RoutingStrategy
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - defaultCommandCallback
```
public AxonServerCommandBus.Builder defaultCommandCallback(CommandCallback<Object,Object> defaultCommandCallback)
```
    Sets the callback to use when commands are dispatched in a "fire and forget" method, such as AxonServerCommandBus.dispatch(CommandMessage). Defaults to a NoOpCallback. 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
  - priorityCalculator
```
public AxonServerCommandBus.Builder priorityCalculator(CommandPriorityCalculator priorityCalculator)
```
    Sets the CommandPriorityCalculator used to deduce the priority of an incoming command among other commands, to give precedence over high(er) valued queries for example. Defaults to a CommandPriorityCalculator.defaultCommandPriorityCalculator().
    
    Parameters:
    
    priorityCalculator - a CommandPriorityCalculator used to deduce the priority of an incoming command among other commands
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - targetContextResolver
```
public AxonServerCommandBus.Builder targetContextResolver(TargetContextResolver<? super CommandMessage<?>> targetContextResolver)
```
    Sets the TargetContextResolver used to resolve the target (bounded) context of an ingested CommandMessage. Defaults to returning the AxonServerConfiguration.getContext() on any type of command message being ingested.
    
    Parameters:
    
    targetContextResolver - a TargetContextResolver used to resolve the target (bounded) context of an ingested CommandMessage
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - executorServiceBuilder
```
public AxonServerCommandBus.Builder executorServiceBuilder(ExecutorServiceBuilder executorServiceBuilder)
```
    Sets the ExecutorServiceBuilder which builds an ExecutorService based on a given AxonServerConfiguration and BlockingQueue of Runnable. This ExecutorService is used to process incoming commands with. Defaults to a ThreadPoolExecutor, using the AxonServerConfiguration.getCommandThreads() for the pool size, a keep-alive-time of 100ms, the given BlockingQueue as the work queue and an AxonThreadFactory.
    Note that it is highly recommended to use the given BlockingQueue if you are to provide you own executorServiceBuilder, as it ensure the command's priority is taken into consideration. Defaults to ExecutorServiceBuilder.defaultCommandExecutorServiceBuilder().
    
    Parameters:
    
    executorServiceBuilder - an ExecutorServiceBuilder used to build an ExecutorService based on the AxonServerConfiguration and a BlockingQueue
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - loadFactorProvider
```
public AxonServerCommandBus.Builder loadFactorProvider(CommandLoadFactorProvider loadFactorProvider)
```
    Sets the CommandLoadFactorProvider which provides the load factor values for all commands this client can handle. The load factor values are sent to AxonServer during command subscription. AxonServer uses these values to balance the dispatching of commands among the client instances. The default implementation of loadFactorProvider returns always CommandLoadFactorProvider.DEFAULT_VALUE
    
    Parameters:
    
    loadFactorProvider - a CommandLoadFactorProvider used to get the load factor value for each specific command that this client can handle
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - defaultContext
```
public AxonServerCommandBus.Builder defaultContext(String defaultContext)
```
    Sets the default context for this command bus to connect to.
    
    Parameters:
    
    defaultContext - for this bus to connect to.
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - spanFactory
```
public AxonServerCommandBus.Builder spanFactory(@Nonnull
                                                SpanFactory spanFactory)
```
    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.
  - build
```
public AxonServerCommandBus build()
```
    Initializes a AxonServerCommandBus as specified through this Builder.
    
    Returns:
    
    a AxonServerCommandBus as specified through this Builder
  - buildSerializer
```
protected CommandSerializer buildSerializer()
```
    Build a CommandSerializer using the configured serializer and configuration.
    
    Returns:
    
    a CommandSerializer based on the configured serializer and configuration
  - 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

Class AxonServerCommandBus.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

axonServerConnectionManager

configuration

localSegment

serializer

routingStrategy

defaultCommandCallback

priorityCalculator

targetContextResolver

executorServiceBuilder

loadFactorProvider

defaultContext

spanFactory

build

buildSerializer

validate