Spring Framework 6.1.4 · org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

Modifier and Type	Field and Description
private volatile String	acceptedProtocol
private volatile ServerHttpAsyncRequestControl	asyncRequestControl
private volatile SockJsFrameFormat	frameFormat
private volatile HttpHeaders	handshakeHeaders
private volatile InetSocketAddress	localAddress
private final Queue<String>	messageCache
private volatile Principal	principal
private boolean	readyToSend
private volatile InetSocketAddress	remoteAddress
private volatile ServerHttpResponse	response
private volatile URI	uri

Access	Constructor and Description
public	AbstractHttpSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String, Object> attributes)

Method Summary

Modifier and Type	Method and Description
private void	disableShallowEtagHeaderFilter(ServerHttpRequest request)
protected void	disconnect(CloseStatus status) Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.disconnect. Actually close the underlying WebSocket session or in the case of HTTP transports complete the underlying request.
protected abstract void	flushCache() Called when the connection is active and ready to write to the response.
public String	getAcceptedProtocol() Implements org.springframework.web.socket.WebSocketSession.getAcceptedProtocol. Return the selected sub-protocol to use.
public int	getBinaryMessageSizeLimit() Implements org.springframework.web.socket.WebSocketSession.getBinaryMessageSizeLimit. Get the configured maximum size for an incoming binary message.
public List<WebSocketExtension>	getExtensions() Implements org.springframework.web.socket.WebSocketSession.getExtensions. Determine the negotiated extensions.
public HttpHeaders	getHandshakeHeaders() Implements org.springframework.web.socket.WebSocketSession.getHandshakeHeaders. Return the headers used in the handshake request (never `null`).
public InetSocketAddress	getLocalAddress() Implements org.springframework.web.socket.WebSocketSession.getLocalAddress. Return the address on which the request was received.
protected Queue<String>	getMessageCache() Return the SockJS buffer for messages stored transparently between polling requests.
public Principal	getPrincipal() Implements org.springframework.web.socket.WebSocketSession.getPrincipal. Return a `java.security.Principal` instance containing the name of the authenticated user.
public InetSocketAddress	getRemoteAddress() Implements org.springframework.web.socket.WebSocketSession.getRemoteAddress. Return the address of the remote client.
public int	getTextMessageSizeLimit() Implements org.springframework.web.socket.WebSocketSession.getTextMessageSizeLimit. Get the configured maximum size for an incoming text message.
public URI	getUri() Implements org.springframework.web.socket.WebSocketSession.getUri. Return the URI used to open the WebSocket connection.
public void	handleInitialRequest(ServerHttpRequest the current request request, ServerHttpResponse the current response response, SockJsFrameFormat the transport-specific SocksJS frame format to use frameFormat) Handle the first request for receiving messages on a SockJS HTTP transport based session.
protected abstract void	handleRequestInternal(ServerHttpRequest the current request request, ServerHttpResponse the current response response, boolean whether it is the first request for the session initialRequest) Invoked when a SockJS transport request is received.
public void	handleSuccessiveRequest(ServerHttpRequest the current request request, ServerHttpResponse the current response response, SockJsFrameFormat the transport-specific SocksJS frame format to use frameFormat) Handle all requests, except the first one, to receive messages on a SockJS HTTP transport based session.
public boolean	isActive() Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.isActive. Polling and Streaming sessions periodically close the current HTTP request and wait for the next request to come through.
protected void	resetRequest()
protected final void	sendMessageInternal(String message) Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.sendMessageInternal.
public void	setAcceptedProtocol(String the sub-protocol to set protocol) Unlike WebSocket where sub-protocol negotiation is part of the initial handshake, in HTTP transports the same negotiation must be emulated and the selected protocol set through this setter.
public void	setBinaryMessageSizeLimit(int messageSizeLimit) Implements org.springframework.web.socket.WebSocketSession.setBinaryMessageSizeLimit. Configure the maximum size for an incoming binary message.
public void	setTextMessageSizeLimit(int messageSizeLimit) Implements org.springframework.web.socket.WebSocketSession.setTextMessageSizeLimit. Configure the maximum size for an incoming text message.
protected void	writeFrameInternal(SockJsFrame frame) Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.writeFrameInternal.

