Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	AbstractSockJsSession.HeartbeatTask
private static enum	AbstractSockJsSession.State

Field Summary

Modifier and Type	Field and Description
private final Map<String, Object>	attributes
private final SockJsServiceConfig	config
public static final String	DISCONNECTED_CLIENT_LOG_CATEGORY Log category to use for network failure after a client has gone away.
private static final DisconnectedClientHelper	disconnectedClientHelper
private final WebSocketHandler	handler
private volatile boolean	heartbeatDisabled
private ScheduledFuture<?>	heartbeatFuture
private AbstractSockJsSession.HeartbeatTask	heartbeatTask
private final String	id
protected final Log	logger
protected final Object	responseLock
private volatile AbstractSockJsSession.State	state
private final long	timeCreated
private volatile long	timeLastActive

Constructor Summary

Access	Constructor and Description
public	AbstractSockJsSession(String the session ID id, SockJsServiceConfig the SockJS service configuration options config, WebSocketHandler the recipient of SockJS messages handler, Map<String, Object> the attributes from the HTTP handshake to associate with the WebSocket session; the provided attributes are copied, the original map is not used. attributes) Create a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	cancelHeartbeat()
public final void	close() Implements org.springframework.web.socket.WebSocketSession.close. Performs cleanup and notify the `WebSocketHandler`.
public final void	close(CloseStatus status) Implements org.springframework.web.socket.WebSocketSession.close. Performs cleanup and notify the `WebSocketHandler`.
public final void	delegateConnectionClosed(CloseStatus status) Invoked when the underlying connection is closed.
public void	delegateConnectionEstablished()
public void	delegateError(Throwable ex)
public void	delegateMessages(String... messages)
public void	disableHeartbeat() Implements org.springframework.web.socket.sockjs.transport.SockJsSession.disableHeartbeat. Disable the SockJS heartbeat, presumably because a higher-level protocol has heartbeats enabled for the session already.
protected abstract void	disconnect(CloseStatus status) Actually close the underlying WebSocket session or in the case of HTTP transports complete the underlying request.
public Map<String, Object>	getAttributes() Implements org.springframework.web.socket.WebSocketSession.getAttributes. Return the map with attributes associated with the WebSocket session.
public String	getId() Implements org.springframework.web.socket.WebSocketSession.getId. Return a unique session identifier.
protected SockJsMessageCodec	getMessageCodec()
public SockJsServiceConfig	getSockJsServiceConfig()
public long	getTimeSinceLastActive() Implements org.springframework.web.socket.sockjs.transport.SockJsSession.getTimeSinceLastActive. Return the time (in ms) since the session was last active, or otherwise if the session is new, then the time since the session was created.
private static List<String>	getUndelivered(String[] messages, int i)
public abstract boolean	isActive() Polling and Streaming sessions periodically close the current HTTP request and wait for the next request to come through.
public boolean	isClosed()
public boolean	isNew()
public boolean	isOpen() Implements org.springframework.web.socket.WebSocketSession.isOpen. Whether the underlying connection is open.
private void	logUndeliveredMessages(int index, String[] messages)
private void	logWriteFrameFailure(Throwable ex)
protected void	scheduleHeartbeat()
protected void	sendHeartbeat()
public final void	sendMessage(WebSocketMessage<?> message) Implements org.springframework.web.socket.WebSocketSession.sendMessage. Send a WebSocket message: either `TextMessage` or `BinaryMessage`.
protected abstract void	sendMessageInternal(String message)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	tryCloseWithSockJsTransportError(Throwable error, CloseStatus closeStatus) Close due to error arising from SockJS transport handling.
protected void	updateLastActiveTime() Should be invoked whenever the session becomes inactive.
protected void	writeFrame(SockJsFrame frame) For internal use within a TransportHandler and the (TransportHandler-specific) session class.
protected abstract void	writeFrameInternal(SockJsFrame frame)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

attributes	back to summary
private final Map<String, Object> attributes

config	back to summary
private final SockJsServiceConfig config

DISCONNECTED_CLIENT_LOG_CATEGORY back to summary

DISCONNECTED_CLIENT_LOG_CATEGORY	back to summary
public static final String DISCONNECTED_CLIENT_LOG_CATEGORY Log category to use for network failure after a client has gone away. See Also `DisconnectedClientHelper`

public static final String DISCONNECTED_CLIENT_LOG_CATEGORY

Log category to use for network failure after a client has gone away.

See Also: DisconnectedClientHelper

disconnectedClientHelper	back to summary
private static final DisconnectedClientHelper disconnectedClientHelper

handler	back to summary
private final WebSocketHandler handler

heartbeatDisabled	back to summary
private volatile boolean heartbeatDisabled

heartbeatFuture	back to summary
private ScheduledFuture<?> heartbeatFuture Annotations @Nullable

heartbeatTask	back to summary
private AbstractSockJsSession.HeartbeatTask heartbeatTask Annotations @Nullable

id	back to summary
private final String id

logger	back to summary
protected final Log logger

