org.axonframework.springcloud.commandhandling

Class SpringHttpCommandBusConnector

java.lang.Object

org.axonframework.springcloud.commandhandling.SpringHttpCommandBusConnector

All Implemented Interfaces:

CommandBusConnector, MessageHandlerInterceptorSupport<CommandMessage<?>>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SpringHttpCommandBusConnector.SpringHttpReplyFutureCallback<C,R>

Constructor Summary

Constructors

Constructor and Description
SpringHttpCommandBusConnector(CommandBus localCommandBus, org.springframework.web.client.RestOperations restOperations, Serializer serializer)

Method Summary

Modifier and Type	Method and Description
<C,R> CompletableFuture<?>	receiveCommand(SpringHttpDispatchMessage<C> dispatchMessage)
Registration	registerHandlerInterceptor(MessageHandlerInterceptor<? super CommandMessage<?>> handlerInterceptor) Register the given handlerInterceptor.
<C> void	send(Member destination, CommandMessage<? extends C> commandMessage) Sends the given command to the node assigned to handle messages with the given routingKey.
<C,R> void	send(Member destination, CommandMessage<C> commandMessage, CommandCallback<? super C,R> callback) Sends the given command to the node assigned to handle messages with the given routingKey.
Registration	subscribe(String commandName, MessageHandler<? super CommandMessage<?>> handler) Subscribes a command message handler for commands with given commandName.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringHttpCommandBusConnector

public SpringHttpCommandBusConnector(CommandBus localCommandBus,
                                     org.springframework.web.client.RestOperations restOperations,
                                     Serializer serializer)

Method Detail

send

public <C> void send(Member destination,
                     CommandMessage<? extends C> commandMessage)

Description copied from interface: CommandBusConnector

Sends the given command to the node assigned to handle messages with the given routingKey. The sender does not expect a reply.

If this method throws an exception, the sender is guaranteed that the destination of the command did not receive it. If the method returns normally, the actual implementation of the connector defines the delivery guarantees.

Connectors route the commands based on the given routingKey. Using the same routingKey will result in the command being sent to the same member. Each message must be sent to exactly one member.

Specified by:

send in interface CommandBusConnector

Parameters:

destination - The member of the network to send the message to

commandMessage - The command to send to the (remote) member

send

public <C,R> void send(Member destination,
                       CommandMessage<C> commandMessage,
                       CommandCallback<? super C,R> callback)

Description copied from interface: CommandBusConnector

Sends the given command to the node assigned to handle messages with the given routingKey. The sender expect a reply, and will be notified of the result in the given callback.

If this method throws an exception, the sender is guaranteed that the destination of the command did not receive it. If the method returns normally, the actual implementation of the connector defines the delivery guarantees. Implementations should always invoke the callback with an outcome.

If a member's connection was lost, and the result of the command is unclear, the CommandCallback.onFailure(org.axonframework.commandhandling.CommandMessage, Throwable) method is invoked with a RemoteCommandHandlingException describing the failed connection. A client may choose to resend a command.

Connectors route the commands based on the given routingKey. Using the same routingKey will result in the command being sent to the same member.

Specified by:

send in interface CommandBusConnector

Type Parameters:

C - The type of object expected as command

R - The type of object expected as result of the command

Parameters:

destination - The member of the network to send the message to

commandMessage - The command to send to the (remote) member

callback - The callback

subscribe

public Registration subscribe(String commandName,
                              MessageHandler<? super CommandMessage<?>> handler)

Description copied from interface: CommandBusConnector

Subscribes a command message handler for commands with given commandName.

Specified by:

subscribe in interface CommandBusConnector

Parameters:

commandName - the command name. Usually this equals the fully qualified class name of the command.

handler - the handler to subscribe

Returns:

a handle that can be used to end the subscription

receiveCommand

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

registerHandlerInterceptor

public Registration registerHandlerInterceptor(MessageHandlerInterceptor<? super CommandMessage<?>> handlerInterceptor)

Description copied from interface: MessageHandlerInterceptorSupport

Register the given handlerInterceptor. After registration, the interceptor will be invoked for each handled Message on the messaging component that it was registered to, prior to invoking the message's handler.

Specified by:

registerHandlerInterceptor in interface MessageHandlerInterceptorSupport<CommandMessage<?>>

Parameters:

handlerInterceptor - The interceptor to register

Returns:

a Registration, which may be used to remove the unregister the interceptor