acceptedProtocol	back to summary
private volatile String acceptedProtocol Annotations @Nullable

asyncRequestControl	back to summary
private volatile ServerHttpAsyncRequestControl asyncRequestControl Annotations @Nullable

frameFormat	back to summary
private volatile SockJsFrameFormat frameFormat Annotations @Nullable

handshakeHeaders	back to summary
private volatile HttpHeaders handshakeHeaders Annotations @Nullable

localAddress	back to summary
private volatile InetSocketAddress localAddress Annotations @Nullable

messageCache	back to summary
private final Queue<String> messageCache

principal	back to summary
private volatile Principal principal Annotations @Nullable

readyToSend	back to summary
private boolean readyToSend

remoteAddress	back to summary
private volatile InetSocketAddress remoteAddress Annotations @Nullable

response	back to summary
private volatile ServerHttpResponse response Annotations @Nullable

uri	back to summary
private volatile URI uri Annotations @Nullable

AbstractHttpSockJsSession	back to summary
public AbstractHttpSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String, Object> attributes)

Method Detail

disableShallowEtagHeaderFilter	back to summary
private void disableShallowEtagHeaderFilter(ServerHttpRequest request)

disconnect	back to summary
protected void disconnect(CloseStatus status) Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.disconnect. Doc from org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.disconnect. Actually close the underlying WebSocket session or in the case of HTTP transports complete the underlying request. Annotations @Override

disconnect

back to summary

protected void disconnect(CloseStatus status)

Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.disconnect.

Doc from org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.disconnect.

Actually close the underlying WebSocket session or in the case of HTTP transports complete the underlying request.

Annotations

@Override

flushCache	back to summary
protected abstract void flushCache() throws SockJsTransportFailureException Called when the connection is active and ready to write to the response. Subclasses should only call this method from a method where the "responseLock" is acquired.

getAcceptedProtocol back to summary

getAcceptedProtocol	back to summary
public String getAcceptedProtocol() Implements org.springframework.web.socket.WebSocketSession.getAcceptedProtocol. Return the selected sub-protocol to use. Returns:String Doc from org.springframework.web.socket.WebSocketSession.getAcceptedProtocol. the protocol identifier, or `null` if no protocol was specified or negotiated successfully Annotations @Override @Nullable

public String getAcceptedProtocol()

Implements org.springframework.web.socket.WebSocketSession.getAcceptedProtocol.

Return the selected sub-protocol to use.

Returns:String

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

the protocol identifier, or null if no protocol was specified or negotiated successfully

Annotations

@Override
@Nullable

getBinaryMessageSizeLimit	back to summary
public int getBinaryMessageSizeLimit() Implements org.springframework.web.socket.WebSocketSession.getBinaryMessageSizeLimit. Doc from org.springframework.web.socket.WebSocketSession.getBinaryMessageSizeLimit. Get the configured maximum size for an incoming binary message. Annotations @Override

getBinaryMessageSizeLimit

back to summary

public int getBinaryMessageSizeLimit()

Implements org.springframework.web.socket.WebSocketSession.getBinaryMessageSizeLimit.

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

Get the configured maximum size for an incoming binary message.

Annotations

@Override

getExtensions	back to summary
public List<WebSocketExtension> getExtensions() Implements org.springframework.web.socket.WebSocketSession.getExtensions. Doc from org.springframework.web.socket.WebSocketSession.getExtensions. Determine the negotiated extensions. Returns:List<WebSocketExtension> the list of extensions, or an empty list if no extension was specified or negotiated successfully Annotations @Override

getExtensions

back to summary

public List<WebSocketExtension> getExtensions()

Implements org.springframework.web.socket.WebSocketSession.getExtensions.

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

Determine the negotiated extensions.

Returns:List<WebSocketExtension>

the list of extensions, or an empty list if no extension was specified or negotiated successfully

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

getLocalAddress	back to summary
public InetSocketAddress getLocalAddress() Implements org.springframework.web.socket.WebSocketSession.getLocalAddress. Doc from org.springframework.web.socket.WebSocketSession.getLocalAddress. Return the address on which the request was received. Annotations @Override @Nullable

getLocalAddress

back to summary

public InetSocketAddress getLocalAddress()

Implements org.springframework.web.socket.WebSocketSession.getLocalAddress.

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

Return the address on which the request was received.

Annotations

@Override
@Nullable

getMessageCache back to summary

getMessageCache	back to summary
protected Queue<String> getMessageCache() Return the SockJS buffer for messages stored transparently between polling requests. If the polling request takes longer than 5 seconds, the session is closed. See Also `org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService`

protected Queue<String> getMessageCache()

Return the SockJS buffer for messages stored transparently between polling requests. If the polling request takes longer than 5 seconds, the session is closed.

See Also: org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

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 @Nullable

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
@Nullable

getRemoteAddress	back to summary
public InetSocketAddress getRemoteAddress() Implements org.springframework.web.socket.WebSocketSession.getRemoteAddress. Doc from org.springframework.web.socket.WebSocketSession.getRemoteAddress. Return the address of the remote client. Annotations @Override @Nullable

getRemoteAddress

back to summary

public InetSocketAddress getRemoteAddress()

Implements org.springframework.web.socket.WebSocketSession.getRemoteAddress.

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

Return the address of the remote client.

Annotations

@Override
@Nullable

getTextMessageSizeLimit	back to summary
public int getTextMessageSizeLimit() Implements org.springframework.web.socket.WebSocketSession.getTextMessageSizeLimit. Doc from org.springframework.web.socket.WebSocketSession.getTextMessageSizeLimit. Get the configured maximum size for an incoming text message. Annotations @Override

getTextMessageSizeLimit

back to summary

public int getTextMessageSizeLimit()

Implements org.springframework.web.socket.WebSocketSession.getTextMessageSizeLimit.

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

Get the configured maximum size for an incoming text message.

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

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

handleInitialRequest	back to summary
public void handleInitialRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat) throws SockJsException Handle the first request for receiving messages on a SockJS HTTP transport based session. Long polling-based transports (e.g. "xhr", "jsonp") complete the request after writing the open frame. Streaming-based transports ("xhr_streaming", "eventsource", and "htmlfile") leave the response open longer for further streaming of message frames but will also close it eventually after some amount of data has been sent. Parameters request:ServerHttpRequest the current request response:ServerHttpResponse the current response frameFormat:SockJsFrameFormat the transport-specific SocksJS frame format to use

handleInitialRequest

back to summary

public void handleInitialRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat) throws SockJsException

Handle the first request for receiving messages on a SockJS HTTP transport based session.

Long polling-based transports (e.g. "xhr", "jsonp") complete the request after writing the open frame. Streaming-based transports ("xhr_streaming", "eventsource", and "htmlfile") leave the response open longer for further streaming of message frames but will also close it eventually after some amount of data has been sent.

Parameters

request:ServerHttpRequest: the current request
response:ServerHttpResponse: the current response
frameFormat:SockJsFrameFormat: the transport-specific SocksJS frame format to use

handleRequestInternal	back to summary
protected abstract void handleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, boolean initialRequest) throws IOException Invoked when a SockJS transport request is received. Parameters request:ServerHttpRequest the current request response:ServerHttpResponse the current response initialRequest:boolean whether it is the first request for the session

handleRequestInternal

back to summary

protected abstract void handleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, boolean initialRequest) throws IOException

Invoked when a SockJS transport request is received.

Parameters

request:ServerHttpRequest: the current request
response:ServerHttpResponse: the current response
initialRequest:boolean: whether it is the first request for the session

handleSuccessiveRequest	back to summary
public void handleSuccessiveRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat) throws SockJsException Handle all requests, except the first one, to receive messages on a SockJS HTTP transport based session. Long polling-based transports (e.g. "xhr", "jsonp") complete the request after writing any buffered message frames (or the next one). Streaming-based transports ("xhr_streaming", "eventsource", and "htmlfile") leave the response open longer for further streaming of message frames but will also close it eventually after some amount of data has been sent. Parameters request:ServerHttpRequest the current request response:ServerHttpResponse the current response frameFormat:SockJsFrameFormat the transport-specific SocksJS frame format to use

handleSuccessiveRequest

back to summary

public void handleSuccessiveRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat) throws SockJsException

Handle all requests, except the first one, to receive messages on a SockJS HTTP transport based session.

Long polling-based transports (e.g. "xhr", "jsonp") complete the request after writing any buffered message frames (or the next one). Streaming-based transports ("xhr_streaming", "eventsource", and "htmlfile") leave the response open longer for further streaming of message frames but will also close it eventually after some amount of data has been sent.

Parameters

request:ServerHttpRequest: the current request
response:ServerHttpResponse: the current response
frameFormat:SockJsFrameFormat: the transport-specific SocksJS frame format to use

isActive	back to summary
public boolean isActive() Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.isActive. Doc from org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.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. Annotations @Override

isActive

back to summary

public boolean isActive()

Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.isActive.

Doc from org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.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.

Annotations

@Override

resetRequest	back to summary
protected void resetRequest()

sendMessageInternal	back to summary
protected final void sendMessageInternal(String message) throws SockJsTransportFailureException Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.sendMessageInternal. Annotations @Override

sendMessageInternal

back to summary

protected final void sendMessageInternal(String message) throws SockJsTransportFailureException

Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.sendMessageInternal.

Annotations

@Override

setAcceptedProtocol	back to summary
public void setAcceptedProtocol(String protocol) Unlike WebSocket where sub-protocol negotiation is part of the initial handshake, in HTTP transports the same negotiation must be emulated and the selected protocol set through this setter. Parameters protocol:String the sub-protocol to set

setAcceptedProtocol

back to summary

public void setAcceptedProtocol(String protocol)

Unlike WebSocket where sub-protocol negotiation is part of the initial handshake, in HTTP transports the same negotiation must be emulated and the selected protocol set through this setter.

Parameters

protocol:String: the sub-protocol to set

setBinaryMessageSizeLimit	back to summary
public void setBinaryMessageSizeLimit(int messageSizeLimit) Implements org.springframework.web.socket.WebSocketSession.setBinaryMessageSizeLimit. Doc from org.springframework.web.socket.WebSocketSession.setBinaryMessageSizeLimit. Configure the maximum size for an incoming binary message. Annotations @Override

setBinaryMessageSizeLimit

back to summary

public void setBinaryMessageSizeLimit(int messageSizeLimit)

Implements org.springframework.web.socket.WebSocketSession.setBinaryMessageSizeLimit.

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

Configure the maximum size for an incoming binary message.

Annotations

@Override

setTextMessageSizeLimit	back to summary
public void setTextMessageSizeLimit(int messageSizeLimit) Implements org.springframework.web.socket.WebSocketSession.setTextMessageSizeLimit. Doc from org.springframework.web.socket.WebSocketSession.setTextMessageSizeLimit. Configure the maximum size for an incoming text message. Annotations @Override

setTextMessageSizeLimit

back to summary

public void setTextMessageSizeLimit(int messageSizeLimit)

Implements org.springframework.web.socket.WebSocketSession.setTextMessageSizeLimit.

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

Configure the maximum size for an incoming text message.

Annotations

@Override

writeFrameInternal	back to summary
protected void writeFrameInternal(SockJsFrame frame) throws IOException Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.writeFrameInternal. Annotations @Override

writeFrameInternal

back to summary

protected void writeFrameInternal(SockJsFrame frame) throws IOException

Implements abstract org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession.writeFrameInternal.

Annotations

@Override

public abstract Class AbstractHttpSockJsSession

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail