de.otto.synapse.endpoint.MessageEndpoint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of synapse-core Show documentation
A library used at otto.de to implement Spring Boot based event-sourcing microservices.
The newest version!
package de.otto.synapse.endpoint;

import de.otto.synapse.endpoint.receiver.MessageLogReceiverEndpoint;
import de.otto.synapse.endpoint.receiver.MessageQueueReceiverEndpoint;
import de.otto.synapse.endpoint.sender.MessageSenderEndpoint;
import de.otto.synapse.message.TextMessage;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;

/**
 * Endpoint that is used by an application to access the messaging infrastructure to send or receive messages.
 *
 * 
 *     
 * 
 * 
 *     The {@code MessageEndpoint} class is intended to derive {@link MessageSenderEndpoint message sender},
 *      {@link MessageQueueReceiverEndpoint message receiver} or
 *      {@link MessageLogReceiverEndpoint message-log receiver} endpoints.
 * 
 * 
 *     Message Endpoint code is custom to both the application and the messaging system’s client API.
 *     The rest of the application knows little about message formats, messaging channels, or any of
 *     the other details of communicating with other applications via messaging. It just knows that
 *     it has a request or piece of data to send to another application, or is expecting those from
 *     another application.
 * 
 * 
 *     It is the messaging endpoint code that takes that command or data, makes it into a message,
 *     and sends it on a particular messaging channel. It is the endpoint that receives a message,
 *     extracts the contents, and gives them to the application in a meaningful way.
 * 
 * @see EIP: Message Endpoint
 */
public interface MessageEndpoint {

    /**
     * Returns the name of the channel.
     *
     * 
     *     The channel name corresponds to the name of the underlying stream, queue or message log.
     * 
     * @return name of the channel
     */
    @Nonnull
    String getChannelName();

    /**
     * Returns the {@link InterceptorChain} of the {@code MessageEndpoint}.
     *
     * @return InterceptorChain
     */
    @Nonnull
    InterceptorChain getInterceptorChain();

    /**
     * Returns the type of the {@code MessageEndpoint}, either {@link EndpointType#SENDER} or
     * {@link EndpointType#RECEIVER}.
     *
     * @return EndpointType
     */
    @Nonnull
    EndpointType getEndpointType();

    /**
     * Intercepts a message using all registered interceptors and returns the resulting message.
     * 
     *     The interceptors are called in order. The result of one interceptor is propagated to the
     *     next interceptor in the chain, until the end of the chain is reached, or one interceptor
     *     has returned null.
     * 
     * 
     *     If {@code null} is returned, the message must be dropped by the {@link AbstractMessageEndpoint}.
     * 
     * 
     *     Every interceptor may transform the message, or may take additional actions like, for example,
     *     logging, monitoring or other things.
     * 
     *
     * @param message the message to intercept
     * @return the (possibly modified) message, or null if the message should be dropped.
     */
    @Nullable
    TextMessage intercept(@Nonnull TextMessage message);
}