Uses of Interface
org.springframework.web.socket.WebSocketHandler

Packages that use WebSocketHandler

Package	Description
org.springframework.web.socket.adapter.jetty	Adapter classes for the Jetty WebSocket API.
org.springframework.web.socket.adapter.standard	Adapter classes for the standard Jakarta WebSocket API.
org.springframework.web.socket.client	Client-side abstractions for WebSocket applications.
org.springframework.web.socket.client.standard	Client-side classes for use with standard Jakarta WebSocket endpoints.
org.springframework.web.socket.config.annotation	Support for annotation-based WebSocket setup in configuration classes.
org.springframework.web.socket.handler	Convenient WebSocketHandler implementations and decorators.
org.springframework.web.socket.messaging	WebSocket integration for Spring's messaging module.
org.springframework.web.socket.server	Server-side abstractions for WebSocket interactions.
org.springframework.web.socket.server.jetty	Server-side support for the Jetty WebSocket API.
org.springframework.web.socket.server.standard	Server-side classes for use with standard JSR-356 WebSocket endpoints.
org.springframework.web.socket.server.support	Server-side support classes including container-specific strategies for upgrading a request.
org.springframework.web.socket.sockjs	Top-level SockJS types.
org.springframework.web.socket.sockjs.client	SockJS client implementation of WebSocketClient.
org.springframework.web.socket.sockjs.support	Support classes for SockJS including an AbstractSockJsService implementation.
org.springframework.web.socket.sockjs.transport	Server-side support for SockJS transports including TransportHandler implementations for processing incoming requests, their session counterparts for sending messages over the various transports, and DefaultSockJsService.
org.springframework.web.socket.sockjs.transport.handler	TransportHandler implementation classes as well as a concrete SockJsService.
org.springframework.web.socket.sockjs.transport.session	SockJS specific implementations of WebSocketSession.

Uses of WebSocketHandler in org.springframework.web.socket.adapter.jetty

Constructors in org.springframework.web.socket.adapter.jetty with parameters of type WebSocketHandler

Modifier	Constructor	Description
	JettyWebSocketHandlerAdapter(WebSocketHandler webSocketHandler, JettyWebSocketSession wsSession)

Uses of WebSocketHandler in org.springframework.web.socket.adapter.standard

Constructors in org.springframework.web.socket.adapter.standard with parameters of type WebSocketHandler

Modifier	Constructor	Description
	StandardWebSocketHandlerAdapter(WebSocketHandler handler, StandardWebSocketSession wsSession)

Uses of WebSocketHandler in org.springframework.web.socket.client

Methods in org.springframework.web.socket.client that return WebSocketHandler

Modifier and Type	Method	Description
protected WebSocketHandler	WebSocketConnectionManager.decorateWebSocketHandler(WebSocketHandler handler)	Decorate the WebSocketHandler provided to the class constructor.

Methods in org.springframework.web.socket.client with parameters of type WebSocketHandler

Modifier and Type	Method	Description
protected WebSocketHandler	WebSocketConnectionManager.decorateWebSocketHandler(WebSocketHandler handler)	Decorate the WebSocketHandler provided to the class constructor.
final CompletableFuture<WebSocketSession>	AbstractWebSocketClient.execute(WebSocketHandler webSocketHandler, @Nullable WebSocketHttpHeaders headers, URI uri)
CompletableFuture<WebSocketSession>	AbstractWebSocketClient.execute(WebSocketHandler webSocketHandler, String uriTemplate, @Nullable Object... uriVars)
CompletableFuture<WebSocketSession>	WebSocketClient.execute(WebSocketHandler webSocketHandler, @Nullable WebSocketHttpHeaders headers, URI uri)	Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.
CompletableFuture<WebSocketSession>	WebSocketClient.execute(WebSocketHandler webSocketHandler, String uriTemplate, @Nullable Object... uriVariables)	Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.
protected abstract CompletableFuture<WebSocketSession>	AbstractWebSocketClient.executeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URI uri, List<String> subProtocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)	Perform the actual handshake to establish a connection to the server.

Constructors in org.springframework.web.socket.client with parameters of type WebSocketHandler

Modifier	Constructor	Description
	WebSocketConnectionManager(WebSocketClient client, WebSocketHandler webSocketHandler, String uriTemplate, @Nullable Object... uriVariables)	Constructor with the client to use and a handler to handle messages with.
	WebSocketConnectionManager(WebSocketClient client, WebSocketHandler webSocketHandler, URI uri)	Variant of WebSocketConnectionManager(WebSocketClient, WebSocketHandler, String, Object...) with a prepared URI.

