Class webSocketServerSockJsSession

java.lang.Object

org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

org.springframework.web.socket.sockjs.transport.session.webSocketServerSockJsSession

All Implemented Interfaces:

Closeable, AutoCloseable, NativewebSocketSession, SockJsSession, webSocketSession

public class webSocketServerSockJsSession
extends AbstractSockJsSession
implements NativewebSocketSession

A SockJS session for use with the webSocket transport.

Since:

4.0

Author:

Rossen Stoyanchev, Juergen Hoeller

Field Summary

Fields inherited from class AbstractSockJsSession

DISCONNECTED_CLIENT_LOG_CATEGORY, logger, responseLock

Constructor Summary

Constructors

Constructor	Description
webSocketServerSockJsSession(String id, SockJsServiceConfig config, webSocketHandler handler, @Nullable Map<String,Object> attributes)

Method Summary

Modifier and Type	Method	Description
protected void	disconnect(CloseStatus status)	Actually close the underlying webSocket session or in the case of HTTP transports complete the underlying request.
@Nullable String	getAcceptedProtocol()	Return the negotiated sub-protocol.
int	getBinaryMessageSizeLimit()	Get the configured maximum size for an incoming binary message.
List<webSocketExtension>	getExtensions()	Determine the negotiated extensions.
HttpHeaders	getHandshakeHeaders()	Return the headers used in the handshake request (never null).
@Nullable InetSocketAddress	getLocalAddress()	Return the address on which the request was received.
Object	getNativeSession()	Return the underlying native webSocketSession.
<T> @Nullable T	getNativeSession(@Nullable Class<T> requiredType)	Return the underlying native webSocketSession, if available.
@Nullable Principal	getPrincipal()	Return a Principal instance containing the name of the authenticated user.
@Nullable InetSocketAddress	getRemoteAddress()	Return the address of the remote client.
int	getTextMessageSizeLimit()	Get the configured maximum size for an incoming text message.
@Nullable URI	getUri()	Return the URI used to open the webSocket connection.
void	handleMessage(TextMessage message, webSocketSession wsSession)
void	initializeDelegateSession(webSocketSession session)
boolean	isActive()	Polling and Streaming sessions periodically close the current HTTP request and wait for the next request to come through.
void	sendMessageInternal(String message)
void	setBinaryMessageSizeLimit(int messageSizeLimit)	Configure the maximum size for an incoming binary message.
void	setTextMessageSizeLimit(int messageSizeLimit)	Configure the maximum size for an incoming text message.
protected void	writeFrameInternal(SockJsFrame frame)

Methods inherited from class AbstractSockJsSession

cancelHeartbeat, close, close, delegateConnectionClosed, delegateConnectionEstablished, delegateError, delegateMessages, disableHeartbeat, getAttributes, getId, getMessageCodec, getSockJsServiceConfig, getTimeSinceLastActive, isClosed, isNew, isOpen, scheduleHeartbeat, sendHeartbeat, sendMessage, toString, tryCloseWithSockJsTransportError, updateLastActiveTime, writeFrame

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface webSocketSession

close, close, getAttributes, getId, isOpen, sendMessage

Constructor Details

webSocketServerSockJsSession

public webSocketServerSockJsSession(String id,
 SockJsServiceConfig config,
 webSocketHandler handler,
 @Nullable Map<String,Object> attributes)

Method Details

getUri

public @Nullable URI getUri()

Description copied from interface: webSocketSession

Return the URI used to open the webSocket connection.

Specified by:

getUri in interface webSocketSession

getHandshakeHeaders

public HttpHeaders getHandshakeHeaders()

Description copied from interface: webSocketSession

Return the headers used in the handshake request (never null).

Specified by:

getHandshakeHeaders in interface webSocketSession

getPrincipal

public @Nullable Principal getPrincipal()

Description copied from interface: webSocketSession

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

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

Specified by:

getPrincipal in interface webSocketSession

getLocalAddress

public @Nullable InetSocketAddress getLocalAddress()

Description copied from interface: webSocketSession

Return the address on which the request was received.

Note: The localAddress is not always possible to access, which is the case with the Standard webSocket client API, and accordingly StandardwebSocketClient returns null.

Specified by:

getLocalAddress in interface webSocketSession

getRemoteAddress

public @Nullable InetSocketAddress getRemoteAddress()

Description copied from interface: webSocketSession

Return the address of the remote client.

Specified by:

getRemoteAddress in interface webSocketSession

getAcceptedProtocol

public @Nullable String getAcceptedProtocol()

Description copied from interface: webSocketSession

Return the negotiated sub-protocol.

Specified by:

getAcceptedProtocol in interface webSocketSession

Returns:

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

setTextMessageSizeLimit

public void setTextMessageSizeLimit(int messageSizeLimit)

Description copied from interface: webSocketSession

Configure the maximum size for an incoming text message.

Specified by:

setTextMessageSizeLimit in interface webSocketSession

getTextMessageSizeLimit

public int getTextMessageSizeLimit()

Description copied from interface: webSocketSession

Get the configured maximum size for an incoming text message.

Specified by:

getTextMessageSizeLimit in interface webSocketSession

setBinaryMessageSizeLimit

public void setBinaryMessageSizeLimit(int messageSizeLimit)

Description copied from interface: webSocketSession

Configure the maximum size for an incoming binary message.

Specified by:

setBinaryMessageSizeLimit in interface webSocketSession

getBinaryMessageSizeLimit

public int getBinaryMessageSizeLimit()

Description copied from interface: webSocketSession

Get the configured maximum size for an incoming binary message.

Specified by:

getBinaryMessageSizeLimit in interface webSocketSession

getExtensions

public List<webSocketExtension> getExtensions()

Description copied from interface: webSocketSession

Determine the negotiated extensions.

Specified by:

getExtensions in interface webSocketSession

Returns:

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

getNativeSession

public Object getNativeSession()

Description copied from interface: NativewebSocketSession

Return the underlying native webSocketSession.

Specified by:

getNativeSession in interface NativewebSocketSession

getNativeSession

public <T> @Nullable T getNativeSession(@Nullable Class<T> requiredType)

Description copied from interface: NativewebSocketSession

Return the underlying native webSocketSession, if available.

Specified by:

getNativeSession in interface NativewebSocketSession

Parameters:

requiredType - the required type of the session

Returns:

the native session of the required type, or null if not available

initializeDelegateSession

public void initializeDelegateSession(webSocketSession session)

isActive

public boolean isActive()

Description copied from class: AbstractSockJsSession

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.

Specified by:

isActive in class AbstractSockJsSession

handleMessage

public void handleMessage(TextMessage message,
 webSocketSession wsSession)
                   throws Exception

Throws:

Exception

sendMessageInternal

public void sendMessageInternal(String message)
                         throws SockJsTransportFailureException

Specified by:

sendMessageInternal in class AbstractSockJsSession

Throws:

SockJsTransportFailureException

writeFrameInternal

protected void writeFrameInternal(SockJsFrame frame)
                           throws IOException

Specified by:

writeFrameInternal in class AbstractSockJsSession

Throws:

IOException

disconnect

protected void disconnect(CloseStatus status)
                   throws IOException

Description copied from class: AbstractSockJsSession

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

Specified by:

disconnect in class AbstractSockJsSession

Throws:

IOException