java.lang.Object
- org.springframework.web.socket.adapter.AbstractWebSocketSession<Session>
- - org.springframework.web.socket.adapter.standard.StandardWebSocketSession

All Implemented Interfaces:
Closeable, AutoCloseable, NativeWebSocketSession, WebSocketSession
```
public class StandardWebSocketSession
extends AbstractWebSocketSession<Session>
```
A WebSocketSession for use with the standard WebSocket for Java API.
Since:
4.0
Author:
Rossen Stoyanchev

Field Summary
- Fields inherited from class org.springframework.web.socket.adapter.AbstractWebSocketSession
  logger

Constructor Summary

Constructors
Constructor	Description
`StandardWebSocketSession(HttpHeaders headers, Map<String,Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress)`	Constructor for a standard WebSocket session.
`StandardWebSocketSession(HttpHeaders headers, Map<String,Object> attributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress, Principal user)`	Constructor that associates a user with the WebSocket session.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`closeInternal(CloseStatus status)`
`String`	`getAcceptedProtocol()`	Return the negotiated sub-protocol.
`int`	`getBinaryMessageSizeLimit()`	Get the configured maximum size for an incoming binary message.
`List<WebSocketExtension>`	`getExtensions()`	Determine the negotiated extensions.
`HttpHeaders`	`getHandshakeHeaders()`	Return the headers used in the handshake request (never `null`).
`String`	`getId()`	Return a unique session identifier.
`InetSocketAddress`	`getLocalAddress()`	Return the address on which the request was received.
`Principal`	`getPrincipal()`	Return a `Principal` instance containing the name of the authenticated user.
`InetSocketAddress`	`getRemoteAddress()`	Return the address of the remote client.
`int`	`getTextMessageSizeLimit()`	Get the configured maximum size for an incoming text message.
`URI`	`getUri()`	Return the URI used to open the WebSocket connection.
`void`	`initializeNativeSession(Session session)`
`boolean`	`isOpen()`	Return whether the connection is still open.
`protected void`	`sendBinaryMessage(BinaryMessage message)`
`protected void`	`sendPingMessage(PingMessage message)`
`protected void`	`sendPongMessage(PongMessage message)`
`protected void`	`sendTextMessage(TextMessage message)`
`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.

Methods inherited from class org.springframework.web.socket.adapter.AbstractWebSocketSession
checkNativeSessionInitialized, close, close, getAttributes, getNativeSession, getNativeSession, sendMessage, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StandardWebSocketSession
```
public StandardWebSocketSession(HttpHeaders headers,
                                Map<String,Object> attributes,
                                InetSocketAddress localAddress,
                                InetSocketAddress remoteAddress)
```
    Constructor for a standard WebSocket session.
    Parameters:
    headers - the headers of the handshake request
    attributes - attributes from the HTTP handshake to associate with the WebSocket session; the provided attributes are copied, the original map is not used.
    localAddress - the address on which the request was received
    remoteAddress - the address of the remote client
  - StandardWebSocketSession
```
public StandardWebSocketSession(HttpHeaders headers,
                                Map<String,Object> attributes,
                                InetSocketAddress localAddress,
                                InetSocketAddress remoteAddress,
                                Principal user)