responseLock	back to summary
protected final Object responseLock

state	back to summary
private volatile AbstractSockJsSession.State state

timeCreated	back to summary
private final long timeCreated

timeLastActive	back to summary
private volatile long timeLastActive

Constructor Detail

AbstractSockJsSession	back to summary
public AbstractSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler handler, Map<String, Object> attributes) Create a new instance. Parameters id:String the session ID config:SockJsServiceConfig the SockJS service configuration options handler:WebSocketHandler the recipient of SockJS messages attributes:Map<String, Object> the attributes from the HTTP handshake to associate with the WebSocket session; the provided attributes are copied, the original map is not used.

AbstractSockJsSession

back to summary

public AbstractSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler handler, Map<String, Object> attributes)

Create a new instance.

Parameters

id:String: the session ID
config:SockJsServiceConfig: the SockJS service configuration options
handler:WebSocketHandler: the recipient of SockJS messages
attributes:Map<String, Object>: the attributes from the HTTP handshake to associate with the WebSocket session; the provided attributes are copied, the original map is not used.

Method Detail

cancelHeartbeat	back to summary
protected void cancelHeartbeat()

close back to summary

close	back to summary
public final void close() throws IOException Implements org.springframework.web.socket.WebSocketSession.close. Performs cleanup and notify the `WebSocketHandler`. Annotations @Override Exceptions IOException: Doc from java.io.Closeable.close. if an I/O error occurs

public final void close() throws IOException

Implements org.springframework.web.socket.WebSocketSession.close.

Performs cleanup and notify the WebSocketHandler.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

close back to summary

close	back to summary
public final void close(CloseStatus status) throws IOException Implements org.springframework.web.socket.WebSocketSession.close. Performs cleanup and notify the `WebSocketHandler`. Annotations @Override

public final void close(CloseStatus status) throws IOException

Implements org.springframework.web.socket.WebSocketSession.close.

Performs cleanup and notify the WebSocketHandler.

Annotations

@Override

delegateConnectionClosed	back to summary
public final void delegateConnectionClosed(CloseStatus status) throws Exception Invoked when the underlying connection is closed.

delegateConnectionEstablished	back to summary
public void delegateConnectionEstablished() throws Exception

delegateError	back to summary
public void delegateError(Throwable ex) throws Exception

delegateMessages	back to summary
public void delegateMessages(String... messages) throws SockJsMessageDeliveryException

disableHeartbeat	back to summary
public void disableHeartbeat() Implements org.springframework.web.socket.sockjs.transport.SockJsSession.disableHeartbeat. Doc from org.springframework.web.socket.sockjs.transport.SockJsSession.disableHeartbeat. Disable the SockJS heartbeat, presumably because a higher-level protocol has heartbeats enabled for the session already. It is not recommended to disable this otherwise, as it helps proxies to know the connection is not hanging. Annotations @Override

disableHeartbeat

back to summary

public void disableHeartbeat()

Implements org.springframework.web.socket.sockjs.transport.SockJsSession.disableHeartbeat.

Doc from org.springframework.web.socket.sockjs.transport.SockJsSession.disableHeartbeat.

Disable the SockJS heartbeat, presumably because a higher-level protocol has heartbeats enabled for the session already. It is not recommended to disable this otherwise, as it helps proxies to know the connection is not hanging.

Annotations

@Override

disconnect	back to summary
protected abstract void disconnect(CloseStatus status) throws IOException Actually close the underlying WebSocket session or in the case of HTTP transports complete the underlying request.

getAttributes back to summary

getAttributes	back to summary
public Map<String, Object> getAttributes() Implements org.springframework.web.socket.WebSocketSession.getAttributes. Doc from org.springframework.web.socket.WebSocketSession.getAttributes. 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. Returns:Map<String, Object> a Map with the session attributes (never `null`) Annotations @Override

public Map<String, Object> getAttributes()

Implements org.springframework.web.socket.WebSocketSession.getAttributes.

Doc from org.springframework.web.socket.WebSocketSession.getAttributes.

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.

Returns:Map<String, Object>

a Map with the session attributes (never null)

Annotations

@Override

getId	back to summary
public String getId() Implements org.springframework.web.socket.WebSocketSession.getId. Doc from org.springframework.web.socket.WebSocketSession.getId. Return a unique session identifier. Annotations @Override

getId

back to summary

public String getId()

Implements org.springframework.web.socket.WebSocketSession.getId.

Doc from org.springframework.web.socket.WebSocketSession.getId.

Return a unique session identifier.

Annotations

@Override

getMessageCodec	back to summary
protected SockJsMessageCodec getMessageCodec()

getSockJsServiceConfig	back to summary
public SockJsServiceConfig getSockJsServiceConfig()

getTimeSinceLastActive	back to summary
public long getTimeSinceLastActive() Implements org.springframework.web.socket.sockjs.transport.SockJsSession.getTimeSinceLastActive. Doc from org.springframework.web.socket.sockjs.transport.SockJsSession.getTimeSinceLastActive. Return the time (in ms) since the session was last active, or otherwise if the session is new, then the time since the session was created. Annotations @Override

getTimeSinceLastActive

back to summary

public long getTimeSinceLastActive()

Implements org.springframework.web.socket.sockjs.transport.SockJsSession.getTimeSinceLastActive.

Doc from org.springframework.web.socket.sockjs.transport.SockJsSession.getTimeSinceLastActive.

Return the time (in ms) since the session was last active, or otherwise if the session is new, then the time since the session was created.

Annotations

@Override

getUndelivered	back to summary
private static List<String> getUndelivered(String[] messages, int i)

isActive	back to summary
public abstract boolean isActive() 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.

isClosed	back to summary
public boolean isClosed()

isNew	back to summary
public boolean isNew()

isOpen	back to summary
public boolean isOpen() Implements org.springframework.web.socket.WebSocketSession.isOpen. Doc from org.springframework.web.socket.WebSocketSession.isOpen. Whether the underlying connection is open. Annotations @Override

isOpen

back to summary

public boolean isOpen()

Implements org.springframework.web.socket.WebSocketSession.isOpen.

Doc from org.springframework.web.socket.WebSocketSession.isOpen.

Whether the underlying connection is open.

Annotations

@Override

logUndeliveredMessages	back to summary
private void logUndeliveredMessages(int index, String[] messages)

logWriteFrameFailure	back to summary
private void logWriteFrameFailure(Throwable ex)

scheduleHeartbeat	back to summary
protected void scheduleHeartbeat()

sendHeartbeat	back to summary
protected void sendHeartbeat() throws SockJsTransportFailureException

sendMessage back to summary

sendMessage	back to summary
public final void sendMessage(WebSocketMessage<?> message) throws IOException Implements org.springframework.web.socket.WebSocketSession.sendMessage. Doc from org.springframework.web.socket.WebSocketSession.sendMessage. Send a WebSocket message: either `TextMessage` or `BinaryMessage`. Note The underlying standard WebSocket session (JSR-356) does not allow concurrent sending. Therefore, sending must be synchronized. To ensure that, one option is to wrap the `WebSocketSession` with the `ConcurrentWebSocketSessionDecorator`. Annotations @Override

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

Implements org.springframework.web.socket.WebSocketSession.sendMessage.

Doc from org.springframework.web.socket.WebSocketSession.sendMessage.

Send a WebSocket message: either TextMessage or BinaryMessage.

Note

The underlying standard WebSocket session (JSR-356) does not allow concurrent sending. Therefore, sending must be synchronized. To ensure that, one option is to wrap the WebSocketSession with the ConcurrentWebSocketSessionDecorator.

Annotations

@Override

sendMessageInternal	back to summary
protected abstract void sendMessageInternal(String message) throws IOException

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

tryCloseWithSockJsTransportError	back to summary
public void tryCloseWithSockJsTransportError(Throwable error, CloseStatus closeStatus) Close due to error arising from SockJS transport handling.

updateLastActiveTime	back to summary
protected void updateLastActiveTime() Should be invoked whenever the session becomes inactive.

writeFrame	back to summary
protected void writeFrame(SockJsFrame frame) throws SockJsTransportFailureException For internal use within a TransportHandler and the (TransportHandler-specific) session class.

writeFrameInternal	back to summary
protected abstract void writeFrameInternal(SockJsFrame frame) throws IOException

org.springframework.web.socket.sockjs.transport.session back to summary

private Class AbstractSockJsSession.HeartbeatTask

Class Inheritance

extends Object
implements Runnable

java.lang.Object
org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.HeartbeatTask

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
private boolean	expired

Constructor Summary

Access	Constructor and Description
private	HeartbeatTask()

Method Summary

Modifier and Type	Method and Description
pack-priv void	cancel()
public void	run() Implements java.lang.Runnable.run. Runs this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

expired	back to summary
private boolean expired

Constructor Detail

HeartbeatTask	back to summary
private HeartbeatTask()

Method Detail

cancel	back to summary
pack-priv void cancel()

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

org.springframework.web.socket.sockjs.transport.session back to summary

private final Enum AbstractSockJsSession.State

Class Inheritance

extends Enum<AbstractSockJsSession.State>

java.lang.Object
java.lang.Enum
org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.State

Field Summary

Modifier and Type	Field and Description
public static final AbstractSockJsSession.State	CLOSED
public static final AbstractSockJsSession.State	NEW
public static final AbstractSockJsSession.State	OPEN

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static AbstractSockJsSession.State	valueOf(String name)
public static AbstractSockJsSession.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CLOSED	back to summary
public static final AbstractSockJsSession.State CLOSED

NEW	back to summary
public static final AbstractSockJsSession.State NEW

OPEN	back to summary
public static final AbstractSockJsSession.State OPEN

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static AbstractSockJsSession.State valueOf(String name)

values	back to summary
public static AbstractSockJsSession.State[] values()

public abstract Class AbstractSockJsSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AbstractSockJsSession.HeartbeatTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum AbstractSockJsSession.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail