WebSocketSession (Spring Framework 5.1.0.RELEASE API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

NativeWebSocketSession, SockJsSession

All Known Implementing Classes:

AbstractClientSockJsSession, AbstractHttpSockJsSession, AbstractSockJsSession, AbstractWebSocketSession, ConcurrentWebSocketSessionDecorator, JettyWebSocketSession, PollingSockJsSession, StandardWebSocketSession, StreamingSockJsSession, WebSocketClientSockJsSession, WebSocketServerSockJsSession, WebSocketSessionDecorator, XhrClientSockJsSession
```
public interface WebSocketSession
extends java.io.Closeable
```
A WebSocket session abstraction. Allows sending messages over a WebSocket connection and closing it.

Since:

4.0

Author:

Rossen Stoyanchev

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Close the WebSocket connection with status 1000, i.e.
`void`	`close(CloseStatus status)` Close the WebSocket connection with the given close status.
`java.lang.String`	`getAcceptedProtocol()` Return the negotiated sub-protocol.
`java.util.Map<java.lang.String,java.lang.Object>`	`getAttributes()` Return the map with attributes associated with the WebSocket session.
`int`	`getBinaryMessageSizeLimit()` Get the configured maximum size for an incoming binary message.
`java.util.List<WebSocketExtension>`	`getExtensions()` Determine the negotiated extensions.
`HttpHeaders`	`getHandshakeHeaders()` Return the headers used in the handshake request (never `null`).
`java.lang.String`	`getId()` Return a unique session identifier.
`java.net.InetSocketAddress`	`getLocalAddress()` Return the address on which the request was received.
`java.security.Principal`	`getPrincipal()` Return a `Principal` instance containing the name of the authenticated user.
`java.net.InetSocketAddress`	`getRemoteAddress()` Return the address of the remote client.
`int`	`getTextMessageSizeLimit()` Get the configured maximum size for an incoming text message.
`java.net.URI`	`getUri()` Return the URI used to open the WebSocket connection.
`boolean`	`isOpen()` Return whether the connection is still open.
`void`	`sendMessage(WebSocketMessage<?> message)` Send a WebSocket message: either `TextMessage` or `BinaryMessage`.
`void`	`setBinaryMessageSizeLimit(int messageSizeLimit)` Configure the maximum size for an incoming binary message.
`void`	`setTextMessageSizeLimit(int messageSizeLimit)` Configure the maximum size for an incoming text message.

- Method Detail
  - getId
```
java.lang.String getId()
```
    Return a unique session identifier.
  - getUri
```
@Nullable
java.net.URI getUri()
```
    Return the URI used to open the WebSocket connection.
  - getHandshakeHeaders
```
HttpHeaders getHandshakeHeaders()
```
    Return the headers used in the handshake request (never null).
  - getAttributes
```
java.util.Map<java.lang.String,java.lang.Object> getAttributes()
```
    Return the map with attributes associated with the WebSocket session.
    On the server side the map can be populated initially through a HandshakeInterceptor. On the client side the map can be populated via WebSocketClient handshake methods.
    
    Returns:
    
    a Map with the session attributes (never null)
  - getPrincipal
```
@Nullable
java.security.Principal getPrincipal()
```
    Return a Principal instance containing the name of the authenticated user.
    If the user has not been authenticated, the method returns null.
  - getLocalAddress
```
@Nullable
java.net.InetSocketAddress getLocalAddress()
```
    Return the address on which the request was received.
  - getRemoteAddress
```
@Nullable
java.net.InetSocketAddress getRemoteAddress()
```
    Return the address of the remote client.
  - getAcceptedProtocol
```
@Nullable
java.lang.String getAcceptedProtocol()
```
    Return the negotiated sub-protocol.
    
    Returns:
    
    the protocol identifier, or null if no protocol was specified or negotiated successfully
  - setTextMessageSizeLimit
```
void setTextMessageSizeLimit(int messageSizeLimit)
```
    Configure the maximum size for an incoming text message.
  - getTextMessageSizeLimit
```
int getTextMessageSizeLimit()
```
    Get the configured maximum size for an incoming text message.
  - setBinaryMessageSizeLimit
```
void setBinaryMessageSizeLimit(int messageSizeLimit)
```
    Configure the maximum size for an incoming binary message.
  - getBinaryMessageSizeLimit
```
int getBinaryMessageSizeLimit()
```
    Get the configured maximum size for an incoming binary message.
  - getExtensions
```
java.util.List<WebSocketExtension> getExtensions()
```
    Determine the negotiated extensions.
    
    Returns:
    
    the list of extensions, or an empty list if no extension was specified or negotiated successfully
  - sendMessage
```
void sendMessage(WebSocketMessage<?> message)
          throws java.io.IOException
```
    Send a WebSocket message: either TextMessage or BinaryMessage.
    
    Throws:
    
    java.io.IOException
  - isOpen
```
boolean isOpen()
```
    Return whether the connection is still open.
  - close
```
void close()
    throws java.io.IOException
```
    Close the WebSocket connection with status 1000, i.e. equivalent to:
```
 session.close(CloseStatus.NORMAL);
 
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Throws:
    
    java.io.IOException
  - close
```
void close(CloseStatus status)
    throws java.io.IOException
```
    Close the WebSocket connection with the given close status.
    
    Throws:
    
    java.io.IOException

Interface WebSocketSession

Method Summary

Method Detail

getId

getUri

getHandshakeHeaders

getAttributes

getPrincipal

getLocalAddress

getRemoteAddress

getAcceptedProtocol

setTextMessageSizeLimit

getTextMessageSizeLimit

setBinaryMessageSizeLimit

getBinaryMessageSizeLimit

getExtensions

sendMessage

isOpen

close

close