```
    Constructor that associates a user with the WebSocket session.
    Parameters:
    headers - the headers of the handshake request
    attributes - attributes from the HTTP handshake to associate with the WebSocket session
    localAddress - the address on which the request was received
    remoteAddress - the address of the remote client
    user - the user associated with the session; if null we'll fallback on the user available in the underlying WebSocket session
- Method Detail
  - getId
```
public String getId()
```
    Description copied from interface: WebSocketSession
    Return a unique session identifier.
  - getUri
```
public URI getUri()
```
    Description copied from interface: WebSocketSession
    Return the URI used to open the WebSocket connection.
  - getHandshakeHeaders
```
public HttpHeaders getHandshakeHeaders()
```
    Description copied from interface: WebSocketSession
    Return the headers used in the handshake request (never null).
  - getAcceptedProtocol
```
public String getAcceptedProtocol()
```
    Description copied from interface: WebSocketSession
    Return the negotiated sub-protocol.
    Returns:
    the protocol identifier, or null if no protocol was specified or negotiated successfully
  - getExtensions
```
public List<WebSocketExtension> getExtensions()
```
    Description copied from interface: WebSocketSession
    Determine the negotiated extensions.
    Returns:
    the list of extensions, or an empty list if no extension was specified or negotiated successfully
  - getPrincipal
```
public Principal getPrincipal()
```
    Description copied from interface: WebSocketSession
    Return a Principal instance containing the name of the authenticated user.
    If the user has not been authenticated, the method returns null.
  - getLocalAddress
```
public InetSocketAddress getLocalAddress()
```
    Description copied from interface: WebSocketSession
    Return the address on which the request was received.
  - getRemoteAddress
```
public InetSocketAddress getRemoteAddress()
```
    Description copied from interface: WebSocketSession
    Return the address of the remote client.
  - setTextMessageSizeLimit
```
public void setTextMessageSizeLimit(int messageSizeLimit)
```
    Description copied from interface: WebSocketSession
    Configure the maximum size for an incoming text message.
  - getTextMessageSizeLimit
```
public int getTextMessageSizeLimit()
```
    Description copied from interface: WebSocketSession
    Get the configured maximum size for an incoming text message.
  - setBinaryMessageSizeLimit
```
public void setBinaryMessageSizeLimit(int messageSizeLimit)
```
    Description copied from interface: WebSocketSession
    Configure the maximum size for an incoming binary message.
  - getBinaryMessageSizeLimit
```
public int getBinaryMessageSizeLimit()
```
    Description copied from interface: WebSocketSession
    Get the configured maximum size for an incoming binary message.
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: WebSocketSession
    Return whether the connection is still open.
  - initializeNativeSession
```
public void initializeNativeSession(Session session)
```
    Overrides:
    initializeNativeSession in class AbstractWebSocketSession<Session>
  - sendTextMessage
```
protected void sendTextMessage(TextMessage message)
                        throws IOException
```
    Specified by:
    sendTextMessage in class AbstractWebSocketSession<Session>
    Throws:
    IOException
  - sendBinaryMessage
```
protected void sendBinaryMessage(BinaryMessage message)
                          throws IOException
```
    Specified by:
    sendBinaryMessage in class AbstractWebSocketSession<Session>
    Throws:
    IOException
  - sendPingMessage
```
protected void sendPingMessage(PingMessage message)
                        throws IOException
```
    Specified by:
    sendPingMessage in class AbstractWebSocketSession<Session>
    Throws:
    IOException
  - sendPongMessage
```
protected void sendPongMessage(PongMessage message)
                        throws IOException
```
    Specified by:
    sendPongMessage in class AbstractWebSocketSession<Session>
    Throws:
    IOException
  - closeInternal
```
protected void closeInternal(CloseStatus status)
                      throws IOException
```
    Specified by:
    closeInternal in class AbstractWebSocketSession<Session>
    Throws:
    IOException

Class StandardWebSocketSession

Field Summary

Fields inherited from class org.springframework.web.socket.adapter.AbstractWebSocketSession

Constructor Summary

Method Summary

Methods inherited from class org.springframework.web.socket.adapter.AbstractWebSocketSession

Methods inherited from class java.lang.Object

Constructor Detail

StandardWebSocketSession

StandardWebSocketSession

Method Detail

getId

getUri

getHandshakeHeaders

getAcceptedProtocol

getExtensions

getPrincipal

getLocalAddress

getRemoteAddress

setTextMessageSizeLimit

getTextMessageSizeLimit

setBinaryMessageSizeLimit

getBinaryMessageSizeLimit

isOpen

initializeNativeSession

sendTextMessage

sendBinaryMessage

sendPingMessage

sendPongMessage

closeInternal