Class webSocketSessionDecorator

java.lang.Object

org.springframework.web.socket.handler.webSocketSessionDecorator

All Implemented Interfaces:

Closeable, AutoCloseable, webSocketSession

Direct Known Subclasses:

ConcurrentwebSocketSessionDecorator

public class webSocketSessionDecorator
extends Object
implements webSocketSession

Wraps another webSocketSession instance and delegates to it.

Also provides a getDelegate() method to return the decorated session as well as a getLastSession() method to go through all nested delegates and return the "last" session.

Since:

4.0.3

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
webSocketSessionDecorator(webSocketSession session)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the webSocket connection with status 1000, i.e.
void	close(CloseStatus status)	Close the webSocket connection with the given close status.
@Nullable String	getAcceptedProtocol()	Return the negotiated sub-protocol.
Map<String,Object>	getAttributes()	Return the map with attributes associated with the webSocket session.
int	getBinaryMessageSizeLimit()	Get the configured maximum size for an incoming binary message.
webSocketSession	getDelegate()
List<webSocketExtension>	getExtensions()	Determine the negotiated extensions.
HttpHeaders	getHandshakeHeaders()	Return the headers used in the handshake request (never null).
String	getId()	Return a unique session identifier.
webSocketSession	getLastSession()
@Nullable InetSocketAddress	getLocalAddress()	Return the address on which the request was received.
@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.
boolean	isOpen()	Whether the underlying connection is open.
void	sendMessage(webSocketMessage<?> message)	Send a webSocket message: either TextMessage or BinaryMessage.
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.
String	toString()
static webSocketSession	unwrap(webSocketSession session)

Methods inherited from class Object

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

Constructor Details

webSocketSessionDecorator

public webSocketSessionDecorator(webSocketSession session)

Method Details

getDelegate

public webSocketSession getDelegate()

getLastSession

public webSocketSession getLastSession()

unwrap

public static webSocketSession unwrap(webSocketSession session)

getId

public String getId()

Description copied from interface: webSocketSession

Return a unique session identifier.

Specified by:

getId in interface webSocketSession

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

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: webSocketSession

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.

Specified by:

getAttributes in interface webSocketSession

Returns:

a Map with the session attributes (never null)

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

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

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

isOpen

public boolean isOpen()

Description copied from interface: webSocketSession

Whether the underlying connection is open.

Specified by:

isOpen in interface webSocketSession

sendMessage

public void sendMessage(webSocketMessage<?> message)
                 throws IOException

Description copied from interface: webSocketSession

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.

Specified by:

sendMessage in interface webSocketSession

Throws:

IOException

See Also:

• ConcurrentwebSocketSessionDecorator

close

public void close()
           throws IOException

Description copied from interface: webSocketSession

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

session.close(CloseStatus.NORMAL);

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface webSocketSession

Throws:

IOException

close

public void close(CloseStatus status)
           throws IOException

Description copied from interface: webSocketSession

Close the webSocket connection with the given close status.

Specified by:

close in interface webSocketSession

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object