public abstract class AbstractHttpSockJsSession extends AbstractSockJsSession
logger
Constructor and Description |
---|
AbstractHttpSockJsSession(String id,
SockJsServiceConfig config,
WebSocketHandler wsHandler,
Map<String,Object> handshakeAttributes) |
Modifier and Type | Method and Description |
---|---|
protected void |
afterRequestUpdated() |
protected void |
disconnect(CloseStatus status) |
protected abstract void |
flushCache()
Only called if the connection is currently active
|
String |
getAcceptedProtocol()
Return the selected sub-protocol to use.
|
List<WebSocketExtension> |
getExtensions()
Return the negotiated extensions or
null if none was specified or
negotiated successfully. |
HttpHeaders |
getHandshakeHeaders()
Return the headers used in the handshake request.
|
InetSocketAddress |
getLocalAddress()
Return the address on which the request was received.
|
protected BlockingQueue<String> |
getMessageCache() |
Principal |
getPrincipal()
Return a
Principal instance containing the name of the
authenticated user. |
InetSocketAddress |
getRemoteAddress()
Return the address of the remote client.
|
protected ServerHttpRequest |
getRequest() |
protected ServerHttpResponse |
getResponse() |
URI |
getUri()
Return the URI used to open the WebSocket connection.
|
void |
handleInitialRequest(ServerHttpRequest request,
ServerHttpResponse response,
SockJsFrameFormat frameFormat) |
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(String message) |
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.
|
void |
startLongPollingRequest(ServerHttpRequest request,
ServerHttpResponse response,
SockJsFrameFormat frameFormat) |
protected void |
writeFrameInternal(SockJsFrame frame) |
protected void |
writePrelude() |
cancelHeartbeat, close, close, delegateConnectionClosed, delegateConnectionEstablished, delegateError, delegateMessages, getHandshakeAttributes, getId, getSockJsServiceConfig, getTimeSinceLastActive, isClosed, isNew, isOpen, scheduleHeartbeat, sendHeartbeat, sendMessage, toString, tryCloseWithSockJsTransportError, updateLastActiveTime, writeFrame
public AbstractHttpSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String,Object> handshakeAttributes)
public URI getUri()
WebSocketSession
public HttpHeaders getHandshakeHeaders()
WebSocketSession
public Principal getPrincipal()
WebSocketSession
Principal
instance containing the name of the
authenticated user. If the user has not been authenticated, the method returns
null
.public InetSocketAddress getLocalAddress()
WebSocketSession
public InetSocketAddress getRemoteAddress()
WebSocketSession
public void setAcceptedProtocol(String protocol)
protocol
- the sub-protocol to setpublic String getAcceptedProtocol()
public List<WebSocketExtension> getExtensions()
WebSocketSession
null
if none was specified or
negotiated successfully.public void handleInitialRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat) throws SockJsException
SockJsException
protected void writePrelude() throws IOException
IOException
public void startLongPollingRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat) throws SockJsException
SockJsException
protected void afterRequestUpdated()
public boolean isActive()
AbstractSockJsSession
isActive
in class AbstractSockJsSession
protected BlockingQueue<String> getMessageCache()
protected ServerHttpRequest getRequest()
protected ServerHttpResponse getResponse()
protected final void sendMessageInternal(String message) throws SockJsTransportFailureException
sendMessageInternal
in class AbstractSockJsSession
SockJsTransportFailureException
protected abstract void flushCache() throws SockJsTransportFailureException
SockJsTransportFailureException
protected void disconnect(CloseStatus status)
disconnect
in class AbstractSockJsSession
protected void resetRequest()
protected void writeFrameInternal(SockJsFrame frame) throws IOException
writeFrameInternal
in class AbstractSockJsSession
IOException