org.springframework.messaging.simp.config

Class AbstractMessageBrokerConfiguration

java.lang.Object

org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration

All Implemented Interfaces:

Aware, ApplicationContextAware

Direct Known Subclasses:

WebSocketMessageBrokerConfigurationSupport

public abstract class AbstractMessageBrokerConfiguration
extends Object
implements ApplicationContextAware

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

clientInboundChannel(org.springframework.core.task.TaskExecutor) and clientOutboundChannel(org.springframework.core.task.TaskExecutor) deliver messages to and from remote clients to several message handlers such as the following.

• simpAnnotationMethodMessageHandler(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.simp.SimpMessagingTemplate, org.springframework.messaging.converter.CompositeMessageConverter)
• simpleBrokerMessageHandler(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.simp.user.UserDestinationResolver)
• stompBrokerRelayMessageHandler(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.simp.user.UserDestinationMessageHandler, org.springframework.messaging.MessageHandler, org.springframework.messaging.simp.user.UserDestinationResolver)
• userDestinationMessageHandler(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.simp.user.UserDestinationResolver)

brokerChannel(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.core.task.TaskExecutor) delivers messages from within the application to the respective message handlers. brokerMessagingTemplate(org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.support.AbstractSubscribableChannel, org.springframework.messaging.converter.CompositeMessageConverter) can be injected into any application component to send messages.

Subclasses are responsible for the parts 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, Brian Clozel, Sebastien Deleuze

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMessageBrokerConfiguration() Protected constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
protected void	addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
AbstractSubscribableChannel	brokerChannel(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, TaskExecutor brokerChannelExecutor)
TaskExecutor	brokerChannelExecutor(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)
CompositeMessageConverter	brokerMessageConverter()
SimpMessagingTemplate	brokerMessagingTemplate(AbstractSubscribableChannel brokerChannel, AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, CompositeMessageConverter brokerMessageConverter)
AbstractSubscribableChannel	clientInboundChannel(TaskExecutor clientInboundChannelExecutor)
TaskExecutor	clientInboundChannelExecutor()
AbstractSubscribableChannel	clientOutboundChannel(TaskExecutor clientOutboundChannelExecutor)
TaskExecutor	clientOutboundChannelExecutor()
protected void	configureClientInboundChannel(ChannelRegistration registration) A hook for subclasses to customize the message channel for inbound messages from WebSocket clients.
protected void	configureClientOutboundChannel(ChannelRegistration registration) A hook for subclasses to customize the message channel for messages from the application or message broker to WebSocket clients.
protected void	configureMessageBroker(MessageBrokerRegistry registry) A hook for subclasses to customize message broker configuration through the provided MessageBrokerRegistry instance.
protected boolean	configureMessageConverters(List<MessageConverter> messageConverters) Override this method to add custom message converters.
protected SimpAnnotationMethodMessageHandler	createAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpMessagingTemplate brokerMessagingTemplate) Protected method for plugging in a custom subclass of SimpAnnotationMethodMessageHandler.
protected MappingJackson2MessageConverter	createJacksonConverter()
protected SimpUserRegistry	createLocalUserRegistry() Deprecated. as of 5.1 in favor of createLocalUserRegistry(Integer)
protected abstract SimpUserRegistry	createLocalUserRegistry(Integer order) Create the user registry that provides access to local users.
ApplicationContext	getApplicationContext()
protected MessageBrokerRegistry	getBrokerRegistry(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) An accessor for the MessageBrokerRegistry that ensures its one-time creation and initialization through configureMessageBroker(MessageBrokerRegistry).
protected ChannelRegistration	getClientInboundChannelRegistration()
protected ChannelRegistration	getClientOutboundChannelRegistration()
PathMatcher	getPathMatcher(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel) Provide access to the configured PatchMatcher for access from other configuration classes.
Validator	getValidator() Override this method to provide a custom Validator.
TaskScheduler	messageBrokerTaskScheduler()
void	setApplicationContext(ApplicationContext applicationContext) Set the ApplicationContext that this object runs in.
SimpAnnotationMethodMessageHandler	simpAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpMessagingTemplate brokerMessagingTemplate, CompositeMessageConverter brokerMessageConverter)
AbstractBrokerMessageHandler	simpleBrokerMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver)
protected Validator	simpValidator() Return an Validator instance for validating @Payload method arguments.
AbstractBrokerMessageHandler	stompBrokerRelayMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationMessageHandler userDestinationMessageHandler, MessageHandler userRegistryMessageHandler, UserDestinationResolver userDestinationResolver)
UserDestinationMessageHandler	userDestinationMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, AbstractSubscribableChannel brokerChannel, UserDestinationResolver userDestinationResolver)
UserDestinationResolver	userDestinationResolver(SimpUserRegistry userRegistry, AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)
SimpUserRegistry	userRegistry(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)
MessageHandler	userRegistryMessageHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel, SimpUserRegistry userRegistry, SimpMessagingTemplate brokerMessagingTemplate, TaskScheduler messageBrokerTaskScheduler)

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

