Uses of Interface
org.springframework.web.socket.WebSocketSession
Packages that use WebSocketSession Package Description org.springframework.web.socket Common abstractions and Spring configuration support for WebSocket applications.org.springframework.web.socket.adapter Classes adapting Spring's WebSocket API to and from WebSocket providers.org.springframework.web.socket.adapter.jetty Adapter classes for the Jetty WebSocket API.org.springframework.web.socket.adapter.standard Adapter classes for the standard Java WebSocket API.org.springframework.web.socket.client Client-side abstractions for WebSocket applications.org.springframework.web.socket.client.jetty Client-side support for the Jetty WebSocket API.org.springframework.web.socket.client.standard Client-side classes for use with standard Java WebSocket endpoints.org.springframework.web.socket.handler ConvenientWebSocketHandlerimplementations and decorators.org.springframework.web.socket.messaging WebSocket integration for Spring's messaging module.org.springframework.web.socket.sockjs.client SockJS client implementation ofWebSocketClient.org.springframework.web.socket.sockjs.transport Server-side support for SockJS transports includingTransportHandlerimplementations for processing incoming requests, theirsessioncounterparts for sending messages over the various transports, andDefaultSockJsService.org.springframework.web.socket.sockjs.transport.handler TransportHandlerimplementation classes as well as a concreteSockJsService.org.springframework.web.socket.sockjs.transport.session SockJS specific implementations ofWebSocketSession.Uses of WebSocketSession in org.springframework.web.socket
Methods in org.springframework.web.socket with parameters of type WebSocketSession Modifier and Type Method Description voidWebSocketHandler. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred.voidWebSocketHandler. afterConnectionEstablished(WebSocketSession session)Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.voidWebSocketHandler. handleMessage(WebSocketSession session, WebSocketMessage<?> message)Invoked when a new WebSocket message arrives.voidWebSocketHandler. handleTransportError(WebSocketSession session, Throwable exception)Handle an error from the underlying WebSocket message transport.Uses of WebSocketSession in org.springframework.web.socket.adapter
Subinterfaces of WebSocketSession in org.springframework.web.socket.adapter Modifier and Type Interface Description interfaceNativeWebSocketSessionAWebSocketSessionthat exposes the underlying, native WebSocketSession through a getter.Classes in org.springframework.web.socket.adapter that implement WebSocketSession Modifier and Type Class Description classAbstractWebSocketSession<T>An abstract base class for implementations ofWebSocketSession.Uses of WebSocketSession in org.springframework.web.socket.adapter.jetty
Classes in org.springframework.web.socket.adapter.jetty that implement WebSocketSession Modifier and Type Class Description classJettyWebSocketSessionAWebSocketSessionfor use with the Jetty 9.4 WebSocket API.Uses of WebSocketSession in org.springframework.web.socket.adapter.standard
Classes in org.springframework.web.socket.adapter.standard that implement WebSocketSession Modifier and Type Class Description classStandardWebSocketSessionAWebSocketSessionfor use with the standard WebSocket for Java API.Uses of WebSocketSession in org.springframework.web.socket.client
Methods in org.springframework.web.socket.client that return types with arguments of type WebSocketSession Modifier and Type Method Description ListenableFuture<WebSocketSession>AbstractWebSocketClient. doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVars)ListenableFuture<WebSocketSession>AbstractWebSocketClient. doHandshake(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri)ListenableFuture<WebSocketSession>WebSocketClient. doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVariables)ListenableFuture<WebSocketSession>WebSocketClient. doHandshake(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri)protected abstract ListenableFuture<WebSocketSession>AbstractWebSocketClient. doHandshakeInternal(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.Uses of WebSocketSession in org.springframework.web.socket.client.jetty
Methods in org.springframework.web.socket.client.jetty that return types with arguments of type WebSocketSession Modifier and Type Method Description ListenableFuture<WebSocketSession>JettyWebSocketClient. doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVars)ListenableFuture<WebSocketSession>JettyWebSocketClient. doHandshakeInternal(WebSocketHandler wsHandler, HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)Uses of WebSocketSession in org.springframework.web.socket.client.standard
Methods in org.springframework.web.socket.client.standard that return types with arguments of type WebSocketSession Modifier and Type Method Description protected ListenableFuture<WebSocketSession>StandardWebSocketClient. doHandshakeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)Uses of WebSocketSession in org.springframework.web.socket.handler
Classes in org.springframework.web.socket.handler that implement WebSocketSession Modifier and Type Class Description classConcurrentWebSocketSessionDecoratorWrap aWebSocketSessionto guarantee only one thread can send messages at a time.classWebSocketSessionDecoratorWraps anotherWebSocketSessioninstance and delegates to it.Methods in org.springframework.web.socket.handler that return WebSocketSession Modifier and Type Method Description WebSocketSessionWebSocketSessionDecorator. getDelegate()WebSocketSessionWebSocketSessionDecorator. getLastSession()static WebSocketSessionWebSocketSessionDecorator. unwrap(WebSocketSession session)Methods in org.springframework.web.socket.handler with parameters of type WebSocketSession Modifier and Type Method Description voidAbstractWebSocketHandler. afterConnectionClosed(WebSocketSession session, CloseStatus status)voidExceptionWebSocketHandlerDecorator. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)voidLoggingWebSocketHandlerDecorator. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)voidPerConnectionWebSocketHandler. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)voidWebSocketHandlerDecorator. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)voidAbstractWebSocketHandler. afterConnectionEstablished(WebSocketSession session)voidExceptionWebSocketHandlerDecorator. afterConnectionEstablished(WebSocketSession session)voidLoggingWebSocketHandlerDecorator. afterConnectionEstablished(WebSocketSession session)voidPerConnectionWebSocketHandler. afterConnectionEstablished(WebSocketSession session)voidWebSocketHandlerDecorator. afterConnectionEstablished(WebSocketSession session)protected voidAbstractWebSocketHandler. handleBinaryMessage(WebSocketSession session, BinaryMessage message)protected voidTextWebSocketHandler. handleBinaryMessage(WebSocketSession session, BinaryMessage message)voidAbstractWebSocketHandler. handleMessage(WebSocketSession session, WebSocketMessage<?> message)voidExceptionWebSocketHandlerDecorator. handleMessage(WebSocketSession session, WebSocketMessage<?> message)voidLoggingWebSocketHandlerDecorator. handleMessage(WebSocketSession session, WebSocketMessage<?> message)voidPerConnectionWebSocketHandler. handleMessage(WebSocketSession session, WebSocketMessage<?> message)voidWebSocketHandlerDecorator. handleMessage(WebSocketSession session, WebSocketMessage<?> message)protected voidAbstractWebSocketHandler. handlePongMessage(WebSocketSession session, PongMessage message)protected voidAbstractWebSocketHandler. handleTextMessage(WebSocketSession session, TextMessage message)protected voidBinaryWebSocketHandler. handleTextMessage(WebSocketSession session, TextMessage message)voidAbstractWebSocketHandler. handleTransportError(WebSocketSession session, Throwable exception)voidExceptionWebSocketHandlerDecorator. handleTransportError(WebSocketSession session, Throwable exception)voidLoggingWebSocketHandlerDecorator. handleTransportError(WebSocketSession session, Throwable exception)voidPerConnectionWebSocketHandler. handleTransportError(WebSocketSession session, Throwable exception)voidWebSocketHandlerDecorator. handleTransportError(WebSocketSession session, Throwable exception)static voidExceptionWebSocketHandlerDecorator. tryCloseWithError(WebSocketSession session, Throwable exception, Log logger)static WebSocketSessionWebSocketSessionDecorator. unwrap(WebSocketSession session)Constructors in org.springframework.web.socket.handler with parameters of type WebSocketSession Constructor Description ConcurrentWebSocketSessionDecorator(WebSocketSession delegate, int sendTimeLimit, int bufferSizeLimit)Basic constructor.ConcurrentWebSocketSessionDecorator(WebSocketSession delegate, int sendTimeLimit, int bufferSizeLimit, ConcurrentWebSocketSessionDecorator.OverflowStrategy overflowStrategy)Constructor that also specifies the overflow strategy to use.WebSocketSessionDecorator(WebSocketSession session)Uses of WebSocketSession in org.springframework.web.socket.messaging
Methods in org.springframework.web.socket.messaging that return WebSocketSession Modifier and Type Method Description protected WebSocketSessionSubProtocolWebSocketHandler. decorateSession(WebSocketSession session)Decorate the givenWebSocketSession, if desired.Methods in org.springframework.web.socket.messaging with parameters of type WebSocketSession Modifier and Type Method Description voidSubProtocolWebSocketHandler. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)voidSubProtocolWebSocketHandler. afterConnectionEstablished(WebSocketSession session)voidStompSubProtocolHandler. afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)voidSubProtocolHandler. afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)Invoked after aWebSocketSessionhas ended.voidStompSubProtocolHandler. afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)voidSubProtocolHandler. afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)Invoked after aWebSocketSessionhas started.protected WebSocketSessionSubProtocolWebSocketHandler. decorateSession(WebSocketSession session)Decorate the givenWebSocketSession, if desired.protected SubProtocolHandlerSubProtocolWebSocketHandler. findProtocolHandler(WebSocketSession session)Find aSubProtocolHandlerfor the given session.voidSubProtocolWebSocketHandler. handleMessage(WebSocketSession session, WebSocketMessage<?> message)Handle an inbound message from a WebSocket client.voidStompSubProtocolHandler. handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> webSocketMessage, MessageChannel outputChannel)Handle incoming WebSocket messages from clients.voidSubProtocolHandler. handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> message, MessageChannel outputChannel)Handle the givenWebSocketMessagereceived from a client.voidStompSubProtocolHandler. handleMessageToClient(WebSocketSession session, Message<?> message)Handle STOMP messages going back out to WebSocket clients.voidSubProtocolHandler. handleMessageToClient(WebSocketSession session, Message<?> message)Handle the givenMessageto the client associated with the given WebSocket session.voidSubProtocolWebSocketHandler. handleTransportError(WebSocketSession session, Throwable exception)Uses of WebSocketSession in org.springframework.web.socket.sockjs.client
Classes in org.springframework.web.socket.sockjs.client that implement WebSocketSession Modifier and Type Class Description classAbstractClientSockJsSessionBase class for SockJS client implementations ofWebSocketSession.classWebSocketClientSockJsSessionAn extension ofAbstractClientSockJsSessionwrapping and delegating to an actual WebSocket session.classXhrClientSockJsSessionAn extension ofAbstractClientSockJsSessionfor use with HTTP transports simulating a WebSocket session.Methods in org.springframework.web.socket.sockjs.client that return types with arguments of type WebSocketSession Modifier and Type Method Description ListenableFuture<WebSocketSession>AbstractXhrTransport. connect(TransportRequest request, WebSocketHandler handler)ListenableFuture<WebSocketSession>Transport. connect(TransportRequest request, WebSocketHandler webSocketHandler)Connect the transport.ListenableFuture<WebSocketSession>WebSocketTransport. connect(TransportRequest request, WebSocketHandler handler)ListenableFuture<WebSocketSession>SockJsClient. doHandshake(WebSocketHandler handler, String uriTemplate, Object... uriVars)ListenableFuture<WebSocketSession>SockJsClient. doHandshake(WebSocketHandler handler, WebSocketHttpHeaders headers, URI url)Methods in org.springframework.web.socket.sockjs.client with parameters of type WebSocketSession Modifier and Type Method Description voidWebSocketClientSockJsSession. initializeDelegateSession(WebSocketSession session)Method parameters in org.springframework.web.socket.sockjs.client with type arguments of type WebSocketSession Modifier and Type Method Description protected abstract voidAbstractXhrTransport. connectInternal(TransportRequest request, WebSocketHandler handler, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)protected voidJettyXhrTransport. connectInternal(TransportRequest transportRequest, WebSocketHandler handler, URI url, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)protected voidRestTemplateXhrTransport. connectInternal(TransportRequest transportRequest, WebSocketHandler handler, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)protected voidUndertowXhrTransport. connectInternal(TransportRequest request, WebSocketHandler handler, URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)Constructor parameters in org.springframework.web.socket.sockjs.client with type arguments of type WebSocketSession Constructor Description AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture)WebSocketClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture)XhrClientSockJsSession(TransportRequest request, WebSocketHandler handler, XhrTransport transport, SettableListenableFuture<WebSocketSession> connectFuture)Uses of WebSocketSession in org.springframework.web.socket.sockjs.transport
Subinterfaces of WebSocketSession in org.springframework.web.socket.sockjs.transport Modifier and Type Interface Description interfaceSockJsSessionSockJS extension of Spring's standardWebSocketSession.Uses of WebSocketSession in org.springframework.web.socket.sockjs.transport.handler
Methods in org.springframework.web.socket.sockjs.transport.handler with parameters of type WebSocketSession Modifier and Type Method Description voidSockJsWebSocketHandler. afterConnectionClosed(WebSocketSession wsSession, CloseStatus status)voidSockJsWebSocketHandler. afterConnectionEstablished(WebSocketSession wsSession)voidSockJsWebSocketHandler. handleTextMessage(WebSocketSession wsSession, TextMessage message)voidSockJsWebSocketHandler. handleTransportError(WebSocketSession webSocketSession, Throwable exception)Uses of WebSocketSession in org.springframework.web.socket.sockjs.transport.session
Classes in org.springframework.web.socket.sockjs.transport.session that implement WebSocketSession Modifier and Type Class Description classAbstractHttpSockJsSessionAn abstract base class for use with HTTP transport SockJS sessions.classAbstractSockJsSessionAn abstract base class for SockJS sessions implementingSockJsSession.classPollingSockJsSessionA SockJS session for use with polling HTTP transports.classStreamingSockJsSessionA SockJS session for use with streaming HTTP transports.classWebSocketServerSockJsSessionA SockJS session for use with the WebSocket transport.Methods in org.springframework.web.socket.sockjs.transport.session with parameters of type WebSocketSession Modifier and Type Method Description voidWebSocketServerSockJsSession. handleMessage(TextMessage message, WebSocketSession wsSession)voidWebSocketServerSockJsSession. initializeDelegateSession(WebSocketSession session)