Uses of WebSocketHandler in org.springframework.web.socket.client.standard

Methods in org.springframework.web.socket.client.standard with parameters of type WebSocketHandler

Modifier and Type	Method	Description
protected CompletableFuture<WebSocketSession>	StandardWebSocketClient.executeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)

Uses of WebSocketHandler in org.springframework.web.socket.config.annotation

Methods in org.springframework.web.socket.config.annotation that return WebSocketHandler

Modifier and Type	Method	Description
protected WebSocketHandler	WebSocketMessageBrokerConfigurationSupport.decorateWebSocketHandler(WebSocketHandler handler)
WebSocketHandler	WebSocketMessageBrokerConfigurationSupport.subProtocolWebSocketHandler(AbstractSubscribableChannel clientInboundChannel, AbstractSubscribableChannel clientOutboundChannel)

Methods in org.springframework.web.socket.config.annotation with parameters of type WebSocketHandler

Modifier and Type	Method	Description
WebSocketHandlerRegistration	AbstractWebSocketHandlerRegistration.addHandler(WebSocketHandler handler, String... paths)
WebSocketHandlerRegistration	ServletWebSocketHandlerRegistry.addHandler(WebSocketHandler handler, String... paths)
WebSocketHandlerRegistration	WebSocketHandlerRegistration.addHandler(WebSocketHandler handler, String... paths)	Add more handlers that will share the same configuration (interceptors, SockJS config, etc).
WebSocketHandlerRegistration	WebSocketHandlerRegistry.addHandler(WebSocketHandler webSocketHandler, String... paths)	Configure a WebSocketHandler at the specified URL paths.
protected abstract void	AbstractWebSocketHandlerRegistration.addSockJsServiceMapping(M mappings, SockJsService sockJsService, WebSocketHandler handler, String pathPattern)
protected void	ServletWebSocketHandlerRegistration.addSockJsServiceMapping(MultiValueMap<HttpRequestHandler,String> mappings, SockJsService sockJsService, WebSocketHandler handler, String pathPattern)
protected abstract void	AbstractWebSocketHandlerRegistration.addWebSocketHandlerMapping(M mappings, WebSocketHandler wsHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, String path)
protected void	ServletWebSocketHandlerRegistration.addWebSocketHandlerMapping(MultiValueMap<HttpRequestHandler,String> mappings, WebSocketHandler webSocketHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, String path)
protected WebSocketHandler	WebSocketMessageBrokerConfigurationSupport.decorateWebSocketHandler(WebSocketHandler handler)
HandlerMapping	WebSocketMessageBrokerConfigurationSupport.stompWebSocketHandlerMapping(WebSocketHandler subProtocolWebSocketHandler, TaskScheduler messageBrokerTaskScheduler, AbstractSubscribableChannel clientInboundChannel)
WebSocketMessageBrokerStats	WebSocketMessageBrokerConfigurationSupport.webSocketMessageBrokerStats(@Nullable AbstractBrokerMessageHandler stompBrokerRelayMessageHandler, WebSocketHandler subProtocolWebSocketHandler, TaskExecutor inboundExecutor, TaskExecutor outboundExecutor, TaskScheduler scheduler)

Constructors in org.springframework.web.socket.config.annotation with parameters of type WebSocketHandler

Modifier	Constructor	Description
	WebMvcStompEndpointRegistry(WebSocketHandler webSocketHandler, WebSocketTransportRegistration transportRegistration, TaskScheduler defaultSockJsTaskScheduler)
	WebMvcStompWebSocketEndpointRegistration(String[] paths, WebSocketHandler webSocketHandler, TaskScheduler sockJsTaskScheduler)

Uses of WebSocketHandler in org.springframework.web.socket.handler

Classes in org.springframework.web.socket.handler that implement WebSocketHandler

Modifier and Type	Class	Description
class	AbstractWebSocketHandler	A convenient base class for WebSocketHandler implementation with empty methods.
class	BinaryWebSocketHandler	A convenient base class for WebSocketHandler implementations that process binary messages only.
class	ExceptionWebSocketHandlerDecorator	An exception handling WebSocketHandlerDecorator.
class	LoggingWebSocketHandlerDecorator	A WebSocketHandlerDecorator that adds logging to WebSocket lifecycle events.
class	PerConnectionWebSocketHandler	A WebSocketHandler that initializes and destroys a WebSocketHandler instance for each WebSocket connection and delegates all other methods to it.
class	TextWebSocketHandler	A convenient base class for WebSocketHandler implementations that process text messages only.
class	WebSocketHandlerDecorator	Wraps another WebSocketHandler instance and delegates to it.

