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:
org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
Direct Known Subclasses:
DelegatingWebSocketMessageBrokerConfiguration
public abstract class WebSocketMessageBrokerConfigurationSupport extends org.springframework.messaging.simp.config.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 org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
    createAnnotationMethodMessageHandler(org.springframework.messaging.support.AbstractSubscribableChannel clientInboundChannel, org.springframework.messaging.support.AbstractSubscribableChannel clientOutboundChannel, org.springframework.messaging.simp.SimpMessagingTemplate brokerMessagingTemplate)
     
    protected org.springframework.messaging.converter.MappingJackson2MessageConverter
    createJacksonConverter()
     
    protected org.springframework.messaging.simp.user.SimpUserRegistry
    createLocalUserRegistry(Integer order)
     
    protected WebSocketHandler
    decorateWebSocketHandler(WebSocketHandler handler)
     
    protected final WebSocketTransportRegistration
    getTransportRegistration()
     
    protected abstract void
    registerStompEndpoints(StompEndpointRegistry registry)
     
    org.springframework.web.servlet.HandlerMapping
    stompWebSocketHandlerMapping(WebSocketHandler subProtocolWebSocketHandler, org.springframework.scheduling.TaskScheduler messageBrokerTaskScheduler, org.springframework.messaging.support.AbstractSubscribableChannel clientInboundChannel)
     
    WebSocketHandler
    subProtocolWebSocketHandler(org.springframework.messaging.support.AbstractSubscribableChannel clientInboundChannel, org.springframework.messaging.support.AbstractSubscribableChannel clientOutboundChannel)
     
    WebSocketMessageBrokerStats
    webSocketMessageBrokerStats(org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler stompBrokerRelayMessageHandler, WebSocketHandler subProtocolWebSocketHandler, org.springframework.core.task.TaskExecutor inboundExecutor, org.springframework.core.task.TaskExecutor outboundExecutor, org.springframework.scheduling.TaskScheduler scheduler)
     
    static org.springframework.beans.factory.config.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 org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler createAnnotationMethodMessageHandler(org.springframework.messaging.support.AbstractSubscribableChannel clientInboundChannel, org.springframework.messaging.support.AbstractSubscribableChannel clientOutboundChannel, org.springframework.messaging.simp.SimpMessagingTemplate brokerMessagingTemplate)
      Overrides:
      createAnnotationMethodMessageHandler in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration

    • createLocalUserRegistry

      protected org.springframework.messaging.simp.user.SimpUserRegistry createLocalUserRegistry(@Nullable Integer order)
      Specified by:
      createLocalUserRegistry in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration

    • stompWebSocketHandlerMapping

      @Bean public org.springframework.web.servlet.HandlerMapping stompWebSocketHandlerMapping(WebSocketHandler subProtocolWebSocketHandler, org.springframework.scheduling.TaskScheduler messageBrokerTaskScheduler, org.springframework.messaging.support.AbstractSubscribableChannel clientInboundChannel)

    • subProtocolWebSocketHandler

      @Bean public WebSocketHandler subProtocolWebSocketHandler(org.springframework.messaging.support.AbstractSubscribableChannel clientInboundChannel, org.springframework.messaging.support.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 org.springframework.beans.factory.config.CustomScopeConfigurer webSocketScopeConfigurer()

    • webSocketMessageBrokerStats

      @Bean public WebSocketMessageBrokerStats webSocketMessageBrokerStats(@Nullable org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler stompBrokerRelayMessageHandler, WebSocketHandler subProtocolWebSocketHandler, @Qualifier("clientInboundChannelExecutor") org.springframework.core.task.TaskExecutor inboundExecutor, @Qualifier("clientOutboundChannelExecutor") org.springframework.core.task.TaskExecutor outboundExecutor, @Qualifier("messageBrokerTaskScheduler") org.springframework.scheduling.TaskScheduler scheduler)

    • createJacksonConverter

      protected org.springframework.messaging.converter.MappingJackson2MessageConverter createJacksonConverter()
      Overrides:
      createJacksonConverter in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration