public interface WebSocketMessageBrokerConfigurer
Typically used to customize the configuration provided via
@EnableWebSocketMessageBroker
.
Modifier and Type | Method and Description |
---|---|
void |
addArgumentResolvers(List<org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver> argumentResolvers)
Add resolvers to support custom controller method argument types.
|
void |
addReturnValueHandlers(List<org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler> returnValueHandlers)
Add handlers to support custom controller method return value types.
|
void |
configureClientInboundChannel(org.springframework.messaging.simp.config.ChannelRegistration registration)
Configure the
MessageChannel used for
incoming messages from WebSocket clients. |
void |
configureClientOutboundChannel(org.springframework.messaging.simp.config.ChannelRegistration registration)
Configure the
MessageChannel used for
outbound messages to WebSocket clients. |
void |
configureMessageBroker(org.springframework.messaging.simp.config.MessageBrokerRegistry registry)
Configure message broker options.
|
boolean |
configureMessageConverters(List<org.springframework.messaging.converter.MessageConverter> messageConverters)
Configure the message converters to use when extracting the payload of
messages in annotated methods and when sending messages (e.g.
|
void |
configureWebSocketTransport(WebSocketTransportRegistration registry)
Configure options related to the processing of messages received from and
sent to WebSocket clients.
|
void |
registerStompEndpoints(StompEndpointRegistry registry)
Register STOMP endpoints mapping each to a specific URL and (optionally)
enabling and configuring SockJS fallback options.
|
void registerStompEndpoints(StompEndpointRegistry registry)
void configureWebSocketTransport(WebSocketTransportRegistration registry)
void configureClientInboundChannel(org.springframework.messaging.simp.config.ChannelRegistration registration)
MessageChannel
used for
incoming messages from WebSocket clients. By default the channel is backed
by a thread pool of size 1. It is recommended to customize thread pool
settings for production use.void configureClientOutboundChannel(org.springframework.messaging.simp.config.ChannelRegistration registration)
MessageChannel
used for
outbound messages to WebSocket clients. By default the channel is backed
by a thread pool of size 1. It is recommended to customize thread pool
settings for production use.void addArgumentResolvers(List<org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver> argumentResolvers)
This does not override the built-in support for resolving handler
method arguments. To customize the built-in support for argument
resolution, configure SimpAnnotationMethodMessageHandler
directly.
argumentResolvers
- the resolvers to register (initially an empty list)void addReturnValueHandlers(List<org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler> returnValueHandlers)
Using this option does not override the built-in support for handling
return values. To customize the built-in support for handling return
values, configure SimpAnnotationMethodMessageHandler
directly.
returnValueHandlers
- the handlers to register (initially an empty list)boolean configureMessageConverters(List<org.springframework.messaging.converter.MessageConverter> messageConverters)
The provided list, initially empty, can be used to add message converters while the boolean return value is used to determine if default message should be added as well.
messageConverters
- the converters to configure (initially an empty list)void configureMessageBroker(org.springframework.messaging.simp.config.MessageBrokerRegistry registry)