org.springframework.messaging.simp.config

Class AbstractMessageBrokerConfiguration

java.lang.Object

org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration

Direct Known Subclasses:

WebSocketMessageBrokerConfigurationSupport

public abstract class AbstractMessageBrokerConfiguration
extends Object

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

clientInboundChannel() and clientOutboundChannel() deliver messages to and from remote clients to several message handlers such as

• simpAnnotationMethodMessageHandler()
• simpleBrokerMessageHandler()
• stompBrokerRelayMessageHandler()
• userDestinationMessageHandler()

while brokerChannel() delivers messages from within the application to the the respective message handlers. brokerMessagingTemplate() can be injected into any application component to send messages.

Sub-classes are responsible for the part of the configuration that feed messages to and from the client inbound/outbound channels (e.g. STOMP over WebSocket).

Since:

4.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMessageBrokerConfiguration() Protected constructor.

Method Summary

Modifier and Type	Method and Description
AbstractSubscribableChannel	brokerChannel()
ThreadPoolTaskExecutor	brokerChannelExecutor()
CompositeMessageConverter	brokerMessageConverter()
SimpMessagingTemplate	brokerMessagingTemplate()
AbstractSubscribableChannel	clientInboundChannel()
ThreadPoolTaskExecutor	clientInboundChannelExecutor()
AbstractSubscribableChannel	clientOutboundChannel()
ThreadPoolTaskExecutor	clientOutboundChannelExecutor()
protected abstract void	configureClientInboundChannel(ChannelRegistration registration) A hook for sub-classes to customize the message channel for inbound messages from WebSocket clients.
protected abstract void	configureClientOutboundChannel(ChannelRegistration registration) A hook for sub-classes to customize the message channel for messages from the application or message broker to WebSocket clients.
protected abstract void	configureMessageBroker(MessageBrokerRegistry registry) A hook for sub-classes to customize message broker configuration through the provided MessageBrokerRegistry instance.
protected MessageBrokerRegistry	getBrokerRegistry() An accessor for the MessageBrokerRegistry that ensures its one-time creation and initialization through configureMessageBroker(MessageBrokerRegistry).
protected ChannelRegistration	getClientInboundChannelRegistration()
protected ChannelRegistration	getClientOutboundChannelRegistration()
SimpAnnotationMethodMessageHandler	simpAnnotationMethodMessageHandler()
AbstractBrokerMessageHandler	simpleBrokerMessageHandler()
AbstractBrokerMessageHandler	stompBrokerRelayMessageHandler()
UserDestinationMessageHandler	userDestinationMessageHandler()
UserDestinationResolver	userDestinationResolver()
UserSessionRegistry	userSessionRegistry()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMessageBrokerConfiguration

protected AbstractMessageBrokerConfiguration()

Protected constructor.

Method Detail

clientInboundChannel

@Bean
public AbstractSubscribableChannel clientInboundChannel()

clientInboundChannelExecutor

@Bean
public ThreadPoolTaskExecutor clientInboundChannelExecutor()

getClientInboundChannelRegistration

protected final ChannelRegistration getClientInboundChannelRegistration()

configureClientInboundChannel

protected abstract void configureClientInboundChannel(ChannelRegistration registration)

A hook for sub-classes to customize the message channel for inbound messages from WebSocket clients.

clientOutboundChannel

@Bean
public AbstractSubscribableChannel clientOutboundChannel()

clientOutboundChannelExecutor

@Bean
public ThreadPoolTaskExecutor clientOutboundChannelExecutor()

getClientOutboundChannelRegistration

protected final ChannelRegistration getClientOutboundChannelRegistration()

configureClientOutboundChannel

protected abstract void configureClientOutboundChannel(ChannelRegistration registration)

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

brokerChannel

@Bean
public AbstractSubscribableChannel brokerChannel()

brokerChannelExecutor

@Bean
public ThreadPoolTaskExecutor brokerChannelExecutor()

getBrokerRegistry

protected final MessageBrokerRegistry getBrokerRegistry()

An accessor for the MessageBrokerRegistry that ensures its one-time creation and initialization through configureMessageBroker(MessageBrokerRegistry).

configureMessageBroker

protected abstract void configureMessageBroker(MessageBrokerRegistry registry)

A hook for sub-classes to customize message broker configuration through the provided MessageBrokerRegistry instance.

simpAnnotationMethodMessageHandler

@Bean
public SimpAnnotationMethodMessageHandler simpAnnotationMethodMessageHandler()

simpleBrokerMessageHandler

@Bean
public AbstractBrokerMessageHandler simpleBrokerMessageHandler()

stompBrokerRelayMessageHandler

@Bean
public AbstractBrokerMessageHandler stompBrokerRelayMessageHandler()

userDestinationMessageHandler

@Bean
public UserDestinationMessageHandler userDestinationMessageHandler()

brokerMessagingTemplate

@Bean
public SimpMessagingTemplate brokerMessagingTemplate()

brokerMessageConverter

@Bean
public CompositeMessageConverter brokerMessageConverter()

userDestinationResolver

@Bean
public UserDestinationResolver userDestinationResolver()

userSessionRegistry

@Bean
public UserSessionRegistry userSessionRegistry()