org.springframework.web.socket

Interface WebSocketSession

All Known Subinterfaces:

NativeWebSocketSession, SockJsSession

All Known Implementing Classes:

AbstractHttpSockJsSession, AbstractSockJsSession, AbstractWebSocketSession, JettyWebSocketSession, PollingSockJsSession, StandardWebSocketSession, StreamingSockJsSession, WebSocketServerSockJsSession

public interface WebSocketSession

A WebSocket session abstraction. Allows sending messages over a WebSocket connection and closing it.

Since:

4.0

Author:

Rossen Stoyanchev

Method Summary

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.
String	getAcceptedProtocol() Return the negotiated sub-protocol or null if none was specified or negotiated successfully.
List<WebSocketExtension>	getExtensions() Return the negotiated extensions or null if none was specified or negotiated successfully.
Map<String,Object>	getHandshakeAttributes() Handshake request specific attributes.
HttpHeaders	getHandshakeHeaders() Return the headers used in the handshake request.
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.
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.

Method Detail

getId

String getId()

Return a unique session identifier.

getUri

URI getUri()

Return the URI used to open the WebSocket connection.

getHandshakeHeaders

HttpHeaders getHandshakeHeaders()

Return the headers used in the handshake request.

getHandshakeAttributes

Map<String,Object> getHandshakeAttributes()

Handshake request specific attributes. To add attributes to a server-side WebSocket session see HandshakeInterceptor.

getPrincipal

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

InetSocketAddress getLocalAddress()

Return the address on which the request was received.

getRemoteAddress

InetSocketAddress getRemoteAddress()

Return the address of the remote client.

getAcceptedProtocol

String getAcceptedProtocol()

Return the negotiated sub-protocol or null if none was specified or negotiated successfully.

getExtensions

List<WebSocketExtension> getExtensions()

Return the negotiated extensions or null if none was specified or negotiated successfully.

isOpen

boolean isOpen()

Return whether the connection is still open.

sendMessage

void sendMessage(WebSocketMessage<?> message)
          throws IOException

Send a WebSocket message either TextMessage or BinaryMessage.

Throws:

IOException

close

void close()
    throws IOException

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

 session.close(CloseStatus.NORMAL);
 

Throws:

IOException

close

void close(CloseStatus status)
    throws IOException

Close the WebSocket connection with the given close status.

Throws:

IOException