Methods in org.springframework.web.socket.handler that return WebSocketHandler

Modifier and Type	Method	Description
WebSocketHandler	WebSocketHandlerDecoratorFactory.decorate(WebSocketHandler handler)	Decorate the given WebSocketHandler.
WebSocketHandler	WebSocketHandlerDecorator.getDelegate()
WebSocketHandler	WebSocketHandlerDecorator.getLastHandler()
static WebSocketHandler	WebSocketHandlerDecorator.unwrap(WebSocketHandler handler)

Methods in org.springframework.web.socket.handler with parameters of type WebSocketHandler

Modifier and Type	Method	Description
WebSocketHandler	WebSocketHandlerDecoratorFactory.decorate(WebSocketHandler handler)	Decorate the given WebSocketHandler.
static WebSocketHandler	WebSocketHandlerDecorator.unwrap(WebSocketHandler handler)

Constructors in org.springframework.web.socket.handler with parameters of type WebSocketHandler

Modifier	Constructor	Description
	ExceptionWebSocketHandlerDecorator(WebSocketHandler delegate)
	LoggingWebSocketHandlerDecorator(WebSocketHandler delegate)
	WebSocketHandlerDecorator(WebSocketHandler delegate)

Constructor parameters in org.springframework.web.socket.handler with type arguments of type WebSocketHandler

Modifier	Constructor	Description
	PerConnectionWebSocketHandler(Class<? extends WebSocketHandler> handlerType)
	PerConnectionWebSocketHandler(Class<? extends WebSocketHandler> handlerType, boolean supportsPartialMessages)

Uses of WebSocketHandler in org.springframework.web.socket.messaging

Classes in org.springframework.web.socket.messaging that implement WebSocketHandler

Modifier and Type	Class	Description
class	SubProtocolWebSocketHandler	An implementation of WebSocketHandler that delegates incoming WebSocket messages to a SubProtocolHandler along with a MessageChannel to which the sub-protocol handler can send messages from WebSocket clients to the application.

Uses of WebSocketHandler in org.springframework.web.socket.server

Methods in org.springframework.web.socket.server with parameters of type WebSocketHandler

Modifier and Type	Method	Description
void	HandshakeInterceptor.afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, @Nullable Exception exception)	Invoked after the handshake is done.
boolean	HandshakeInterceptor.beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)	Invoked before the handshake is processed.
boolean	HandshakeHandler.doHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)	Initiate the handshake.
void	RequestUpgradeStrategy.upgrade(ServerHttpRequest request, ServerHttpResponse response, @Nullable String selectedProtocol, List<WebSocketExtension> selectedExtensions, @Nullable Principal user, WebSocketHandler wsHandler, Map<String,Object> attributes)	Perform runtime specific steps to complete the upgrade.

Uses of WebSocketHandler in org.springframework.web.socket.server.jetty

Methods in org.springframework.web.socket.server.jetty with parameters of type WebSocketHandler

Modifier and Type	Method	Description
void	JettyRequestUpgradeStrategy.upgrade(ServerHttpRequest request, ServerHttpResponse response, @Nullable String selectedProtocol, List<WebSocketExtension> selectedExtensions, @Nullable Principal user, WebSocketHandler handler, Map<String,Object> attributes)

Uses of WebSocketHandler in org.springframework.web.socket.server.standard

Methods in org.springframework.web.socket.server.standard with parameters of type WebSocketHandler

Modifier and Type	Method	Description
void	StandardWebSocketUpgradeStrategy.upgrade(ServerHttpRequest request, ServerHttpResponse response, @Nullable String selectedProtocol, List<WebSocketExtension> selectedExtensions, @Nullable Principal user, WebSocketHandler wsHandler, Map<String,Object> attrs)

Uses of WebSocketHandler in org.springframework.web.socket.server.support

Methods in org.springframework.web.socket.server.support that return WebSocketHandler

Modifier and Type	Method	Description
protected WebSocketHandler	WebSocketHttpRequestHandler.decorate(WebSocketHandler handler)	Decorate the WebSocketHandler passed into the constructor.
WebSocketHandler	WebSocketHttpRequestHandler.getWebSocketHandler()	Return the WebSocketHandler.

Methods in org.springframework.web.socket.server.support with parameters of type WebSocketHandler

