Uses of Interface
org.springframework.messaging.MessageChannel
Package
Description
Support for working with messaging APIs and protocols.
Defines interfaces and implementation classes for messaging templates.
Generic support for Simple Messaging Protocols including protocols such as STOMP.
Support classes for handling messages from simple messaging protocols
(like STOMP).
Provides a "simple" message broker implementation along with an abstract base
class and other supporting types such as a registry for subscriptions.
Configuration support for WebSocket messaging using higher level messaging protocols.
Generic support for simple messaging protocols (like STOMP).
Provides implementations of
Message
along with
a MessageBuilder and MessageHeaderAccessor for building and working with messages and
message headers, as well as various MessageChannel
implementations and channel interceptor support.WebSocket integration for Spring's messaging module.
-
Uses of MessageChannel in org.springframework.messaging
Modifier and TypeInterfaceDescriptioninterface
AMessageChannel
from which messages may be actively received through polling.interface
AMessageChannel
that maintains a registry of subscribers and invokes them to handle messages sent through this channel. -
Uses of MessageChannel in org.springframework.messaging.core
Modifier and TypeMethodDescriptionBeanFactoryMessageChannelDestinationResolver.resolveDestination
(String name) Modifier and TypeMethodDescriptionprotected final Message<?>
GenericMessagingTemplate.doReceive
(MessageChannel channel) protected final Message<?>
GenericMessagingTemplate.doReceive
(MessageChannel channel, long timeout) protected final void
GenericMessagingTemplate.doSend
(MessageChannel channel, Message<?> message) protected final void
GenericMessagingTemplate.doSend
(MessageChannel channel, Message<?> message, long timeout) protected final Message<?>
GenericMessagingTemplate.doSendAndReceive
(MessageChannel channel, Message<?> requestMessage) -
Uses of MessageChannel in org.springframework.messaging.simp
Modifier and TypeMethodDescriptionSimpMessagingTemplate.getMessageChannel()
Return the configured message channel.ModifierConstructorDescriptionSimpMessagingTemplate
(MessageChannel messageChannel) Create a newSimpMessagingTemplate
instance. -
Uses of MessageChannel in org.springframework.messaging.simp.annotation.support
ModifierConstructorDescriptionSimpAnnotationMethodMessageHandler
(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, SimpMessageSendingOperations brokerTemplate) Create an instance of SimpAnnotationMethodMessageHandler with the given message channels and broker messaging template. -
Uses of MessageChannel in org.springframework.messaging.simp.broker
Modifier and TypeClassDescriptionclass
Decorator for anExecutorSubscribableChannel
that ensures messages are processed in the order they were published to the channel.Modifier and TypeMethodDescriptionAbstractBrokerMessageHandler.getClientOutboundChannel()
protected MessageChannel
AbstractBrokerMessageHandler.getClientOutboundChannelForSession
(String sessionId) Get the MessageChannel to use for sending messages to clients, possibly a per-session wrapper whenpreservePublishOrder=true
.Modifier and TypeMethodDescriptionstatic void
OrderedMessageChannelDecorator.configureInterceptor
(MessageChannel channel, boolean preserveOrder) Install or remove anExecutorChannelInterceptor
that invokes a completion task, if found in the headers of the message.static boolean
OrderedMessageChannelDecorator.supportsOrderedMessages
(MessageChannel channel) Whether the channel has beenconfigured
with an interceptor for sequential handling.ModifierConstructorDescriptionAbstractBrokerMessageHandler
(SubscribableChannel inboundChannel, MessageChannel outboundChannel, SubscribableChannel brokerChannel) Constructor with no destination prefixes (matches all destinations).AbstractBrokerMessageHandler
(SubscribableChannel inboundChannel, MessageChannel outboundChannel, SubscribableChannel brokerChannel, Collection<String> destinationPrefixes) Constructor with destination prefixes to match to destinations of messages.OrderedMessageChannelDecorator
(MessageChannel channel, Log logger) SimpleBrokerMessageHandler
(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, SubscribableChannel brokerChannel, Collection<String> destinationPrefixes) Create a SimpleBrokerMessageHandler instance with the given message channels and destination prefixes. -
Uses of MessageChannel in org.springframework.messaging.simp.config
Modifier and TypeMethodDescriptionprotected MessageChannel
AbstractBrokerRegistration.getClientOutboundChannel()
ModifierConstructorDescriptionAbstractBrokerRegistration
(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, String[] destinationPrefixes) Create a new broker registration.MessageBrokerRegistry
(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel) SimpleBrokerRegistration
(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, String[] destinationPrefixes) Create a newSimpleBrokerRegistration
.StompBrokerRelayRegistration
(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, String[] destinationPrefixes) Create a newStompBrokerRelayRegistration
. -
Uses of MessageChannel in org.springframework.messaging.simp.stomp
ModifierConstructorDescriptionStompBrokerRelayMessageHandler
(SubscribableChannel inboundChannel, MessageChannel outboundChannel, SubscribableChannel brokerChannel, Collection<String> destinationPrefixes) Create a StompBrokerRelayMessageHandler instance with the given message channels and destination prefixes. -
Uses of MessageChannel in org.springframework.messaging.support
Modifier and TypeClassDescriptionclass
Abstract base class forMessageChannel
implementations.class
Abstract base class forSubscribableChannel
implementations.class
ASubscribableChannel
that sends messages to each of its subscribers.Modifier and TypeMethodDescriptiondefault void
ExecutorChannelInterceptor.afterMessageHandled
(Message<?> message, MessageChannel channel, MessageHandler handler, Exception ex) Invoked inside theRunnable
submitted to the Executor after calling the target MessageHandler regardless of the outcome (i.e.default void
ChannelInterceptor.afterReceiveCompletion
(Message<?> message, MessageChannel channel, Exception ex) Invoked after the completion of a receive regardless of any exception that have been raised thus allowing for proper resource cleanup.default void
ChannelInterceptor.afterSendCompletion
(Message<?> message, MessageChannel channel, boolean sent, Exception ex) Invoked after the completion of a send regardless of any exception that have been raised thus allowing for proper resource cleanup.Message<?>
AbstractMessageChannel.ChannelInterceptorChain.applyPostReceive
(Message<?> message, MessageChannel channel) void
AbstractMessageChannel.ChannelInterceptorChain.applyPostSend
(Message<?> message, MessageChannel channel, boolean sent) boolean
AbstractMessageChannel.ChannelInterceptorChain.applyPreReceive
(MessageChannel channel) Message<?>
AbstractMessageChannel.ChannelInterceptorChain.applyPreSend
(Message<?> message, MessageChannel channel) default Message<?>
ExecutorChannelInterceptor.beforeHandle
(Message<?> message, MessageChannel channel, MessageHandler handler) Invoked inside theRunnable
submitted to the Executor just before calling the target MessageHandler to handle the message.default Message<?>
ChannelInterceptor.postReceive
(Message<?> message, MessageChannel channel) Invoked immediately after a Message has been retrieved but before it is returned to the caller.default void
ChannelInterceptor.postSend
(Message<?> message, MessageChannel channel, boolean sent) Invoked immediately after the send invocation.default boolean
ChannelInterceptor.preReceive
(MessageChannel channel) Invoked as soon as receive is called and before a Message is actually retrieved.default Message<?>
ChannelInterceptor.preSend
(Message<?> message, MessageChannel channel) Invoked before the Message is actually sent to the channel.Message<?>
ImmutableMessageChannelInterceptor.preSend
(Message<?> message, MessageChannel channel) MessageBuilder.setErrorChannel
(MessageChannel errorChannel) void
MessageHeaderAccessor.setErrorChannel
(MessageChannel errorChannel) MessageBuilder.setReplyChannel
(MessageChannel replyChannel) void
MessageHeaderAccessor.setReplyChannel
(MessageChannel replyChannel) void
AbstractMessageChannel.ChannelInterceptorChain.triggerAfterReceiveCompletion
(Message<?> message, MessageChannel channel, Exception ex) void
AbstractMessageChannel.ChannelInterceptorChain.triggerAfterSendCompletion
(Message<?> message, MessageChannel channel, boolean sent, Exception ex) -
Uses of MessageChannel in org.springframework.web.socket.messaging
Modifier and TypeMethodDescriptionvoid
StompSubProtocolHandler.afterSessionEnded
(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel) void
SubProtocolHandler.afterSessionEnded
(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel) Invoked after aWebSocketSession
has ended.void
StompSubProtocolHandler.afterSessionStarted
(WebSocketSession session, MessageChannel outputChannel) void
SubProtocolHandler.afterSessionStarted
(WebSocketSession session, MessageChannel outputChannel) Invoked after aWebSocketSession
has started.void
StompSubProtocolHandler.handleMessageFromClient
(WebSocketSession session, WebSocketMessage<?> webSocketMessage, MessageChannel targetChannel) Handle incoming WebSocket messages from clients.void
SubProtocolHandler.handleMessageFromClient
(WebSocketSession session, WebSocketMessage<?> message, MessageChannel outputChannel) Handle the givenWebSocketMessage
received from a client.ModifierConstructorDescriptionSubProtocolWebSocketHandler
(MessageChannel clientInboundChannel, SubscribableChannel clientOutboundChannel) Create a newSubProtocolWebSocketHandler
for the given inbound and outbound channels.WebSocketAnnotationMethodMessageHandler
(SubscribableChannel clientInChannel, MessageChannel clientOutChannel, SimpMessageSendingOperations brokerTemplate)