AbstractMessageBrokerConfiguration

java.lang.Object
- org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration

All Implemented Interfaces:

Aware, ApplicationContextAware

Direct Known Subclasses:

WebSocketMessageBrokerConfigurationSupport
```
public abstract class AbstractMessageBrokerConfiguration
extends java.lang.Object
implements ApplicationContextAware
```
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
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.
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).
Since:

4.0

Author:

Rossen Stoyanchev, Brian Clozel

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`AbstractMessageBrokerConfiguration.NoOpBrokerMessageHandler`
`private static class`	`AbstractMessageBrokerConfiguration.NoOpMessageHandler`

Field Summary

Fields
Modifier and Type	Field and Description
`private ApplicationContext`	`applicationContext`
`private MessageBrokerRegistry`	`brokerRegistry`
`private ChannelRegistration`	`clientInboundChannelRegistration`
`private ChannelRegistration`	`clientOutboundChannelRegistration`
`private static boolean`	`jackson2Present`
`private static java.lang.String`	`MVC_VALIDATOR_NAME`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractMessageBrokerConfiguration()
Protected constructor.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractMessageBrokerConfiguration()` Protected constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addArgumentResolvers(java.util.List<HandlerMethodArgumentResolver> argumentResolvers)`
`protected void`	`addReturnValueHandlers(java.util.List<HandlerMethodReturnValueHandler> returnValueHandlers)`
`AbstractSubscribableChannel`	`brokerChannel()`
`ThreadPoolTaskExecutor`	`brokerChannelExecutor()`
`CompositeMessageConverter`	`brokerMessageConverter()`
`SimpMessagingTemplate`	`brokerMessagingTemplate()`
`AbstractSubscribableChannel`	`clientInboundChannel()`
`ThreadPoolTaskExecutor`	`clientInboundChannelExecutor()`
`AbstractSubscribableChannel`	`clientOutboundChannel()`
`ThreadPoolTaskExecutor`	`clientOutboundChannelExecutor()`
`protected void`	`configureClientInboundChannel(ChannelRegistration registration)` A hook for sub-classes to customize the message channel for inbound messages from WebSocket clients.
`protected 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 void`	`configureMessageBroker(MessageBrokerRegistry registry)` A hook for sub-classes to customize message broker configuration through the provided `MessageBrokerRegistry` instance.
`protected boolean`	`configureMessageConverters(java.util.List<MessageConverter> messageConverters)` Override this method to add custom message converters.
`protected SimpAnnotationMethodMessageHandler`	`createAnnotationMethodMessageHandler()` Protected method for plugging in a custom sub-class of `SimpAnnotationMethodMessageHandler`.
`protected MappingJackson2MessageConverter`	`createJacksonConverter()`
`protected abstract SimpUserRegistry`	`createLocalUserRegistry()` Create the user registry that provides access to the local users.
`ApplicationContext`	`getApplicationContext()`
`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()`
`PathMatcher`	`getPathMatcher()` Provide access to the configured PatchMatcher for access from other configuration classes.
`Validator`	`getValidator()` Override this method to provide a custom `Validator`.
`ThreadPoolTaskScheduler`	`messageBrokerTaskScheduler()`
`void`	`setApplicationContext(ApplicationContext applicationContext)` Set the ApplicationContext that this object runs in.
`SimpAnnotationMethodMessageHandler`	`simpAnnotationMethodMessageHandler()`
`AbstractBrokerMessageHandler`	`simpleBrokerMessageHandler()`
`protected Validator`	`simpValidator()` Return a `Validator`s instance for validating `@Payload` method arguments.
`AbstractBrokerMessageHandler`	`stompBrokerRelayMessageHandler()`
`UserDestinationMessageHandler`	`userDestinationMessageHandler()`
`UserDestinationResolver`	`userDestinationResolver()`
`SimpUserRegistry`	`userRegistry()`
`MessageHandler`	`userRegistryMessageHandler()`
`protected UserSessionRegistry`	`userSessionRegistry()` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MVC_VALIDATOR_NAME
```
private static final java.lang.String MVC_VALIDATOR_NAME
```
    See Also:
    
    Constant Field Values
  - jackson2Present
```
private static final boolean jackson2Present
```
  - applicationContext
```
private ApplicationContext applicationContext
```
  - clientInboundChannelRegistration
```
private ChannelRegistration clientInboundChannelRegistration
```
  - clientOutboundChannelRegistration
```
private ChannelRegistration clientOutboundChannelRegistration
```
  - brokerRegistry
```
private MessageBrokerRegistry brokerRegistry
```
- Constructor Detail
  - AbstractMessageBrokerConfiguration
```
protected AbstractMessageBrokerConfiguration()
```
    Protected constructor.
- Method Detail
  - setApplicationContext
```
public void setApplicationContext(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
```
public ApplicationContext getApplicationContext()
```
  - clientInboundChannel
```
@Bean
public AbstractSubscribableChannel clientInboundChannel()
```
  - clientInboundChannelExecutor
```
@Bean
public ThreadPoolTaskExecutor clientInboundChannelExecutor()
```
  - getClientInboundChannelRegistration
```
protected final ChannelRegistration getClientInboundChannelRegistration()
```
  - configureClientInboundChannel
```
protected 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 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 void configureMessageBroker(MessageBrokerRegistry registry)
```
    A hook for sub-classes to customize message broker configuration through the provided MessageBrokerRegistry instance.
  - getPathMatcher
```
public final PathMatcher getPathMatcher()
```
    Provide access to the configured PatchMatcher for access from other configuration classes.
  - simpAnnotationMethodMessageHandler
```
@Bean
public SimpAnnotationMethodMessageHandler simpAnnotationMethodMessageHandler()
```
  - createAnnotationMethodMessageHandler
```
protected SimpAnnotationMethodMessageHandler createAnnotationMethodMessageHandler()
```
    Protected method for plugging in a custom sub-class of SimpAnnotationMethodMessageHandler.
    
    Since:
    
    4.2
  - addArgumentResolvers
```
protected void addArgumentResolvers(java.util.List<HandlerMethodArgumentResolver> argumentResolvers)
```
  - addReturnValueHandlers
```
protected void addReturnValueHandlers(java.util.List<HandlerMethodReturnValueHandler> returnValueHandlers)
```
  - simpleBrokerMessageHandler
```
@Bean
public AbstractBrokerMessageHandler simpleBrokerMessageHandler()
```
  - stompBrokerRelayMessageHandler
```
@Bean
public AbstractBrokerMessageHandler stompBrokerRelayMessageHandler()
```
  - userDestinationMessageHandler
```
@Bean
public UserDestinationMessageHandler userDestinationMessageHandler()
```
  - userRegistryMessageHandler
```
@Bean
public MessageHandler userRegistryMessageHandler()
```
  - messageBrokerTaskScheduler
```
@Bean(name={"messageBrokerTaskScheduler","messageBrokerSockJsTaskScheduler"})
public ThreadPoolTaskScheduler messageBrokerTaskScheduler()
```
  - brokerMessagingTemplate
```
@Bean
public SimpMessagingTemplate brokerMessagingTemplate()
```
  - brokerMessageConverter
```
@Bean
public CompositeMessageConverter brokerMessageConverter()
```
  - createJacksonConverter
```
protected MappingJackson2MessageConverter createJacksonConverter()
```
  - configureMessageConverters
```
protected boolean configureMessageConverters(java.util.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()
```
  - userRegistry
```
@Bean
public SimpUserRegistry userRegistry()
```
  - createLocalUserRegistry
```
protected abstract SimpUserRegistry createLocalUserRegistry()
```
    Create the user registry that provides access to the local users.
  - userSessionRegistry
```
@Deprecated
protected UserSessionRegistry userSessionRegistry()
```
    Deprecated.
    
    As of 4.2, UserSessionRegistry is deprecated in favor of SimpUserRegistry exposing information about all connected users. The MultiServerUserRegistry implementation in combination with UserRegistryMessageHandler can be used to share user registries across multiple servers.
  - simpValidator
```
protected Validator simpValidator()
```
    Return a Validators 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
```
public Validator getValidator()
```
    Override this method to provide a custom Validator.
    
    Since:
    
    4.0.1

Class AbstractMessageBrokerConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MVC_VALIDATOR_NAME

jackson2Present

applicationContext

clientInboundChannelRegistration

clientOutboundChannelRegistration

brokerRegistry

Constructor Detail

AbstractMessageBrokerConfiguration

Method Detail

setApplicationContext

getApplicationContext

clientInboundChannel

clientInboundChannelExecutor

getClientInboundChannelRegistration

configureClientInboundChannel

clientOutboundChannel

clientOutboundChannelExecutor

getClientOutboundChannelRegistration

configureClientOutboundChannel

brokerChannel

brokerChannelExecutor

getBrokerRegistry

configureMessageBroker

getPathMatcher

simpAnnotationMethodMessageHandler

createAnnotationMethodMessageHandler

addArgumentResolvers

addReturnValueHandlers

simpleBrokerMessageHandler

stompBrokerRelayMessageHandler

userDestinationMessageHandler

userRegistryMessageHandler

messageBrokerTaskScheduler

brokerMessagingTemplate

brokerMessageConverter

createJacksonConverter

configureMessageConverters

userDestinationResolver

userRegistry

createLocalUserRegistry

userSessionRegistry

simpValidator

getValidator