Package org.springframework.web.socket.config.annotation

Class WebSocketMessageBrokerConfigurationSupport

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, Sebastien Deleuze

Constructor Summary

Constructors

Constructor	Description
WebSocketMessageBrokerConfigurationSupport()

Method Summary

Modifier and Type	Method	Description
protected void	configureWebSocketTransport(WebSocketTransportRegistration registry)
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(Integer order)	Create the user registry that provides access to local users.
protected WebSocketHandler	decorateWebSocketHandler(WebSocketHandler handler)
protected final WebSocketTransportRegistration	getTransportRegistration()
protected abstract void	registerStompEndpoints(StompEndpointRegistry registry)
HandlerMapping	stompWebSocketHandlerMapping(WebSocketHandler subProtocolWebSocketHandler, TaskScheduler messageBrokerTaskScheduler, AbstractSubscribableChannel clientInboundChannel)
WebSocketHandler	subProtocolWebSocketHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)
WebSocketMessageBrokerStats	webSocketMessageBrokerStats(AbstractBrokerMessageHandler stompBrokerRelayMessageHandler, WebSocketHandler subProtocolWebSocketHandler, TaskExecutor inboundExecutor, TaskExecutor outboundExecutor, TaskScheduler scheduler)
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, getApplicationContext, getBrokerRegistry, getClientInboundChannelRegistration, getClientOutboundChannelRegistration, getPathMatcher, getPhase, getValidator, initPhase, 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 Details

WebSocketMessageBrokerConfigurationSupport

public WebSocketMessageBrokerConfigurationSupport()

Method Details

createAnnotationMethodMessageHandler

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

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(WebSocketHandler subProtocolWebSocketHandler,
 TaskScheduler messageBrokerTaskScheduler,
 AbstractSubscribableChannel clientInboundChannel)

subProtocolWebSocketHandler

@Bean
public WebSocketHandler subProtocolWebSocketHandler(AbstractSubscribableChannel clientInboundChannel,
 AbstractSubscribableChannel clientOutboundChannel)

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(@Nullable
 AbstractBrokerMessageHandler stompBrokerRelayMessageHandler,
 WebSocketHandler subProtocolWebSocketHandler,
 @Qualifier("clientInboundChannelExecutor")
 TaskExecutor inboundExecutor,
 @Qualifier("clientOutboundChannelExecutor")
 TaskExecutor outboundExecutor,
 @Qualifier("messageBrokerTaskScheduler")
 TaskScheduler scheduler)

createJacksonConverter

protected MappingJackson2MessageConverter createJacksonConverter()

Overrides:

createJacksonConverter in class AbstractMessageBrokerConfiguration