| Package | Description | 
|---|---|
| org.springframework.web.socket | 
 Common abstractions and Spring configuration support for WebSocket applications. 
 | 
| 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 | 
 Convenient  
WebSocketHandler
 implementations and decorators. | 
| org.springframework.web.socket.server | 
 Server-side abstractions for WebSocket interactions. 
 | 
| org.springframework.web.socket.server.jetty | 
 Server-side support for the Jetty 9+ 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.client | 
 SockJS client implementation of
  
WebSocketClient. | 
| org.springframework.web.socket.sockjs.transport.session | 
 SockJS specific implementations of
  
WebSocketSession. | 
| Modifier and Type | Method and Description | 
|---|---|
List<WebSocketExtension> | 
WebSocketSession.getExtensions()
Determine the negotiated extensions. 
 | 
List<WebSocketExtension> | 
WebSocketHttpHeaders.getSecWebSocketExtensions()
Returns the value of the  
Sec-WebSocket-Extensions header. | 
static List<WebSocketExtension> | 
WebSocketExtension.parseExtensions(String extensions)
Parse the given, comma-separated string into a list of  
WebSocketExtension objects. | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
WebSocketHttpHeaders.setSecWebSocketExtensions(List<WebSocketExtension> extensions)
Sets the (new) value(s) of the  
Sec-WebSocket-Extensions header. | 
| Modifier and Type | Method and Description | 
|---|---|
List<WebSocketExtension> | 
JettyWebSocketSession.getExtensions()  | 
| Constructor and Description | 
|---|
WebSocketToJettyExtensionConfigAdapter(WebSocketExtension extension)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
StandardToWebSocketExtensionAdapter
A sub-class of  
WebSocketExtension that
 can be constructed from an Extension. | 
| Modifier and Type | Method and Description | 
|---|---|
List<WebSocketExtension> | 
StandardWebSocketSession.getExtensions()  | 
| Constructor and Description | 
|---|
WebSocketToStandardExtensionAdapter(WebSocketExtension extension)  | 
| Modifier and Type | Method and Description | 
|---|---|
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. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
ListenableFuture<WebSocketSession> | 
JettyWebSocketClient.doHandshakeInternal(WebSocketHandler wsHandler,
                   HttpHeaders headers,
                   URI uri,
                   List<String> protocols,
                   List<WebSocketExtension> extensions,
                   Map<String,Object> attributes)  | 
| Modifier and Type | Method and Description | 
|---|---|
protected ListenableFuture<WebSocketSession> | 
StandardWebSocketClient.doHandshakeInternal(WebSocketHandler webSocketHandler,
                   HttpHeaders headers,
                   URI uri,
                   List<String> protocols,
                   List<WebSocketExtension> extensions,
                   Map<String,Object> attributes)  | 
| Modifier and Type | Method and Description | 
|---|---|
List<WebSocketExtension> | 
WebSocketSessionDecorator.getExtensions()  | 
| Modifier and Type | Method and Description | 
|---|---|
List<WebSocketExtension> | 
RequestUpgradeStrategy.getSupportedExtensions(ServerHttpRequest request)
Return the WebSocket protocol extensions supported by the underlying WebSocket server. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
RequestUpgradeStrategy.upgrade(ServerHttpRequest request,
       ServerHttpResponse response,
       String selectedProtocol,
       List<WebSocketExtension> selectedExtensions,
       Principal user,
       WebSocketHandler wsHandler,
       Map<String,Object> attributes)
Perform runtime specific steps to complete the upgrade. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
List<WebSocketExtension> | 
JettyRequestUpgradeStrategy.getSupportedExtensions(ServerHttpRequest request)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
JettyRequestUpgradeStrategy.upgrade(ServerHttpRequest request,
       ServerHttpResponse response,
       String selectedProtocol,
       List<WebSocketExtension> selectedExtensions,
       Principal user,
       WebSocketHandler wsHandler,
       Map<String,Object> attributes)  | 
| Modifier and Type | Method and Description | 
|---|---|
protected List<WebSocketExtension> | 
AbstractStandardUpgradeStrategy.getInstalledExtensions(WebSocketContainer container)  | 
protected List<WebSocketExtension> | 
AbstractTyrusRequestUpgradeStrategy.getInstalledExtensions(WebSocketContainer container)  | 
List<WebSocketExtension> | 
AbstractStandardUpgradeStrategy.getSupportedExtensions(ServerHttpRequest request)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
AbstractStandardUpgradeStrategy.upgrade(ServerHttpRequest request,
       ServerHttpResponse response,
       String selectedProtocol,
       List<WebSocketExtension> selectedExtensions,
       Principal user,
       WebSocketHandler wsHandler,
       Map<String,Object> attrs)  | 
| Modifier and Type | Method and Description | 
|---|---|
protected List<WebSocketExtension> | 
AbstractHandshakeHandler.filterRequestedExtensions(ServerHttpRequest request,
                         List<WebSocketExtension> requestedExtensions,
                         List<WebSocketExtension> supportedExtensions)
Filter the list of requested WebSocket extensions. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected List<WebSocketExtension> | 
AbstractHandshakeHandler.filterRequestedExtensions(ServerHttpRequest request,
                         List<WebSocketExtension> requestedExtensions,
                         List<WebSocketExtension> supportedExtensions)
Filter the list of requested WebSocket extensions. 
 | 
protected List<WebSocketExtension> | 
AbstractHandshakeHandler.filterRequestedExtensions(ServerHttpRequest request,
                         List<WebSocketExtension> requestedExtensions,
                         List<WebSocketExtension> supportedExtensions)
Filter the list of requested WebSocket extensions. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
List<WebSocketExtension> | 
WebSocketClientSockJsSession.getExtensions()  | 
List<WebSocketExtension> | 
XhrClientSockJsSession.getExtensions()  | 
| Modifier and Type | Method and Description | 
|---|---|
List<WebSocketExtension> | 
WebSocketServerSockJsSession.getExtensions()  | 
List<WebSocketExtension> | 
AbstractHttpSockJsSession.getExtensions()  |