org.axonframework.axonserver.connector.command

Class AxonServerCommandBus

java.lang.Object

org.axonframework.axonserver.connector.command.AxonServerCommandBus

All Implemented Interfaces:

org.axonframework.commandhandling.CommandBus, org.axonframework.messaging.Distributed<org.axonframework.commandhandling.CommandBus>, org.axonframework.messaging.MessageDispatchInterceptorSupport<org.axonframework.commandhandling.CommandMessage<?>>, org.axonframework.messaging.MessageHandlerInterceptorSupport<org.axonframework.commandhandling.CommandMessage<?>>

public class AxonServerCommandBus
extends Object
implements org.axonframework.commandhandling.CommandBus, org.axonframework.messaging.Distributed<org.axonframework.commandhandling.CommandBus>

Axon CommandBus implementation that connects to Axon Server to submit and receive commands and command responses. Delegates incoming commands to the provided localSegment.

Since:

4.0

Author:

Marc Gathier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AxonServerCommandBus.Builder Builder class to instantiate an AxonServerCommandBus.

Constructor Summary

Constructors

Constructor and Description
AxonServerCommandBus(AxonServerCommandBus.Builder builder) Instantiate a AxonServerCommandBus based on the fields contained in the AxonServerCommandBus.Builder.

Method Summary

Modifier and Type	Method and Description
static AxonServerCommandBus.Builder	builder() Instantiate a Builder to be able to create an AxonServerCommandBus.
CompletableFuture<Void>	disconnect() Disconnect the command bus for receiving commands from Axon Server, by unsubscribing all registered command handlers.
<C> void	dispatch(org.axonframework.commandhandling.CommandMessage<C> command)
<C,R> void	dispatch(org.axonframework.commandhandling.CommandMessage<C> commandMessage, org.axonframework.commandhandling.CommandCallback<? super C,? super R> commandCallback)
org.axonframework.commandhandling.CommandBus	localSegment()
org.axonframework.common.Registration	registerDispatchInterceptor(org.axonframework.messaging.MessageDispatchInterceptor<? super org.axonframework.commandhandling.CommandMessage<?>> dispatchInterceptor)
org.axonframework.common.Registration	registerHandlerInterceptor(org.axonframework.messaging.MessageHandlerInterceptor<? super org.axonframework.commandhandling.CommandMessage<?>> handlerInterceptor)
CompletableFuture<Void>	shutdownDispatching() Shutdown the command bus asynchronously for dispatching commands to Axon Server.
void	start() Start the Axon Server CommandBus implementation.
org.axonframework.common.Registration	subscribe(String commandName, org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>> messageHandler)

Methods inherited from class java.lang.Object

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

Constructor Detail

AxonServerCommandBus

public AxonServerCommandBus(AxonServerCommandBus.Builder builder)

Instantiate a AxonServerCommandBus based on the fields contained in the AxonServerCommandBus.Builder.

Parameters:

builder - the AxonServerCommandBus.Builder used to instantiate a AxonServerCommandBus instance

Method Detail

builder

public static AxonServerCommandBus.Builder builder()

Instantiate a Builder to be able to create an AxonServerCommandBus.

The CommandPriorityCalculator is defaulted to CommandPriorityCalculator.defaultCommandPriorityCalculator() and the TargetContextResolver defaults to a lambda returning the AxonServerConfiguration.getContext() as the context. The ExecutorServiceBuilder defaults to ExecutorServiceBuilder.defaultCommandExecutorServiceBuilder(). The AxonServerConnectionManager, the AxonServerConfiguration, the local CommandBus, Serializer and the RoutingStrategy are a hard requirements and as such should be provided.

Returns:

a Builder to be able to create a AxonServerCommandBus

start

@StartHandler(phase=536870911)
public void start()

Start the Axon Server CommandBus implementation.

dispatch

public <C> void dispatch(org.axonframework.commandhandling.CommandMessage<C> command)

Specified by:

dispatch in interface org.axonframework.commandhandling.CommandBus

dispatch

public <C,R> void dispatch(org.axonframework.commandhandling.CommandMessage<C> commandMessage,
                           org.axonframework.commandhandling.CommandCallback<? super C,? super R> commandCallback)

Specified by:

dispatch in interface org.axonframework.commandhandling.CommandBus

subscribe

public org.axonframework.common.Registration subscribe(String commandName,
                                                       org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>> messageHandler)

Specified by:

subscribe in interface org.axonframework.commandhandling.CommandBus

localSegment

public org.axonframework.commandhandling.CommandBus localSegment()

Specified by:

localSegment in interface org.axonframework.messaging.Distributed<org.axonframework.commandhandling.CommandBus>

registerHandlerInterceptor

public org.axonframework.common.Registration registerHandlerInterceptor(org.axonframework.messaging.MessageHandlerInterceptor<? super org.axonframework.commandhandling.CommandMessage<?>> handlerInterceptor)

Specified by:

registerHandlerInterceptor in interface org.axonframework.messaging.MessageHandlerInterceptorSupport<org.axonframework.commandhandling.CommandMessage<?>>

registerDispatchInterceptor

public org.axonframework.common.Registration registerDispatchInterceptor(org.axonframework.messaging.MessageDispatchInterceptor<? super org.axonframework.commandhandling.CommandMessage<?>> dispatchInterceptor)

Specified by:

registerDispatchInterceptor in interface org.axonframework.messaging.MessageDispatchInterceptorSupport<org.axonframework.commandhandling.CommandMessage<?>>

disconnect

@ShutdownHandler(phase=536870911)
public CompletableFuture<Void> disconnect()

Disconnect the command bus for receiving commands from Axon Server, by unsubscribing all registered command handlers. This shutdown operation is performed in the Phase.INBOUND_COMMAND_CONNECTOR phase.

shutdownDispatching

@ShutdownHandler(phase=0)
public CompletableFuture<Void> shutdownDispatching()

Shutdown the command bus asynchronously for dispatching commands to Axon Server. This process will wait for dispatched commands which have not received a response yet. This shutdown operation is performed in the Phase.OUTBOUND_COMMAND_CONNECTORS phase.

Returns:

a completable future which is resolved once all command dispatching activities are completed