WebSocketMessageBrokerConfigurationSupport (Spring Framework 5.2.12.RELEASE API)

java.lang.Object
- org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- - org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

All Implemented Interfaces:
Aware, ApplicationContextAware
Direct Known Subclasses:
DelegatingWebSocketMessageBrokerConfiguration
```
public abstract class WebSocketMessageBrokerConfigurationSupport
extends AbstractMessageBrokerConfiguration
```
Extends AbstractMessageBrokerConfiguration and adds configuration for receiving and responding to STOMP messages from WebSocket clients.
Typically used in conjunction with @EnableWebSocketMessageBroker but can also be extended directly.
Since:
4.0
Author:
Rossen Stoyanchev, Artem Bilan

Constructor Summary
Constructors
Constructor Description
WebSocketMessageBrokerConfigurationSupport()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`configureWebSocketTransport(WebSocketTransportRegistration registry)`
`protected SimpAnnotationMethodMessageHandler`	`createAnnotationMethodMessageHandler()`	Protected method for plugging in a custom subclass of `SimpAnnotationMethodMessageHandler`.
`protected MappingJackson2MessageConverter`	`createJacksonConverter()`
`protected SimpUserRegistry`	`createLocalUserRegistry(Integer order)`	Create the user registry that provides access to local users.
`protected WebSocketHandler`	`decorateWebSocketHandler(WebSocketHandler handler)`
`protected WebSocketTransportRegistration`	`getTransportRegistration()`
`protected abstract void`	`registerStompEndpoints(StompEndpointRegistry registry)`
`HandlerMapping`	`stompWebSocketHandlerMapping()`
`WebSocketHandler`	`subProtocolWebSocketHandler()`
`WebSocketMessageBrokerStats`	`webSocketMessageBrokerStats()`
`static CustomScopeConfigurer`	`webSocketScopeConfigurer()`

Methods inherited from class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
addArgumentResolvers, addReturnValueHandlers, brokerChannel, brokerChannelExecutor, brokerMessageConverter, brokerMessagingTemplate, clientInboundChannel, clientInboundChannelExecutor, clientOutboundChannel, clientOutboundChannelExecutor, configureClientInboundChannel, configureClientOutboundChannel, configureMessageBroker, configureMessageConverters, createLocalUserRegistry, getApplicationContext, getBrokerRegistry, getClientInboundChannelRegistration, getClientOutboundChannelRegistration, getPathMatcher, getValidator, messageBrokerTaskScheduler, setApplicationContext, simpAnnotationMethodMessageHandler, simpleBrokerMessageHandler, simpValidator, stompBrokerRelayMessageHandler, userDestinationMessageHandler, userDestinationResolver, userRegistry, userRegistryMessageHandler

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

Constructor Detail
- WebSocketMessageBrokerConfigurationSupport
```
public WebSocketMessageBrokerConfigurationSupport()
```

Method Detail

createAnnotationMethodMessageHandler
```
protected SimpAnnotationMethodMessageHandler createAnnotationMethodMessageHandler()
```
Description copied from class: AbstractMessageBrokerConfiguration
Protected method for plugging in a custom subclass of SimpAnnotationMethodMessageHandler.
Overrides:
createAnnotationMethodMessageHandler in class AbstractMessageBrokerConfiguration

createLocalUserRegistry
```
protected SimpUserRegistry createLocalUserRegistry(@Nullable
                                                   Integer order)
```
Description copied from class: AbstractMessageBrokerConfiguration
Create the user registry that provides access to local users.
Specified by:
createLocalUserRegistry in class AbstractMessageBrokerConfiguration
Parameters:
order - the order to use as a SmartApplicationListener.

stompWebSocketHandlerMapping

@Bean
public HandlerMapping stompWebSocketHandlerMapping()

subProtocolWebSocketHandler

@Bean
public WebSocketHandler subProtocolWebSocketHandler()

decorateWebSocketHandler

protected WebSocketHandler decorateWebSocketHandler(WebSocketHandler handler)

getTransportRegistration

protected final WebSocketTransportRegistration getTransportRegistration()

configureWebSocketTransport

protected void configureWebSocketTransport(WebSocketTransportRegistration registry)

registerStompEndpoints

protected abstract void registerStompEndpoints(StompEndpointRegistry registry)

webSocketScopeConfigurer

@Bean
public static CustomScopeConfigurer webSocketScopeConfigurer()

webSocketMessageBrokerStats

@Bean
public WebSocketMessageBrokerStats webSocketMessageBrokerStats()

createJacksonConverter
```
protected MappingJackson2MessageConverter createJacksonConverter()
```
Overrides:
createJacksonConverter in class AbstractMessageBrokerConfiguration