org.axonframework.spring.messaging

Class InboundEventMessageChannelAdapter

java.lang.Object

org.axonframework.spring.messaging.InboundEventMessageChannelAdapter

All Implemented Interfaces:

SubscribableMessageSource<EventMessage<?>>, org.springframework.messaging.MessageHandler

public class InboundEventMessageChannelAdapter
extends Object
implements org.springframework.messaging.MessageHandler, SubscribableMessageSource<EventMessage<?>>

Adapter class that publishes Events from a Spring Messaging Message Channel on the Event Bus. All events are expected to be contained in the payload of the Message instances.

Optionally, this adapter can be configured with a filter, which can block or accept messages based on their type.

Since:

3.0

Author:

Allard Buijze

Constructor Summary

Constructors

Constructor and Description
InboundEventMessageChannelAdapter() Initialize the adapter to publish all incoming events to the subscribed processors.
InboundEventMessageChannelAdapter(EventBus eventBus) Initialize an InboundEventMessageChannelAdapter instance that sends all incoming Event Messages to the given eventBus.
InboundEventMessageChannelAdapter(List<Consumer<List<? extends EventMessage<?>>>> processors, EventMessageConverter eventMessageConverter) Initialize the adapter to publish all incoming events to the subscribed processors.

Method Summary

Modifier and Type	Method and Description
void	handleMessage(org.springframework.messaging.Message<?> message) Handles the given message.
Registration	subscribe(Consumer<List<? extends EventMessage<?>>> messageProcessor) Subscribe the given messageProcessor to this message source.
protected EventMessage<?>	transformMessage(org.springframework.messaging.Message<?> message) Transforms the given incoming Spring Messaging message to an Axon EventMessage.

Methods inherited from class java.lang.Object

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

Constructor Detail

InboundEventMessageChannelAdapter

public InboundEventMessageChannelAdapter()

Initialize the adapter to publish all incoming events to the subscribed processors. Note that this instance should be registered as a consumer of a Spring Message Channel.

InboundEventMessageChannelAdapter

public InboundEventMessageChannelAdapter(EventBus eventBus)

Initialize an InboundEventMessageChannelAdapter instance that sends all incoming Event Messages to the given eventBus. It is still possible for other Event Processors to subscribe to this MessageChannelAdapter.

Parameters:

eventBus - The EventBus instance for forward all messages to

InboundEventMessageChannelAdapter

public InboundEventMessageChannelAdapter(List<Consumer<List<? extends EventMessage<?>>>> processors,
                                         EventMessageConverter eventMessageConverter)

Initialize the adapter to publish all incoming events to the subscribed processors. Note that this instance should be registered as a consumer of a Spring Message Channel.

Parameters:

processors - Processors to be subscribed

eventMessageConverter - The message converter to use to convert spring message into event message

Method Detail

subscribe

@Nonnull
public Registration subscribe(@Nonnull
                                       Consumer<List<? extends EventMessage<?>>> messageProcessor)

Description copied from interface: SubscribableMessageSource

Subscribe the given messageProcessor to this message source. When subscribed, it will receive all messages published to this source.

If the given messageProcessor is already subscribed, nothing happens.

Specified by:

subscribe in interface SubscribableMessageSource<EventMessage<?>>

Parameters:

messageProcessor - The message processor to subscribe

Returns:

a handle to unsubscribe the messageProcessor. When unsubscribed it will no longer receive messages.

handleMessage

public void handleMessage(@Nonnull
                          org.springframework.messaging.Message<?> message)

Handles the given message. If the filter refuses the message, it is ignored.

Specified by:

handleMessage in interface org.springframework.messaging.MessageHandler

Parameters:

message - The message containing the event to publish

transformMessage

protected EventMessage<?> transformMessage(org.springframework.messaging.Message<?> message)

Transforms the given incoming Spring Messaging message to an Axon EventMessage. This method may be overridden to change how messages are translated between the two frameworks.

Parameters:

message - the Spring message to convert to an event

Returns:

an EventMessage from given Spring message