org.springframework.web.socket.sockjs.transport

Class WebSocketServerSockJsSession

java.lang.Object

org.springframework.web.socket.sockjs.AbstractSockJsSession

org.springframework.web.socket.sockjs.transport.WebSocketServerSockJsSession

All Implemented Interfaces:

ConfigurableWebSocketSession, WebSocketSession

public class WebSocketServerSockJsSession
extends AbstractSockJsSession

A SockJS session for use with the WebSocket transport.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private ObjectMapper	objectMapper
private WebSocketSession	webSocketSession

Fields inherited from class org.springframework.web.socket.sockjs.AbstractSockJsSession

logger

Constructor Summary

Constructors

Constructor and Description
WebSocketServerSockJsSession(java.lang.String sessionId, SockJsConfiguration config, WebSocketHandler handler)

Method Summary

Modifier and Type	Method and Description
protected void	disconnect(CloseStatus status)
void	handleMessage(TextMessage message, WebSocketSession wsSession)
void	initWebSocketSession(WebSocketSession session)
boolean	isActive() Polling and Streaming sessions periodically close the current HTTP request and wait for the next request to come through.
void	sendMessageInternal(java.lang.String message)
protected void	writeFrameInternal(SockJsFrame frame)

Methods inherited from class org.springframework.web.socket.sockjs.AbstractSockJsSession

cancelHeartbeat, close, close, delegateConnectionClosed, delegateConnectionEstablished, delegateError, delegateMessages, getId, getPrincipal, getRemoteAddress, getRemoteHostName, getSockJsConfig, getTimeSinceLastActive, getUri, isClosed, isNew, isOpen, isSecure, scheduleHeartbeat, sendHeartbeat, sendMessage, setPrincipal, setRemoteAddress, setRemoteHostName, setUri, toString, tryCloseWithSockJsTransportError, updateLastActiveTime, writeFrame

Methods inherited from class java.lang.Object

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

Field Detail

webSocketSession

private WebSocketSession webSocketSession

objectMapper

private final ObjectMapper objectMapper

Constructor Detail

WebSocketServerSockJsSession

public WebSocketServerSockJsSession(java.lang.String sessionId,
                            SockJsConfiguration config,
                            WebSocketHandler handler)

Method Detail

initWebSocketSession

public void initWebSocketSession(WebSocketSession session)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isActive

public boolean isActive()

Description copied from class: AbstractSockJsSession

Polling and Streaming sessions periodically close the current HTTP request and wait for the next request to come through. During this "downtime" the session is still open but inactive and unable to send messages and therefore has to buffer them temporarily. A WebSocket session by contrast is stateful and remain active until closed.

Specified by:

isActive in class AbstractSockJsSession

handleMessage

public void handleMessage(TextMessage message,
                 WebSocketSession wsSession)
                   throws java.lang.Exception

Throws:

java.lang.Exception

sendMessageInternal

public void sendMessageInternal(java.lang.String message)
                         throws java.io.IOException

Specified by:

sendMessageInternal in class AbstractSockJsSession

Throws:

java.io.IOException

writeFrameInternal

protected void writeFrameInternal(SockJsFrame frame)
                           throws java.io.IOException

Specified by:

writeFrameInternal in class AbstractSockJsSession

Throws:

java.io.IOException

disconnect

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

Specified by:

disconnect in class AbstractSockJsSession

Throws:

java.io.IOException