Modifier and Type	Method	Description
void	HttpSessionHandshakeInterceptor.afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, @Nullable Exception ex)
void	OriginHandshakeInterceptor.afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, @Nullable Exception exception)
boolean	HttpSessionHandshakeInterceptor.beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)
boolean	OriginHandshakeInterceptor.beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)
protected WebSocketHandler	WebSocketHttpRequestHandler.decorate(WebSocketHandler handler)	Decorate the WebSocketHandler passed into the constructor.
protected final List<String>	AbstractHandshakeHandler.determineHandlerSupportedProtocols(WebSocketHandler handler)	Determine the sub-protocols supported by the given WebSocketHandler by checking whether it is an instance of SubProtocolCapable.
protected @Nullable Principal	AbstractHandshakeHandler.determineUser(ServerHttpRequest request, WebSocketHandler wsHandler, Map<String,Object> attributes)	A method that can be used to associate a user with the WebSocket session in the process of being established.
final boolean	AbstractHandshakeHandler.doHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)
protected @Nullable String	AbstractHandshakeHandler.selectProtocol(List<String> requestedProtocols, WebSocketHandler webSocketHandler)	Perform the sub-protocol negotiation based on requested and supported sub-protocols.

Constructors in org.springframework.web.socket.server.support with parameters of type WebSocketHandler

Modifier	Constructor	Description
	HandshakeInterceptorChain(@Nullable List<HandshakeInterceptor> interceptors, WebSocketHandler wsHandler)
	WebSocketHttpRequestHandler(WebSocketHandler wsHandler)
	WebSocketHttpRequestHandler(WebSocketHandler wsHandler, HandshakeHandler handshakeHandler)

Uses of WebSocketHandler in org.springframework.web.socket.sockjs

Methods in org.springframework.web.socket.sockjs with parameters of type WebSocketHandler

Modifier and Type	Method	Description
void	SockJsService.handleRequest(ServerHttpRequest request, ServerHttpResponse response, @Nullable String sockJsPath, WebSocketHandler handler)	Process a SockJS HTTP request.

Uses of WebSocketHandler in org.springframework.web.socket.sockjs.client

Methods in org.springframework.web.socket.sockjs.client that return WebSocketHandler

Modifier and Type	Method	Description
WebSocketHandler	AbstractClientSockJsSession.getWebSocketHandler()

Methods in org.springframework.web.socket.sockjs.client with parameters of type WebSocketHandler

Modifier and Type	Method	Description
CompletableFuture<WebSocketSession>	AbstractXhrTransport.connectAsync(TransportRequest request, WebSocketHandler handler)
CompletableFuture<WebSocketSession>	Transport.connectAsync(TransportRequest request, WebSocketHandler webSocketHandler)	Connect the transport.
CompletableFuture<WebSocketSession>	WebSocketTransport.connectAsync(TransportRequest request, WebSocketHandler handler)
protected abstract void	AbstractXhrTransport.connectInternal(TransportRequest request, WebSocketHandler handler, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFuture<WebSocketSession> connectFuture)
protected void	JettyXhrTransport.connectInternal(TransportRequest transportRequest, WebSocketHandler handler, URI url, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFuture<WebSocketSession> connectFuture)
protected void	RestTemplateXhrTransport.connectInternal(TransportRequest transportRequest, WebSocketHandler handler, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFuture<WebSocketSession> connectFuture)
protected void	UndertowXhrTransport.connectInternal(TransportRequest request, WebSocketHandler handler, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFuture<WebSocketSession> connectFuture)
final CompletableFuture<WebSocketSession>	SockJsClient.execute(WebSocketHandler handler, @Nullable WebSocketHttpHeaders headers, URI url)
CompletableFuture<WebSocketSession>	SockJsClient.execute(WebSocketHandler handler, String uriTemplate, @Nullable Object... uriVars)

Constructors in org.springframework.web.socket.sockjs.client with parameters of type WebSocketHandler

Modifier	Constructor	Description
protected	AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, CompletableFuture<WebSocketSession> connectFuture)
	WebSocketClientSockJsSession(TransportRequest request, WebSocketHandler handler, CompletableFuture<WebSocketSession> connectFuture)
	XhrClientSockJsSession(TransportRequest request, WebSocketHandler handler, XhrTransport transport, CompletableFuture<WebSocketSession> connectFuture)	Create a new XhrClientSockJsSession.

Uses of WebSocketHandler in org.springframework.web.socket.sockjs.support

Methods in org.springframework.web.socket.sockjs.support that return WebSocketHandler

Modifier and Type	Method	Description
WebSocketHandler	SockJsHttpRequestHandler.getWebSocketHandler()	Return the WebSocketHandler.

Methods in org.springframework.web.socket.sockjs.support with parameters of type WebSocketHandler

Modifier and Type	Method	Description
protected abstract void	AbstractSockJsService.handleRawWebSocketRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler webSocketHandler)	Handle request for raw WebSocket communication, i.e.
final void	AbstractSockJsService.handleRequest(ServerHttpRequest request, ServerHttpResponse response, @Nullable String sockJsPath, WebSocketHandler wsHandler)	This method determines the SockJS path and handles SockJS static URLs.
protected abstract void	AbstractSockJsService.handleTransportRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler webSocketHandler, String sessionId, String transport)	Handle a SockJS session URL (i.e.

Constructors in org.springframework.web.socket.sockjs.support with parameters of type WebSocketHandler

Modifier	Constructor	Description
	SockJsHttpRequestHandler(SockJsService sockJsService, WebSocketHandler webSocketHandler)	Create a new SockJsHttpRequestHandler.

Uses of WebSocketHandler in org.springframework.web.socket.sockjs.transport

Methods in org.springframework.web.socket.sockjs.transport with parameters of type WebSocketHandler

Modifier and Type	Method	Description
SockJsSession	SockJsSessionFactory.createSession(String sessionId, WebSocketHandler handler, Map<String,Object> attributes)	Create a new SockJS session.
protected void	TransportHandlingSockJsService.handleRawWebSocketRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler)
void	TransportHandler.handleRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, SockJsSession session)	Handle the given request and delegate messages to the provided WebSocketHandler.
protected void	TransportHandlingSockJsService.handleTransportRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, String sessionId, String transport)

Uses of WebSocketHandler in org.springframework.web.socket.sockjs.transport.handler

Classes in org.springframework.web.socket.sockjs.transport.handler that implement WebSocketHandler

Modifier and Type	Class	Description
class	SockJsWebSocketHandler	An implementation of WebSocketHandler that adds SockJS messages frames, sends SockJS heartbeat messages, and delegates lifecycle events and messages to a target WebSocketHandler.

Methods in org.springframework.web.socket.sockjs.transport.handler with parameters of type WebSocketHandler

Modifier and Type	Method	Description
StreamingSockJsSession	EventSourceTransportHandler.createSession(String sessionId, WebSocketHandler handler, Map<String,Object> attributes)
StreamingSockJsSession	HtmlFileTransportHandler.createSession(String sessionId, WebSocketHandler handler, Map<String,Object> attributes)
AbstractSockJsSession	WebSocketTransportHandler.createSession(String id, WebSocketHandler handler, Map<String,Object> attrs)
PollingSockJsSession	XhrPollingTransportHandler.createSession(String sessionId, WebSocketHandler handler, Map<String,Object> attributes)
StreamingSockJsSession	XhrStreamingTransportHandler.createSession(String sessionId, WebSocketHandler handler, Map<String,Object> attributes)
boolean	WebSocketTransportHandler.doHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, Map<String,Object> attributes)
final void	AbstractHttpReceivingTransportHandler.handleRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, SockJsSession wsSession)
final void	AbstractHttpSendingTransportHandler.handleRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, SockJsSession wsSession)
void	WebSocketTransportHandler.handleRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, SockJsSession wsSession)
protected void	AbstractHttpReceivingTransportHandler.handleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, AbstractHttpSockJsSession sockJsSession)

Constructors in org.springframework.web.socket.sockjs.transport.handler with parameters of type WebSocketHandler

Modifier	Constructor	Description
	SockJsWebSocketHandler(SockJsServiceConfig serviceConfig, WebSocketHandler webSocketHandler, WebSocketServerSockJsSession sockJsSession)

Uses of WebSocketHandler in org.springframework.web.socket.sockjs.transport.session

Constructors in org.springframework.web.socket.sockjs.transport.session with parameters of type WebSocketHandler

Modifier	Constructor	Description
	AbstractHttpSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String,Object> attributes)
	AbstractSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler handler, @Nullable Map<String,Object> attributes)	Create a new instance.
	PollingSockJsSession(String sessionId, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String,Object> attributes)
	StreamingSockJsSession(String sessionId, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String,Object> attributes)
	WebSocketServerSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler handler, @Nullable Map<String,Object> attributes)