AbstractMessageBrokerConfiguration

Provides essential configuration for handling messages with simple messaging protocols such as STOMP.

<p>{@link #clientInboundChannel()} and {@link #clientOutboundChannel()} deliver messages to and from remote clients to several message handlers such as <ul> <li>{@link #simpAnnotationMethodMessageHandler()}</li> <li>{@link #simpleBrokerMessageHandler()}</li> <li>{@link #stompBrokerRelayMessageHandler()}</li> <li>{@link #userDestinationMessageHandler()}</li> </ul> while {@link #brokerChannel()} delivers messages from within the application to the the respective message handlers. {@link #brokerMessagingTemplate()} can be injected into any application component to send messages.

<p>Subclasses are responsible for the part of the configuration that feed messages to and from the client inbound/outbound channels (e.g. STOMP over WebSocket).

@author Rossen Stoyanchev @author Brian Clozel @since 4.0

Members

Functions

brokerChannel
AbstractSubscribableChannel brokerChannel()
Undocumented in source. Be warned that the author may not have intended to support it.
brokerMessageConverter
CompositeMessageConverter brokerMessageConverter()
Undocumented in source. Be warned that the author may not have intended to support it.
brokerMessagingTemplate
SimpMessagingTemplate brokerMessagingTemplate()
Undocumented in source. Be warned that the author may not have intended to support it.
clientInboundChannel
AbstractSubscribableChannel clientInboundChannel()

Protected constructor.

clientOutboundChannel
AbstractSubscribableChannel clientOutboundChannel()
Undocumented in source. Be warned that the author may not have intended to support it.
configureClientInboundChannel
void configureClientInboundChannel(ChannelRegistration registration)

A hook for subclasses to customize the message channel for inbound messages from WebSocket clients.

configureClientOutboundChannel
void configureClientOutboundChannel(ChannelRegistration registration)

A hook for subclasses to customize the message channel for messages from the application or message broker to WebSocket clients.

configureMessageBroker
void configureMessageBroker(MessageBrokerRegistry registry)

A hook for subclasses to customize message broker configuration through the provided {@link MessageBrokerRegistry} instance.

configureMessageConverters
bool configureMessageConverters(MessageConverter[] messageConverters)

Override this method to add custom message converters. @param messageConverters the list to add converters to, initially empty @return {@code true} if default message converters should be added to list, {@code false} if no more converters should be added.

createAnnotationMethodMessageHandler
SimpAnnotationMethodMessageHandler createAnnotationMethodMessageHandler()

Protected method for plugging in a custom subclass of {@link hunt.stomp.simp.annotation.SimpAnnotationMethodMessageHandler SimpAnnotationMethodMessageHandler}. @since 4.2

createJsonConverter
JsonMessageConverter createJsonConverter()
Undocumented in source. Be warned that the author may not have intended to support it.
getBrokerRegistry
MessageBrokerRegistry getBrokerRegistry()

An accessor for the {@link MessageBrokerRegistry} that ensures its one-time creation and initialization through {@link #configureMessageBroker(MessageBrokerRegistry)}.

getClientInboundChannelRegistration
ChannelRegistration getClientInboundChannelRegistration()
Undocumented in source. Be warned that the author may not have intended to support it.
getClientOutboundChannelRegistration
ChannelRegistration getClientOutboundChannelRegistration()
Undocumented in source. Be warned that the author may not have intended to support it.
getPathMatcher
PathMatcher getPathMatcher()

Provide access to the configured PatchMatcher for access from other configuration classes.

simpAnnotationMethodMessageHandler
SimpAnnotationMethodMessageHandler simpAnnotationMethodMessageHandler()
Undocumented in source. Be warned that the author may not have intended to support it.
simpleBrokerMessageHandler
AbstractBrokerMessageHandler simpleBrokerMessageHandler()
Undocumented in source. Be warned that the author may not have intended to support it.
stompBrokerRelayMessageHandler
AbstractBrokerMessageHandler stompBrokerRelayMessageHandler()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta