AbstractMessageBrokerConfiguration (Spring Framework 5.1.10.RELEASE API)

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() and clientOutboundChannel() deliver messages to and from remote clients to several message handlers such as the following.
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 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

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(List<HandlerMethodArgumentResolver> argumentResolvers)`
`protected void`	`addReturnValueHandlers(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 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()` 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()` 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 an `Validator` instance for validating `@Payload` method arguments.
`AbstractBrokerMessageHandler`	`stompBrokerRelayMessageHandler()`
`UserDestinationMessageHandler`	`userDestinationMessageHandler()`
`UserDestinationResolver`	`userDestinationResolver()`
`SimpUserRegistry`	`userRegistry()`
`MessageHandler`	`userRegistryMessageHandler()`

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()
```
  - clientInboundChannelExecutor
```
@Bean
public ThreadPoolTaskExecutor 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()
```
  - clientOutboundChannelExecutor
```
@Bean
public ThreadPoolTaskExecutor 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()
```
  - 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 subclasses to customize message broker configuration through the provided MessageBrokerRegistry instance.
  - getPathMatcher
```
@Nullable
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 subclass of SimpAnnotationMethodMessageHandler.
    
    Since:
    
    4.2
  - addArgumentResolvers
```
protected void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
```
  - addReturnValueHandlers
```
protected void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
```
  - simpleBrokerMessageHandler
```
@Bean
 @Nullable
public AbstractBrokerMessageHandler simpleBrokerMessageHandler()
```
  - stompBrokerRelayMessageHandler
```
@Bean
 @Nullable
public AbstractBrokerMessageHandler stompBrokerRelayMessageHandler()
```
  - userDestinationMessageHandler
```
@Bean
public UserDestinationMessageHandler userDestinationMessageHandler()
```
  - userRegistryMessageHandler
```
@Bean
 @Nullable
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(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
```
@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

Class AbstractMessageBrokerConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

createLocalUserRegistry

simpValidator

getValidator