Class AbstractHttpSockJsSession
- All Implemented Interfaces:
Closeable,AutoCloseable,SockJsSession,WebSocketSession
- Direct Known Subclasses:
PollingSockJsSession,StreamingSockJsSession
- Since:
- 4.0
- Author:
- Rossen Stoyanchev
-
Field Summary
Fields inherited from class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
DISCONNECTED_CLIENT_LOG_CATEGORY, disconnectedClientLogger, logger, responseLock -
Constructor Summary
ConstructorsConstructorDescriptionAbstractHttpSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String, Object> attributes) -
Method Summary
Modifier and TypeMethodDescriptionprotected voiddisconnect(CloseStatus status) Actually close the underlying WebSocket session or in the case of HTTP transports complete the underlying request.protected abstract voidCalled when the connection is active and ready to write to the response.Return the selected sub-protocol to use.intGet the configured maximum size for an incoming binary message.Determine the negotiated extensions.Return the headers used in the handshake request (nevernull).Return the address on which the request was received.Return the SockJS buffer for messages stored transparently between polling requests.Return aPrincipalinstance containing the name of the authenticated user.Return the address of the remote client.intGet the configured maximum size for an incoming text message.getUri()Return the URI used to open the WebSocket connection.voidhandleInitialRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat) Handle the first request for receiving messages on a SockJS HTTP transport based session.protected abstract voidhandleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, boolean initialRequest) Invoked when a SockJS transport request is received.voidhandleSuccessiveRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat) Handle all requests, except the first one, to receive messages on a SockJS HTTP transport based session.booleanisActive()Polling and Streaming sessions periodically close the current HTTP request and wait for the next request to come through.protected voidprotected final voidsendMessageInternal(String message) voidsetAcceptedProtocol(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.voidsetBinaryMessageSizeLimit(int messageSizeLimit) Configure the maximum size for an incoming binary message.voidsetTextMessageSizeLimit(int messageSizeLimit) Configure the maximum size for an incoming text message.protected voidwriteFrameInternal(SockJsFrame frame) Methods inherited from class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
cancelHeartbeat, close, close, delegateConnectionClosed, delegateConnectionEstablished, delegateError, delegateMessages, disableHeartbeat, getAttributes, getId, getMessageCodec, getSockJsServiceConfig, getTimeSinceLastActive, isClosed, isNew, isOpen, scheduleHeartbeat, sendHeartbeat, sendMessage, toString, tryCloseWithSockJsTransportError, updateLastActiveTime, writeFrame
-
Constructor Details
-
AbstractHttpSockJsSession
public AbstractHttpSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String, Object> attributes)
-
-
Method Details
-
getUri
Description copied from interface:WebSocketSessionReturn the URI used to open the WebSocket connection. -
getHandshakeHeaders
Description copied from interface:WebSocketSessionReturn the headers used in the handshake request (nevernull). -
getPrincipal
Description copied from interface:WebSocketSessionReturn aPrincipalinstance containing the name of the authenticated user.If the user has not been authenticated, the method returns
null. -
getLocalAddress
Description copied from interface:WebSocketSessionReturn the address on which the request was received. -
getRemoteAddress
Description copied from interface:WebSocketSessionReturn the address of the remote client. -
setAcceptedProtocol
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- the sub-protocol to set
-
getAcceptedProtocol
Return the selected sub-protocol to use.- Returns:
- the protocol identifier, or
nullif no protocol was specified or negotiated successfully
-
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:
-
isActive
public boolean isActive()Description copied from class:AbstractSockJsSessionPolling 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:
isActivein classAbstractSockJsSession
-
setTextMessageSizeLimit
public void setTextMessageSizeLimit(int messageSizeLimit) Description copied from interface:WebSocketSessionConfigure the maximum size for an incoming text message. -
getTextMessageSizeLimit
public int getTextMessageSizeLimit()Description copied from interface:WebSocketSessionGet the configured maximum size for an incoming text message. -
setBinaryMessageSizeLimit
public void setBinaryMessageSizeLimit(int messageSizeLimit) Description copied from interface:WebSocketSessionConfigure the maximum size for an incoming binary message. -
getBinaryMessageSizeLimit
public int getBinaryMessageSizeLimit()Description copied from interface:WebSocketSessionGet the configured maximum size for an incoming binary message. -
getExtensions
Description copied from interface:WebSocketSessionDetermine the negotiated extensions.- Returns:
- the list of extensions, or an empty list if no extension was specified or negotiated successfully
-
handleInitialRequest
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- the current requestresponse- the current responseframeFormat- the transport-specific SocksJS frame format to use- Throws:
SockJsException
-
handleSuccessiveRequest
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- the current requestresponse- the current responseframeFormat- the transport-specific SocksJS frame format to use- Throws:
SockJsException
-
handleRequestInternal
protected abstract void handleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, boolean initialRequest) throws IOException Invoked when a SockJS transport request is received.- Parameters:
request- the current requestresponse- the current responseinitialRequest- whether it is the first request for the session- Throws:
IOException
-
sendMessageInternal
- Specified by:
sendMessageInternalin classAbstractSockJsSession- Throws:
SockJsTransportFailureException
-
flushCache
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.- Throws:
SockJsTransportFailureException
-
disconnect
Description copied from class:AbstractSockJsSessionActually close the underlying WebSocket session or in the case of HTTP transports complete the underlying request.- Specified by:
disconnectin classAbstractSockJsSession
-
resetRequest
protected void resetRequest() -
writeFrameInternal
- Specified by:
writeFrameInternalin classAbstractSockJsSession- Throws:
IOException
-