Package de.otto.synapse.endpoint

Class AbstractMessageEndpoint

java.lang.Object
de.otto.synapse.endpoint.AbstractMessageEndpoint
All Implemented Interfaces:
MessageEndpoint
Direct Known Subclasses:
AbstractMessageReceiverEndpoint, AbstractMessageSenderEndpoint
public abstract class AbstractMessageEndpoint extends Object implements MessageEndpoint
Endpoint that is used by an application to access the messaging infrastructure to send or receive messages.

Message Endpoint

The MessageEndpoint class is intended to derive message sender, message receiver or 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 Also:

  • Constructor Details

    • AbstractMessageEndpoint

      public AbstractMessageEndpoint(@Nonnull String channelName, @Nonnull MessageInterceptorRegistry interceptorRegistry)
      Constructor used to create a new AbstractMessageEndpoint.
      Parameters:
      channelName - the name of the underlying channel / stream / queue / message log.
      interceptorRegistry - registry used to determine message interceptors for this endpoint.

  • Method Details

    • getChannelName

      @Nonnull public final String getChannelName()
      Returns the name of the channel.

      The channel name corresponds to the name of the underlying stream, queue or message log.

      Specified by:
      getChannelName in interface MessageEndpoint
      Returns:
      name of the channel

    • getInterceptorChain

      @Nonnull public final InterceptorChain getInterceptorChain()
      Returns the InterceptorChain of the MessageEndpoint.
      Specified by:
      getInterceptorChain in interface MessageEndpoint
      Returns:
      InterceptorChain

    • intercept

      @Nullable public final TextMessage intercept(@Nonnull TextMessage message)
      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 null is returned, the message must be dropped by the AbstractMessageEndpoint.

      Every interceptor may transform the message, or may take additional actions like, for example, logging, monitoring or other things.

      Specified by:
      intercept in interface MessageEndpoint
      Parameters:
      message - the message to intercept
      Returns:
      the (possibly modified) message, or null if the message should be dropped.