setApplicationContext

public void setApplicationContext(@Nullable
                                  ApplicationContext applicationContext)

Description copied from interface: ApplicationContextAware

Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.

Invoked after population of normal bean properties but before an init callback such as InitializingBean.afterPropertiesSet() or a custom init-method. Invoked after ResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader), ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher) and MessageSourceAware, if applicable.

Specified by:

setApplicationContext in interface ApplicationContextAware

Parameters:

applicationContext - the ApplicationContext object to be used by this object

See Also:

BeanInitializationException

getApplicationContext

@Nullable
public ApplicationContext getApplicationContext()

clientInboundChannel

@Bean
public AbstractSubscribableChannel clientInboundChannel(TaskExecutor clientInboundChannelExecutor)

clientInboundChannelExecutor

@Bean
public TaskExecutor clientInboundChannelExecutor()

getClientInboundChannelRegistration

protected final ChannelRegistration getClientInboundChannelRegistration()

configureClientInboundChannel

protected void configureClientInboundChannel(ChannelRegistration registration)

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

clientOutboundChannel

@Bean
public AbstractSubscribableChannel clientOutboundChannel(TaskExecutor clientOutboundChannelExecutor)

clientOutboundChannelExecutor

@Bean
public TaskExecutor clientOutboundChannelExecutor()

getClientOutboundChannelRegistration

protected final ChannelRegistration getClientOutboundChannelRegistration()

configureClientOutboundChannel

protected void configureClientOutboundChannel(ChannelRegistration registration)

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

brokerChannel

@Bean
public AbstractSubscribableChannel brokerChannel(AbstractSubscribableChannel clientInboundChannel,
                                                       AbstractSubscribableChannel clientOutboundChannel,
                                                       TaskExecutor brokerChannelExecutor)

brokerChannelExecutor

@Bean
public TaskExecutor brokerChannelExecutor(AbstractSubscribableChannel clientInboundChannel,
                                                AbstractSubscribableChannel clientOutboundChannel)

getBrokerRegistry

protected final MessageBrokerRegistry getBrokerRegistry(AbstractSubscribableChannel clientInboundChannel,
                                                        AbstractSubscribableChannel clientOutboundChannel)

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

configureMessageBroker

protected void configureMessageBroker(MessageBrokerRegistry registry)

A hook for subclasses to customize message broker configuration through the provided MessageBrokerRegistry instance.

getPathMatcher

@Nullable
public final PathMatcher getPathMatcher(AbstractSubscribableChannel clientInboundChannel,
                                                  AbstractSubscribableChannel clientOutboundChannel)

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

simpAnnotationMethodMessageHandler

@Bean
public SimpAnnotationMethodMessageHandler simpAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel,
                                                                                   AbstractSubscribableChannel clientOutboundChannel,
                                                                                   SimpMessagingTemplate brokerMessagingTemplate,
                                                                                   CompositeMessageConverter brokerMessageConverter)

createAnnotationMethodMessageHandler

protected SimpAnnotationMethodMessageHandler createAnnotationMethodMessageHandler(AbstractSubscribableChannel clientInboundChannel,
                                                                                  AbstractSubscribableChannel clientOutboundChannel,
                                                                                  SimpMessagingTemplate brokerMessagingTemplate)

Protected method for plugging in a custom subclass of SimpAnnotationMethodMessageHandler.

Since:

5.3.2

addArgumentResolvers

protected void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)

addReturnValueHandlers

