org.axonframework.extensions.springcloud.commandhandling

Class SpringHttpCommandBusConnector

java.lang.Object

org.axonframework.extensions.springcloud.commandhandling.SpringHttpCommandBusConnector

All Implemented Interfaces:

org.axonframework.commandhandling.distributed.CommandBusConnector, org.axonframework.messaging.MessageHandlerInterceptorSupport<org.axonframework.commandhandling.CommandMessage<?>>

@RestController
 @RequestMapping(value="/spring-command-bus-connector")
public class SpringHttpCommandBusConnector
extends Object
implements org.axonframework.commandhandling.distributed.CommandBusConnector

A CommandBusConnector implementation based on Spring Rest characteristics. Serves as a RestController to receive Command Messages for its node, but also contains a RestOperations component to send Command Messages to other nodes. Will use a localCommandBus of type CommandBus to publish any received Command Messages to its local instance. Messages are de-/serialized using a Serializer. Lastly, an Executor is used to make command handling and dispatching asynchronous, given that the configured Executor use different threads or spawns new threads.

Since:

3.0

Author:

Steven van Beelen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpringHttpCommandBusConnector.Builder Builder class to instantiate a SpringHttpCommandBusConnector.
class	SpringHttpCommandBusConnector.SpringHttpReplyFutureCallback<C,R>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static SpringHttpCommandBusConnector.Builder	builder() Instantiate a Builder to be able to create a SpringHttpCommandBusConnector.
CompletableFuture<Void>	initiateShutdown()
Optional<org.axonframework.commandhandling.CommandBus>	localSegment()
<C,R> CompletableFuture<?>	receiveCommand(SpringHttpDispatchMessage<C> dispatchMessage)
org.axonframework.common.Registration	registerHandlerInterceptor(org.axonframework.messaging.MessageHandlerInterceptor<? super org.axonframework.commandhandling.CommandMessage<?>> handlerInterceptor)
<C> void	send(org.axonframework.commandhandling.distributed.Member destination, org.axonframework.commandhandling.CommandMessage<? extends C> commandMessage)
<C,R> void	send(org.axonframework.commandhandling.distributed.Member destination, org.axonframework.commandhandling.CommandMessage<C> commandMessage, org.axonframework.commandhandling.CommandCallback<? super C,R> callback)
void	start() Start the Connector.
org.axonframework.common.Registration	subscribe(String commandName, org.axonframework.messaging.MessageHandler<? super org.axonframework.commandhandling.CommandMessage<?>> handler)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringHttpCommandBusConnector

protected SpringHttpCommandBusConnector(SpringHttpCommandBusConnector.Builder builder)

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

Will assert that the localCommandBus of type (@link CommandBus}, RestOperations and Serializer are not null, and will throw an AxonConfigurationException if any of them is null.

Parameters:

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

Method Detail

start

@StartHandler(phase=-134217728)
public void start()

Start the Connector.

builder

public static SpringHttpCommandBusConnector.Builder builder()

Instantiate a Builder to be able to create a SpringHttpCommandBusConnector.

The Executor is defaulted to a DirectExecutor.INSTANCE and the SpanFactory to a NoOpSpanFactory instance. The localCommandBus of type (@link CommandBus}, the RestOperations and the Serializer are hard requirements and as such should be provided.

Returns:

a Builder to be able to create a SpringHttpCommandBusConnector

send

public <C> void send(org.axonframework.commandhandling.distributed.Member destination,
                     @Nonnull
                     org.axonframework.commandhandling.CommandMessage<? extends C> commandMessage)

Specified by:

send in interface org.axonframework.commandhandling.distributed.CommandBusConnector

send

public <C,R> void send(org.axonframework.commandhandling.distributed.Member destination,
                       @Nonnull
                       org.axonframework.commandhandling.CommandMessage<C> commandMessage,
                       @Nonnull
                       org.axonframework.commandhandling.CommandCallback<? super C,R> callback)

Specified by:

send in interface org.axonframework.commandhandling.distributed.CommandBusConnector

initiateShutdown

public CompletableFuture<Void> initiateShutdown()

Specified by:

initiateShutdown in interface org.axonframework.commandhandling.distributed.CommandBusConnector

subscribe

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

Specified by:

subscribe in interface org.axonframework.commandhandling.distributed.CommandBusConnector

localSegment

public Optional<org.axonframework.commandhandling.CommandBus> localSegment()

Specified by:

localSegment in interface org.axonframework.commandhandling.distributed.CommandBusConnector

receiveCommand

@PostMapping(value="/command")
public <C,R> CompletableFuture<?> receiveCommand(@RequestBody
                                                                                SpringHttpDispatchMessage<C> dispatchMessage)

registerHandlerInterceptor

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

Specified by:

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