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

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

Access	Constructor and Description
protected	AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture) Deprecated since 6.0. as of 6.0, in favor of `AbstractClientSockJsSession(TransportRequest, WebSocketHandler, CompletableFuture)` Create a new `AbstractClientSockJsSession`.
protected	AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, CompletableFuture<WebSocketSession> connectFuture)

Method Summary

Modifier and Type	Method and Description
public void	afterTransportClosed(CloseStatus closeStatus)
public final void	close() Implements org.springframework.web.socket.WebSocketSession.close. Close the WebSocket connection with status 1000, i.e. equivalent to: session.close(CloseStatus.NORMAL);
public final void	close(CloseStatus status) Implements org.springframework.web.socket.WebSocketSession.close. Close the WebSocket connection with the given close status.
protected void	closeInternal(CloseStatus status)
protected abstract void	disconnect(CloseStatus status)
public Map<String, Object>	getAttributes() Implements org.springframework.web.socket.WebSocketSession.getAttributes. Return the map with attributes associated with the WebSocket session.
public HttpHeaders	getHandshakeHeaders() Implements org.springframework.web.socket.WebSocketSession.getHandshakeHeaders. Return the headers used in the handshake request (never `null`).
public String	getId() Implements org.springframework.web.socket.WebSocketSession.getId. Return a unique session identifier.
public SockJsMessageCodec	getMessageCodec()
public Principal	getPrincipal() Implements org.springframework.web.socket.WebSocketSession.getPrincipal. Return a `java.security.Principal` instance containing the name of the authenticated user.
pack-priv 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.
public URI	getUri() Implements org.springframework.web.socket.WebSocketSession.getUri. Return the URI used to open the WebSocket connection.
public WebSocketHandler	getWebSocketHandler()
private void	handleCloseFrame(SockJsFrame frame)
public void	handleFrame(String payload)
private void	handleMessageFrame(SockJsFrame frame)
private void	handleOpenFrame()
public void	handleTransportError(Throwable error)
public boolean	isDisconnected()
public boolean	isOpen() Implements org.springframework.web.socket.WebSocketSession.isOpen. Whether the underlying connection is open.
private boolean	isUserSetStatus(CloseStatus status)
protected abstract void	sendInternal(TextMessage textMessage)
public final void	sendMessage(WebSocketMessage<?> message) Implements org.springframework.web.socket.WebSocketSession.sendMessage. Send a WebSocket message: either `TextMessage` or `BinaryMessage`.
private void	silentClose(CloseStatus status)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

closeStatus	back to summary
private volatile CloseStatus closeStatus Annotations @Nullable

connectFuture	back to summary
private final CompletableFuture<WebSocketSession> connectFuture

logger	back to summary
protected final Log logger

request	back to summary
private final TransportRequest request

state	back to summary
private volatile AbstractClientSockJsSession.State state Annotations @Nullable

webSocketHandler	back to summary
private final WebSocketHandler webSocketHandler

Constructor Detail

AbstractClientSockJsSession back to summary

AbstractClientSockJsSession	back to summary
protected AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture) Deprecated since 6.0. as of 6.0, in favor of `AbstractClientSockJsSession(TransportRequest, WebSocketHandler, CompletableFuture)` Create a new `AbstractClientSockJsSession`. Annotations @Deprecated since:6.0

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

Deprecated

since 6.0.

as of 6.0, in favor of AbstractClientSockJsSession(TransportRequest, WebSocketHandler, CompletableFuture)

Create a new AbstractClientSockJsSession.

Annotations

@Deprecated
since:6.0

AbstractClientSockJsSession	back to summary
protected AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, CompletableFuture<WebSocketSession> connectFuture)

Method Detail

afterTransportClosed	back to summary
public void afterTransportClosed(CloseStatus closeStatus)

close	back to summary
public final void close() throws IOException Implements org.springframework.web.socket.WebSocketSession.close. Doc from org.springframework.web.socket.WebSocketSession.close. Close the WebSocket connection with status 1000, i.e. equivalent to: session.close(CloseStatus.NORMAL); Annotations @Override Exceptions IOException: Doc from java.io.Closeable.close. if an I/O error occurs

back to summary

public final void close() throws IOException

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

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

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

session.close(CloseStatus.NORMAL);

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

close	back to summary
public final void close(CloseStatus status) throws IOException Implements org.springframework.web.socket.WebSocketSession.close. Doc from org.springframework.web.socket.WebSocketSession.close. Close the WebSocket connection with the given close status. Annotations @Override

back to summary

public final void close(CloseStatus status) throws IOException

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

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

Close the WebSocket connection with the given close status.

Annotations

@Override

closeInternal	back to summary
protected void closeInternal(CloseStatus status) throws IOException

disconnect	back to summary
protected abstract void disconnect(CloseStatus status) throws IOException

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

getHandshakeHeaders back to summary

getHandshakeHeaders	back to summary
public HttpHeaders getHandshakeHeaders() Implements org.springframework.web.socket.WebSocketSession.getHandshakeHeaders. Doc from org.springframework.web.socket.WebSocketSession.getHandshakeHeaders. Return the headers used in the handshake request (never `null`). Annotations @Override

public HttpHeaders getHandshakeHeaders()

Implements org.springframework.web.socket.WebSocketSession.getHandshakeHeaders.

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

Return the headers used in the handshake request (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
public SockJsMessageCodec getMessageCodec()

getPrincipal back to summary

getPrincipal	back to summary
public Principal getPrincipal() Implements org.springframework.web.socket.WebSocketSession.getPrincipal. Doc from org.springframework.web.socket.WebSocketSession.getPrincipal. Return a `java.security.Principal` instance containing the name of the authenticated user. If the user has not been authenticated, the method returns `null`. Annotations @Override

public Principal getPrincipal()

Implements org.springframework.web.socket.WebSocketSession.getPrincipal.

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

Return a java.security.Principal instance containing the name of the authenticated user.

If the user has not been authenticated, the method returns null.

Annotations

@Override

getTimeoutTask	back to summary
pack-priv 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.

getUri	back to summary
public URI getUri() Implements org.springframework.web.socket.WebSocketSession.getUri. Doc from org.springframework.web.socket.WebSocketSession.getUri. Return the URI used to open the WebSocket connection. Annotations @Override

getUri

back to summary

public URI getUri()

Implements org.springframework.web.socket.WebSocketSession.getUri.

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

Return the URI used to open the WebSocket connection.

Annotations

@Override

getWebSocketHandler	back to summary
public WebSocketHandler getWebSocketHandler()

handleCloseFrame	back to summary
private void handleCloseFrame(SockJsFrame frame)

handleFrame	back to summary
public void handleFrame(String payload)

handleMessageFrame	back to summary
private void handleMessageFrame(SockJsFrame frame)

handleOpenFrame	back to summary
private void handleOpenFrame()

handleTransportError	back to summary
public void handleTransportError(Throwable error)

isDisconnected	back to summary
public boolean isDisconnected()

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

isUserSetStatus	back to summary
private boolean isUserSetStatus(CloseStatus status)

sendInternal	back to summary
protected abstract void sendInternal(TextMessage textMessage) throws IOException

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

silentClose	back to summary
private void silentClose(CloseStatus status)

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

org.springframework.web.socket.sockjs.client back to summary

private final Enum AbstractClientSockJsSession.State

Class Inheritance

extends Enum<AbstractClientSockJsSession.State>

java.lang.Object
java.lang.Enum
org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession.State

Field Summary

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

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static AbstractClientSockJsSession.State	valueOf(String name)
public static AbstractClientSockJsSession.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 AbstractClientSockJsSession.State CLOSED

CLOSING	back to summary
public static final AbstractClientSockJsSession.State CLOSING

NEW	back to summary
public static final AbstractClientSockJsSession.State NEW

OPEN	back to summary
public static final AbstractClientSockJsSession.State OPEN

Constructor Detail

State	back to summary
private State()

Method Detail

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

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

public abstract Class AbstractClientSockJsSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum AbstractClientSockJsSession.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail