spring-framework / org.springframework.web.socket.config.annotation / WebSocketMessageBrokerConfigurationSupport

WebSocketMessageBrokerConfigurationSupport

abstract class WebSocketMessageBrokerConfigurationSupport : 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.

Author
Rossen Stoyanchev

Author
Artem Bilan

Since
4.0

Constructors

<init>

WebSocketMessageBrokerConfigurationSupport()

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.

Functions

stompWebSocketHandlerMapping	`open fun stompWebSocketHandlerMapping(): HandlerMapping`
subProtocolWebSocketHandler	`open fun subProtocolWebSocketHandler(): WebSocketHandler`
webSocketMessageBrokerStats	`open fun webSocketMessageBrokerStats(): WebSocketMessageBrokerStats`
webSocketScopeConfigurer	`open static fun webSocketScopeConfigurer(): CustomScopeConfigurer`

Inherited Functions

brokerChannel	`open fun brokerChannel(): AbstractSubscribableChannel`
brokerChannelExecutor	`open fun brokerChannelExecutor(): ThreadPoolTaskExecutor`
brokerMessageConverter	`open fun brokerMessageConverter(): CompositeMessageConverter`
brokerMessagingTemplate	`open fun brokerMessagingTemplate(): SimpMessagingTemplate`
clientInboundChannel	`open fun clientInboundChannel(): AbstractSubscribableChannel`
clientInboundChannelExecutor	`open fun clientInboundChannelExecutor(): ThreadPoolTaskExecutor`
clientOutboundChannel	`open fun clientOutboundChannel(): AbstractSubscribableChannel`
clientOutboundChannelExecutor	`open fun clientOutboundChannelExecutor(): ThreadPoolTaskExecutor`
getApplicationContext	`open fun getApplicationContext(): ApplicationContext`
getPathMatcher	`fun getPathMatcher(): PathMatcher` Provide access to the configured PatchMatcher for access from other configuration classes.
getValidator	`open fun getValidator(): Validator` Override this method to provide a custom Validator.
messageBrokerTaskScheduler	`open fun messageBrokerTaskScheduler(): ThreadPoolTaskScheduler`
setApplicationContext	`open fun setApplicationContext(applicationContext: ApplicationContext): Unit`
simpAnnotationMethodMessageHandler	`open fun simpAnnotationMethodMessageHandler(): SimpAnnotationMethodMessageHandler`
simpleBrokerMessageHandler	`open fun simpleBrokerMessageHandler(): AbstractBrokerMessageHandler`
stompBrokerRelayMessageHandler	`open fun stompBrokerRelayMessageHandler(): AbstractBrokerMessageHandler`
userDestinationMessageHandler	`open fun userDestinationMessageHandler(): UserDestinationMessageHandler`
userDestinationResolver	`open fun userDestinationResolver(): UserDestinationResolver`
userRegistry	`open fun userRegistry(): SimpUserRegistry`
userRegistryMessageHandler	`open fun userRegistryMessageHandler(): MessageHandler`

Inheritors

DelegatingWebSocketMessageBrokerConfiguration

open class DelegatingWebSocketMessageBrokerConfiguration : WebSocketMessageBrokerConfigurationSupport

A WebSocketMessageBrokerConfigurationSupport extension that detects beans of type WebSocketMessageBrokerConfigurer and delegates to all of them allowing callback style customization of the configuration provided in WebSocketMessageBrokerConfigurationSupport.

This class is typically imported via EnableWebSocketMessageBroker.