public interface WebSocketMessageBrokerConfigurer
Typically used to customize the configuration provided via
@EnableWebSocketMessageBroker
.
Modifier and Type | Method and Description |
---|---|
default void |
addArgumentResolvers(java.util.List<HandlerMethodArgumentResolver> argumentResolvers)
Add resolvers to support custom controller method argument types.
|
default void |
addReturnValueHandlers(java.util.List<HandlerMethodReturnValueHandler> returnValueHandlers)
Add handlers to support custom controller method return value types.
|
default void |
configureClientInboundChannel(ChannelRegistration registration)
Configure the
MessageChannel used for
incoming messages from WebSocket clients. |
default void |
configureClientOutboundChannel(ChannelRegistration registration)
Configure the
MessageChannel used for
outbound messages to WebSocket clients. |
default void |
configureMessageBroker(MessageBrokerRegistry registry)
Configure message broker options.
|
default boolean |
configureMessageConverters(java.util.List<MessageConverter> messageConverters)
Configure the message converters to use when extracting the payload of
messages in annotated methods and when sending messages (e.g.
|
default void |
configureWebSocketTransport(WebSocketTransportRegistration registry)
Configure options related to the processing of messages received from and
sent to WebSocket clients.
|
default void |
registerStompEndpoints(StompEndpointRegistry registry)
Register STOMP endpoints mapping each to a specific URL and (optionally)
enabling and configuring SockJS fallback options.
|
default void registerStompEndpoints(StompEndpointRegistry registry)
default void configureWebSocketTransport(WebSocketTransportRegistration registry)
default void configureClientInboundChannel(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.default void configureClientOutboundChannel(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.default void addArgumentResolvers(java.util.List<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)default void addReturnValueHandlers(java.util.List<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)default boolean configureMessageConverters(java.util.List<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)default void configureMessageBroker(MessageBrokerRegistry registry)