org.springframework.web.socket.sockjs.client

Class AbstractClientSockJsSession

java.lang.Object

org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, WebSocketSession

Direct Known Subclasses:

WebSocketClientSockJsSession, XhrClientSockJsSession

public abstract class AbstractClientSockJsSession
extends java.lang.Object
implements WebSocketSession

Base class for SockJS client implementations of WebSocketSession. Provides processing of incoming SockJS message frames and delegates lifecycle events and messages to the (application) WebSocketHandler. Sub-classes implement actual send as well as disconnect logic.

Since:

4.1

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AbstractClientSockJsSession.State

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Object>	attributes
private CloseStatus	closeStatus
private SettableListenableFuture<WebSocketSession>	connectFuture
protected Log	logger
private TransportRequest	request
private AbstractClientSockJsSession.State	state
private WebSocketHandler	webSocketHandler

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture)

Method Summary

Modifier and Type	Method and Description
void	afterTransportClosed(CloseStatus closeStatus)
void	close() Close the WebSocket connection with status 1000, i.e.
void	close(CloseStatus status) Close the WebSocket connection with the given close status.
protected void	closeInternal(CloseStatus status)
protected abstract void	disconnect(CloseStatus status)
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Return the map with attributes associated with the WebSocket session.
HttpHeaders	getHandshakeHeaders() Return the headers used in the handshake request.
java.lang.String	getId() Return a unique session identifier.
SockJsMessageCodec	getMessageCodec()
java.security.Principal	getPrincipal() Return a Principal instance containing the name of the authenticated user.
(package private) java.lang.Runnable	getTimeoutTask() Return a timeout cleanup task to invoke if the SockJS sessions is not fully established within the retransmission timeout period calculated in SockJsRequest based on the duration of the initial SockJS "Info" request.
java.net.URI	getUri() Return the URI used to open the WebSocket connection.
WebSocketHandler	getWebSocketHandler()
private void	handleCloseFrame(SockJsFrame frame)
void	handleFrame(java.lang.String payload)
private void	handleMessageFrame(SockJsFrame frame)
private void	handleOpenFrame()
void	handleTransportError(java.lang.Throwable error)
boolean	isDisconnected()
boolean	isOpen() Return whether the connection is still open.
private boolean	isUserSetStatus(CloseStatus status)
protected abstract void	sendInternal(TextMessage textMessage)
void	sendMessage(WebSocketMessage<?> message) Send a WebSocket message: either TextMessage or BinaryMessage.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.web.socket.WebSocketSession

getAcceptedProtocol, getBinaryMessageSizeLimit, getExtensions, getLocalAddress, getRemoteAddress, getTextMessageSizeLimit, setBinaryMessageSizeLimit, setTextMessageSizeLimit

Field Detail

logger

protected final Log logger

request

private final TransportRequest request

webSocketHandler

private final WebSocketHandler webSocketHandler

connectFuture

private final SettableListenableFuture<WebSocketSession> connectFuture

attributes

private final java.util.Map<java.lang.String,java.lang.Object> attributes

state

private volatile AbstractClientSockJsSession.State state

closeStatus

private volatile CloseStatus closeStatus

Constructor Detail

AbstractClientSockJsSession

protected AbstractClientSockJsSession(TransportRequest request,
                                      WebSocketHandler handler,
                                      SettableListenableFuture<WebSocketSession> connectFuture)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: WebSocketSession

Return a unique session identifier.

Specified by:

getId in interface WebSocketSession

getUri

public java.net.URI getUri()

Description copied from interface: WebSocketSession

Return the URI used to open the WebSocket connection.

Specified by:

getUri in interface WebSocketSession

getHandshakeHeaders

public HttpHeaders getHandshakeHeaders()

Description copied from interface: WebSocketSession

Return the headers used in the handshake request.

Specified by:

getHandshakeHeaders in interface WebSocketSession

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Description copied from interface: WebSocketSession

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.

Specified by:

getAttributes in interface WebSocketSession

Returns:

a Map with the session attributes, never null.

getPrincipal

public java.security.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.

Specified by:

getPrincipal in interface WebSocketSession

getMessageCodec

public SockJsMessageCodec getMessageCodec()

getWebSocketHandler

public WebSocketHandler getWebSocketHandler()

getTimeoutTask

java.lang.Runnable getTimeoutTask()

Return a timeout cleanup task to invoke if the SockJS sessions is not fully established within the retransmission timeout period calculated in SockJsRequest based on the duration of the initial SockJS "Info" request.

isOpen

public boolean isOpen()

Description copied from interface: WebSocketSession

Return whether the connection is still open.

Specified by:

isOpen in interface WebSocketSession

isDisconnected

public boolean isDisconnected()

sendMessage

public final void sendMessage(WebSocketMessage<?> message)
                       throws java.io.IOException

Description copied from interface: WebSocketSession

Send a WebSocket message: either TextMessage or BinaryMessage.

Specified by:

sendMessage in interface WebSocketSession

Throws:

java.io.IOException

sendInternal

protected abstract void sendInternal(TextMessage textMessage)
                              throws java.io.IOException

Throws:

java.io.IOException

close

public final void close()
                 throws java.io.IOException

Description copied from interface: WebSocketSession

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

 session.close(CloseStatus.NORMAL);
 

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface WebSocketSession

Throws:

java.io.IOException

close

public final void close(CloseStatus status)

Description copied from interface: WebSocketSession

Close the WebSocket connection with the given close status.

Specified by:

close in interface WebSocketSession

isUserSetStatus

private boolean isUserSetStatus(CloseStatus status)

closeInternal

protected void closeInternal(CloseStatus status)

disconnect

protected abstract void disconnect(CloseStatus status)
                            throws java.io.IOException

Throws:

java.io.IOException

handleFrame

public void handleFrame(java.lang.String payload)

handleOpenFrame

private void handleOpenFrame()

handleMessageFrame

private void handleMessageFrame(SockJsFrame frame)

handleCloseFrame

private void handleCloseFrame(SockJsFrame frame)

handleTransportError

public void handleTransportError(java.lang.Throwable error)

afterTransportClosed

public void afterTransportClosed(CloseStatus closeStatus)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object