org.springframework.web.socket.sockjs.transport

Class AbstractHttpSockJsSession

java.lang.Object

org.springframework.web.socket.sockjs.AbstractSockJsSession

org.springframework.web.socket.sockjs.transport.AbstractHttpSockJsSession

All Implemented Interfaces:

ConfigurableWebSocketSession, WebSocketSession

Direct Known Subclasses:

PollingSockJsSession, StreamingSockJsSession

public abstract class AbstractHttpSockJsSession
extends AbstractSockJsSession

An abstract base class for use with HTTP transport based SockJS sessions.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private AsyncServerHttpRequest	asyncRequest
private SockJsFrame.FrameFormat	frameFormat
private java.util.concurrent.BlockingQueue<java.lang.String>	messageCache
private ServerHttpResponse	response

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

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	disconnect(CloseStatus status)
protected abstract void	flushCache() Only called if the connection is currently active
protected java.util.concurrent.BlockingQueue<java.lang.String>	getMessageCache()
protected ServerHttpRequest	getRequest()
protected ServerHttpResponse	getResponse()
boolean	isActive() Polling and Streaming sessions periodically close the current HTTP request and wait for the next request to come through.
protected void	resetRequest()
protected void	sendMessageInternal(java.lang.String message)
void	setInitialRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrame.FrameFormat frameFormat)
void	setLongPollingRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrame.FrameFormat frameFormat)
private void	tryFlushCache()
private void	udpateRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrame.FrameFormat frameFormat)
protected void	writeFrameInternal(SockJsFrame frame)
protected void	writePrelude()

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

frameFormat

private SockJsFrame.FrameFormat frameFormat

messageCache

private final java.util.concurrent.BlockingQueue<java.lang.String> messageCache

asyncRequest

private AsyncServerHttpRequest asyncRequest

response

private ServerHttpResponse response

Constructor Detail

AbstractHttpSockJsSession

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

Method Detail

setInitialRequest

public void setInitialRequest(ServerHttpRequest request,
                     ServerHttpResponse response,
                     SockJsFrame.FrameFormat frameFormat)
                       throws TransportErrorException

Throws:

TransportErrorException

writePrelude

protected void writePrelude()
                     throws java.io.IOException

Throws:

java.io.IOException

setLongPollingRequest

public void setLongPollingRequest(ServerHttpRequest request,
                         ServerHttpResponse response,
                         SockJsFrame.FrameFormat frameFormat)
                           throws TransportErrorException

Throws:

TransportErrorException

udpateRequest

private void udpateRequest(ServerHttpRequest request,
                 ServerHttpResponse response,
                 SockJsFrame.FrameFormat frameFormat)

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

getMessageCache

protected java.util.concurrent.BlockingQueue<java.lang.String> getMessageCache()

getRequest

protected ServerHttpRequest getRequest()

getResponse

protected ServerHttpResponse getResponse()

sendMessageInternal

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

Specified by:

sendMessageInternal in class AbstractSockJsSession

Throws:

java.io.IOException

tryFlushCache

private void tryFlushCache()
                    throws java.io.IOException

Throws:

java.io.IOException

flushCache

protected abstract void flushCache()
                            throws java.io.IOException

Only called if the connection is currently active

Throws:

java.io.IOException

disconnect

protected void disconnect(CloseStatus status)

Specified by:

disconnect in class AbstractSockJsSession

resetRequest

protected void resetRequest()

writeFrameInternal

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

Specified by:

writeFrameInternal in class AbstractSockJsSession

Throws:

java.io.IOException