protected void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)

simpleBrokerMessageHandler

@Bean
 @Nullable
public AbstractBrokerMessageHandler simpleBrokerMessageHandler(AbstractSubscribableChannel clientInboundChannel,
                                                                                AbstractSubscribableChannel clientOutboundChannel,
                                                                                AbstractSubscribableChannel brokerChannel,
                                                                                UserDestinationResolver userDestinationResolver)

stompBrokerRelayMessageHandler

@Bean
 @Nullable
public AbstractBrokerMessageHandler stompBrokerRelayMessageHandler(AbstractSubscribableChannel clientInboundChannel,
                                                                                    AbstractSubscribableChannel clientOutboundChannel,
                                                                                    AbstractSubscribableChannel brokerChannel,
                                                                                    UserDestinationMessageHandler userDestinationMessageHandler,
                                                                                    @Nullable
                                                                                    MessageHandler userRegistryMessageHandler,
                                                                                    UserDestinationResolver userDestinationResolver)

userDestinationMessageHandler

@Bean
public UserDestinationMessageHandler userDestinationMessageHandler(AbstractSubscribableChannel clientInboundChannel,
                                                                         AbstractSubscribableChannel clientOutboundChannel,
                                                                         AbstractSubscribableChannel brokerChannel,
                                                                         UserDestinationResolver userDestinationResolver)

userRegistryMessageHandler

@Bean
 @Nullable
public MessageHandler userRegistryMessageHandler(AbstractSubscribableChannel clientInboundChannel,
                                                                  AbstractSubscribableChannel clientOutboundChannel,
                                                                  SimpUserRegistry userRegistry,
                                                                  SimpMessagingTemplate brokerMessagingTemplate,
                                                                  TaskScheduler messageBrokerTaskScheduler)

messageBrokerTaskScheduler

@Bean(name={"messageBrokerTaskScheduler","messageBrokerSockJsTaskScheduler"})
public TaskScheduler messageBrokerTaskScheduler()

brokerMessagingTemplate

@Bean
public SimpMessagingTemplate brokerMessagingTemplate(AbstractSubscribableChannel brokerChannel,
                                                           AbstractSubscribableChannel clientInboundChannel,
                                                           AbstractSubscribableChannel clientOutboundChannel,
                                                           CompositeMessageConverter brokerMessageConverter)

brokerMessageConverter

@Bean
public CompositeMessageConverter brokerMessageConverter()

createJacksonConverter

protected MappingJackson2MessageConverter createJacksonConverter()

configureMessageConverters

protected boolean configureMessageConverters(List<MessageConverter> messageConverters)

Override this method to add custom message converters.

Parameters:

messageConverters - the list to add converters to, initially empty

Returns:

true if default message converters should be added to list, false if no more converters should be added

userDestinationResolver

@Bean
public UserDestinationResolver userDestinationResolver(SimpUserRegistry userRegistry,
                                                             AbstractSubscribableChannel clientInboundChannel,
                                                             AbstractSubscribableChannel clientOutboundChannel)

userRegistry

@Bean
public SimpUserRegistry userRegistry(AbstractSubscribableChannel clientInboundChannel,
                                           AbstractSubscribableChannel clientOutboundChannel)

createLocalUserRegistry

@Deprecated
 @Nullable
protected SimpUserRegistry createLocalUserRegistry()

Deprecated. as of 5.1 in favor of createLocalUserRegistry(Integer)

Create the user registry that provides access to local users.

createLocalUserRegistry

protected abstract SimpUserRegistry createLocalUserRegistry(@Nullable
                                                            Integer order)

Create the user registry that provides access to local users.

Parameters:

order - the order to use as a SmartApplicationListener.

Since:

5.1

simpValidator

protected Validator simpValidator()

Return an Validator instance for validating @Payload method arguments.

In order, this method tries to get a Validator instance:

• delegating to getValidator() first
• if none returned, getting an existing instance with its well-known name "mvcValidator", created by an MVC configuration
• if none returned, checking the classpath for the presence of a JSR-303 implementation before creating a OptionalValidatorFactoryBean
• returning a no-op Validator instance

getValidator

@Nullable
public Validator getValidator()

Override this method to provide a custom Validator.

Since:

4.0.1