Top Description Interfaces Annotations Classes

module spring.websocket

Package org.springframework.web.socket.config.annotation

Annotations

@NonNullApi
@NonNullFields

Imports

org.springframework.lang.NonNullApi, .NonNullFields

Support for annotation-based WebSocket setup in configuration classes.

Interface Summary

Modifier and Type	Interface and Description
public interface	StompEndpointRegistry A contract for registering STOMP over WebSocket endpoints.
public interface	StompWebSocketEndpointRegistration A contract for configuring a STOMP over WebSocket endpoint.
public interface	WebSocketConfigurer Defines callback methods to configure the WebSocket request handling via `@EnableWebSocket`.
public interface	WebSocketHandlerRegistration Provides methods for configuring a WebSocket handler.
public interface	WebSocketHandlerRegistry Provides methods for configuring `WebSocketHandler` request mappings.
public interface	WebSocketMessageBrokerConfigurer Defines methods for configuring message handling with simple messaging protocols (e.g. STOMP) from WebSocket clients.

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	EnableWebSocket Add this annotation to an `@Configuration` class to configure processing WebSocket requests.
public @interface	EnableWebSocketMessageBroker Add this annotation to an `@Configuration` class to enable broker-backed messaging over WebSocket using a higher-level messaging sub-protocol.

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractWebSocketHandlerRegistration< the mappings type M> Base class for `WebSocketHandlerRegistrations` that gathers all the configuration options but allows subclasses to put together the actual HTTP request mappings.
public class	DelegatingWebSocketConfiguration A variation of `WebSocketConfigurationSupport` that detects implementations of `WebSocketConfigurer` in Spring configuration and invokes them in order to configure WebSocket request handling.
public class	DelegatingWebSocketMessageBrokerConfiguration 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`.
public class	ServletWebSocketHandlerRegistration A helper class for configuring `WebSocketHandler` request handling including SockJS fallback options.
public class	ServletWebSocketHandlerRegistry `WebSocketHandlerRegistry` with Spring MVC handler mappings for the handshake requests.
public class	SockJsServiceRegistration A helper class for configuring SockJS fallback options for use with an `org.springframework.web.socket.config.annotation.EnableWebSocket` and `WebSocketConfigurer` setup.
public class	WebMvcStompEndpointRegistry A registry for STOMP over WebSocket endpoints that maps the endpoints with a `org.springframework.web.servlet.HandlerMapping` for use in Spring MVC.
public class	WebMvcStompWebSocketEndpointRegistration An abstract base class for configuring STOMP over WebSocket/SockJS endpoints.
public class	WebSocketConfigurationSupport Configuration support for WebSocket request handling.
public abstract class	WebSocketMessageBrokerConfigurationSupport Extends `AbstractMessageBrokerConfiguration` and adds configuration for receiving and responding to STOMP messages from WebSocket clients.
public class	WebSocketTransportRegistration Configure the processing of messages received from and sent to WebSocket clients.