Spring Framework 6.1.4 · org.springframework.web.socket.WebSocketSession

Method Summary

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

Method Detail

close	back to summary
public void close() throws IOException Redeclares java.io.Closeable.close. Close the WebSocket connection with status 1000, i.e. equivalent to: session.close(CloseStatus.NORMAL); Annotations @Override Exceptions IOException: Doc from java.io.Closeable.close. if an I/O error occurs

back to summary

public void close() throws IOException

Redeclares java.io.Closeable.close.

Close the WebSocket connection with status 1000, i.e. equivalent to:

session.close(CloseStatus.NORMAL);

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

close	back to summary
public void close(CloseStatus status) throws IOException Close the WebSocket connection with the given close status.

getAcceptedProtocol back to summary

getAcceptedProtocol	back to summary
public String getAcceptedProtocol() Return the negotiated sub-protocol. Returns:String the protocol identifier, or `null` if no protocol was specified or negotiated successfully Annotations @Nullable

public String getAcceptedProtocol()

Return the negotiated sub-protocol.

Returns:String

the protocol identifier, or null if no protocol was specified or negotiated successfully

Annotations

@Nullable

getAttributes back to summary

getAttributes	back to summary
public Map<String, 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:Map<String, Object> a Map with the session attributes (never `null`)

public Map<String, 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:Map<String, Object>: a Map with the session attributes (never null)

getBinaryMessageSizeLimit	back to summary
public int getBinaryMessageSizeLimit() Get the configured maximum size for an incoming binary message.

getExtensions	back to summary
public List<WebSocketExtension> getExtensions() Determine the negotiated extensions. Returns:List<WebSocketExtension> the list of extensions, or an empty list if no extension was specified or negotiated successfully

getExtensions

back to summary

public List<WebSocketExtension> getExtensions()

Determine the negotiated extensions.

Returns:List<WebSocketExtension>: the list of extensions, or an empty list if no extension was specified or negotiated successfully

getHandshakeHeaders	back to summary
public HttpHeaders getHandshakeHeaders() Return the headers used in the handshake request (never `null`).

getId	back to summary
public String getId() Return a unique session identifier.

getLocalAddress	back to summary
public InetSocketAddress getLocalAddress() Return the address on which the request was received. Annotations @Nullable

getLocalAddress

back to summary

public InetSocketAddress getLocalAddress()

Return the address on which the request was received.

Annotations

@Nullable

getPrincipal back to summary

getPrincipal	back to summary
public Principal getPrincipal() Return a `java.security.Principal` instance containing the name of the authenticated user. If the user has not been authenticated, the method returns `null`. Annotations @Nullable

public Principal getPrincipal()

Return a java.security.Principal instance containing the name of the authenticated user.

If the user has not been authenticated, the method returns null.

Annotations

@Nullable

getRemoteAddress	back to summary
public InetSocketAddress getRemoteAddress() Return the address of the remote client. Annotations @Nullable

getRemoteAddress

back to summary

public InetSocketAddress getRemoteAddress()

Return the address of the remote client.

Annotations

@Nullable

getTextMessageSizeLimit	back to summary
public int getTextMessageSizeLimit() Get the configured maximum size for an incoming text message.

getUri	back to summary
public URI getUri() Return the URI used to open the WebSocket connection. Annotations @Nullable

getUri

back to summary

public URI getUri()

Return the URI used to open the WebSocket connection.

Annotations

@Nullable

isOpen	back to summary
public boolean isOpen() Whether the underlying connection is open.

sendMessage back to summary

sendMessage	back to summary
public void sendMessage(WebSocketMessage<?> message) throws IOException Send a WebSocket message: either `TextMessage` or `BinaryMessage`. Note The underlying standard WebSocket session (JSR-356) does not allow concurrent sending. Therefore, sending must be synchronized. To ensure that, one option is to wrap the `WebSocketSession` with the `ConcurrentWebSocketSessionDecorator`. See Also `org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator`

public void sendMessage(WebSocketMessage<?> message) throws IOException

Send a WebSocket message: either TextMessage or BinaryMessage.

Note

The underlying standard WebSocket session (JSR-356) does not allow concurrent sending. Therefore, sending must be synchronized. To ensure that, one option is to wrap the WebSocketSession with the ConcurrentWebSocketSessionDecorator.

See Also: org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

setBinaryMessageSizeLimit	back to summary
public void setBinaryMessageSizeLimit(int messageSizeLimit) Configure the maximum size for an incoming binary message.

setTextMessageSizeLimit	back to summary
public void setTextMessageSizeLimit(int messageSizeLimit) Configure the maximum size for an incoming text message.

public Interface WebSocketSession

Method Summary

Method Detail