Class DelegatingWebSocketMessageBrokerConfiguration
- java.lang.Object
- org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport
- org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration
- All Implemented Interfaces:
Aware,ApplicationContextAware
@Configuration public class DelegatingWebSocketMessageBrokerConfiguration extends WebSocketMessageBrokerConfigurationSupport
AWebSocketMessageBrokerConfigurationSupportextension that detects beans of typeWebSocketMessageBrokerConfigurerand delegates to all of them allowing callback style customization of the configuration provided inWebSocketMessageBrokerConfigurationSupport.This class is typically imported via
EnableWebSocketMessageBroker.- Since:
- 4.0
- Author:
- Rossen Stoyanchev
Constructor Summary
Constructors Constructor Description DelegatingWebSocketMessageBrokerConfiguration()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)protected voidaddReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)protected voidconfigureClientInboundChannel(ChannelRegistration registration)A hook for subclasses to customize the message channel for inbound messages from WebSocket clients.protected voidconfigureClientOutboundChannel(ChannelRegistration registration)A hook for subclasses to customize the message channel for messages from the application or message broker to WebSocket clients.protected voidconfigureMessageBroker(MessageBrokerRegistry registry)A hook for subclasses to customize message broker configuration through the providedMessageBrokerRegistryinstance.protected booleanconfigureMessageConverters(List<MessageConverter> messageConverters)Override this method to add custom message converters.protected voidconfigureWebSocketTransport(WebSocketTransportRegistration registration)protected voidregisterStompEndpoints(StompEndpointRegistry registry)voidsetConfigurers(List<WebSocketMessageBrokerConfigurer> configurers)Methods inherited from class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport
createAnnotationMethodMessageHandler, createJacksonConverter, createLocalUserRegistry, decorateWebSocketHandler, getTransportRegistration, stompWebSocketHandlerMapping, subProtocolWebSocketHandler, webSocketMessageBrokerStats, webSocketScopeConfigurer
Methods inherited from class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
brokerChannel, brokerChannelExecutor, brokerMessageConverter, brokerMessagingTemplate, clientInboundChannel, clientInboundChannelExecutor, clientOutboundChannel, clientOutboundChannelExecutor, getApplicationContext, getBrokerRegistry, getClientInboundChannelRegistration, getClientOutboundChannelRegistration, getPathMatcher, getValidator, messageBrokerTaskScheduler, setApplicationContext, simpAnnotationMethodMessageHandler, simpleBrokerMessageHandler, simpValidator, stompBrokerRelayMessageHandler, userDestinationMessageHandler, userDestinationResolver, userRegistry, userRegistryMessageHandler, userSessionRegistry
Constructor Detail
DelegatingWebSocketMessageBrokerConfiguration
public DelegatingWebSocketMessageBrokerConfiguration()
Method Detail
setConfigurers
@Autowired(required=false) public void setConfigurers(List<WebSocketMessageBrokerConfigurer> configurers)
registerStompEndpoints
protected void registerStompEndpoints(StompEndpointRegistry registry)
- Specified by:
registerStompEndpointsin classWebSocketMessageBrokerConfigurationSupport
configureWebSocketTransport
protected void configureWebSocketTransport(WebSocketTransportRegistration registration)
- Overrides:
configureWebSocketTransportin classWebSocketMessageBrokerConfigurationSupport
configureClientInboundChannel
protected void configureClientInboundChannel(ChannelRegistration registration)
Description copied from class:AbstractMessageBrokerConfigurationA hook for subclasses to customize the message channel for inbound messages from WebSocket clients.- Overrides:
configureClientInboundChannelin classAbstractMessageBrokerConfiguration
configureClientOutboundChannel
protected void configureClientOutboundChannel(ChannelRegistration registration)
Description copied from class:AbstractMessageBrokerConfigurationA hook for subclasses to customize the message channel for messages from the application or message broker to WebSocket clients.- Overrides:
configureClientOutboundChannelin classAbstractMessageBrokerConfiguration
addArgumentResolvers
protected void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
- Overrides:
addArgumentResolversin classAbstractMessageBrokerConfiguration
addReturnValueHandlers
protected void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
- Overrides:
addReturnValueHandlersin classAbstractMessageBrokerConfiguration
configureMessageConverters
protected boolean configureMessageConverters(List<MessageConverter> messageConverters)
Description copied from class:AbstractMessageBrokerConfigurationOverride this method to add custom message converters.- Overrides:
configureMessageConvertersin classAbstractMessageBrokerConfiguration- Parameters:
messageConverters- the list to add converters to, initially empty- Returns:
trueif default message converters should be added to list,falseif no more converters should be added
configureMessageBroker
protected void configureMessageBroker(MessageBrokerRegistry registry)
Description copied from class:AbstractMessageBrokerConfigurationA hook for subclasses to customize message broker configuration through the providedMessageBrokerRegistryinstance.- Overrides:
configureMessageBrokerin classAbstractMessageBrokerConfiguration