org.axonframework.spring.messaging.OutboundEventMessageChannelAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of axon-spring Show documentation
Module providing Spring specific helper functionality to ease configuration / set-up of an Axon application, as well as some Spring specific infrastructure components.
The newest version!
/*
 * Copyright (c) 2010-2022. Axon Framework
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.axonframework.spring.messaging;

import org.axonframework.eventhandling.EventMessage;
import org.axonframework.messaging.SubscribableMessageSource;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageChannel;
import org.springframework.messaging.support.GenericMessage;

import java.util.List;
import java.util.function.Predicate;

/**
 * Adapter class that sends Events from an event bus to a Spring Messaging Message Channel. All events are wrapped in
 * GenericMessage instances. The adapter automatically subscribes itself to the provided {@code EventBus}.
 * 
 * Optionally, this adapter can be configured with a filter, which can block or accept messages based on their type.
 *
 * @author Allard Buijze
 * @since 2.3.1
 */
public class OutboundEventMessageChannelAdapter implements InitializingBean {

    private final MessageChannel channel;
    private final Predicate> filter;
    private final SubscribableMessageSource> messageSource;
    private final EventMessageConverter eventMessageConverter;

    /**
     * Initialize an adapter to forward messages from the given {@code messageSource} to the given {@code channel}.
     * Messages are not filtered; all messages are forwarded to the MessageChannel
     *
     * @param messageSource The event bus to subscribe to.
     * @param channel       The channel to send event messages to.
     */
    public OutboundEventMessageChannelAdapter(SubscribableMessageSource> messageSource,
                                              MessageChannel channel) {
        this(messageSource, channel, m -> true);
    }

    /**
     * Initialize an adapter to forward messages from the given {@code messageSource} to the given {@code channel}.
     * Messages are filtered using the given {@code filter}.
     *
     * @param messageSource The source of messages to subscribe to.
     * @param channel       The channel to send event messages to.
     * @param filter        The filter that indicates which messages to forward.
     */
    public OutboundEventMessageChannelAdapter(SubscribableMessageSource> messageSource,
                                              MessageChannel channel, Predicate> filter) {
        this(messageSource, channel, filter, new DefaultEventMessageConverter());
    }

    /**
     * Initialize an adapter to forward messages from the given {@code messageSource} to the given {@code channel}.
     * Messages are filtered using the given {@code filter}.
     *
     * @param messageSource The source of messages to subscribe to.
     * @param channel       The channel to send event messages to.
     * @param filter        The filter that indicates which messages to forward.
     * @param eventMessageConverter The converter to use to convert event message into Spring message
     */
    public OutboundEventMessageChannelAdapter(SubscribableMessageSource> messageSource,
                                              MessageChannel channel, Predicate> filter,
                                              EventMessageConverter eventMessageConverter) {
        this.channel = channel;
        this.messageSource = messageSource;
        this.filter = filter;
        this.eventMessageConverter = eventMessageConverter;
    }

    /**
     * Subscribes this event listener to the event bus.
     */
    @Override
    public void afterPropertiesSet() {
        messageSource.subscribe(this::handle);
    }

    /**
     * If allows by the filter, wraps the given {@code event} in a {@link GenericMessage} ands sends it to the
     * configured {@link MessageChannel}.
     *
     * @param events the events to handle
     */
    protected void handle(List> events) {
        events.stream()
                .filter(filter::test)
                .forEach(event -> channel.send(transform(event)));
    }

    /**
     * Transforms the given Axon {@code event} into a Spring Messaging Message. This method may be overridden to change
     * how this transformation should occur.
     *
     * @param event The Axon EventMessage to transform
     * @return The Spring Messaging Message representing the Event Message
     */
    protected Message transform(EventMessage event) {
        return eventMessageConverter.convertToOutboundMessage(event);
    }
}