org.springframework.web.socket.adapter.standard

Class StandardWebSocketSession

java.lang.Object

org.springframework.web.socket.adapter.AbstractWebSocketSession<javax.websocket.Session>

org.springframework.web.socket.adapter.standard.StandardWebSocketSession

All Implemented Interfaces:

NativeWebSocketSession, WebSocketSession

public class StandardWebSocketSession
extends AbstractWebSocketSession<javax.websocket.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 and Description
StandardWebSocketSession(HttpHeaders headers, Map<String,Object> handshakeAttributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress) Class constructor.
StandardWebSocketSession(HttpHeaders headers, Map<String,Object> handshakeAttributes, InetSocketAddress localAddress, InetSocketAddress remoteAddress, Principal user) Class constructor that associates a user with the WebSocket session.

Method Summary

Modifier and Type	Method and Description
protected void	closeInternal(CloseStatus 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.
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.
protected void	sendBinaryMessage(BinaryMessage message)
protected void	sendPingMessage(PingMessage message)
protected void	sendPongMessage(PongMessage message)
protected void	sendTextMessage(TextMessage message)

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

checkNativeSessionInitialized, close, close, getHandshakeAttributes, getNativeSession, getNativeSession, initializeNativeSession, 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> handshakeAttributes,
                                InetSocketAddress localAddress,
                                InetSocketAddress remoteAddress)

Class constructor.

Parameters:

headers - the headers of the handshake request

handshakeAttributes - attributes from the HTTP handshake to make available through the WebSocket session

localAddress - the address on which the request was received

remoteAddress - the address of the remote client

StandardWebSocketSession

public StandardWebSocketSession(HttpHeaders headers,
                                Map<String,Object> handshakeAttributes,
                                InetSocketAddress localAddress,
                                InetSocketAddress remoteAddress,
                                Principal user)

Class constructor that associates a user with the WebSocket session.

Parameters:

headers - the headers of the handshake request

handshakeAttributes - attributes from the HTTP handshake to make available through 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; can be left null in which case, we'll fallback on the user available via

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.

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.

getAcceptedProtocol

public String getAcceptedProtocol()

Description copied from interface: WebSocketSession

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

getExtensions

public List<WebSocketExtension> getExtensions()

Description copied from interface: WebSocketSession

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

isOpen

public boolean isOpen()

Description copied from interface: WebSocketSession

Return whether the connection is still open.

sendTextMessage

protected void sendTextMessage(TextMessage message)
                        throws IOException

Specified by:

sendTextMessage in class AbstractWebSocketSession<javax.websocket.Session>

Throws:

IOException

sendBinaryMessage

protected void sendBinaryMessage(BinaryMessage message)
                          throws IOException

Specified by:

sendBinaryMessage in class AbstractWebSocketSession<javax.websocket.Session>

Throws:

IOException

sendPingMessage

protected void sendPingMessage(PingMessage message)
                        throws IOException

Specified by:

sendPingMessage in class AbstractWebSocketSession<javax.websocket.Session>

Throws:

IOException

sendPongMessage

protected void sendPongMessage(PongMessage message)
                        throws IOException

Specified by:

sendPongMessage in class AbstractWebSocketSession<javax.websocket.Session>

Throws:

IOException

closeInternal

protected void closeInternal(CloseStatus status)
                      throws IOException

Specified by:

closeInternal in class AbstractWebSocketSession<javax.websocket.Session>

Throws:

IOException