org.glassfish.tyrus.core.cluster

Class ClusterSession

java.lang.Object

org.glassfish.tyrus.core.cluster.ClusterSession

All Implemented Interfaces:

Closeable, AutoCloseable, Session

public class ClusterSession
extends Object
implements Session

Cluster session represents session present on another node.

Author:

Pavel Bucek (pavel.bucek at oracle.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterSession.DistributedMapKey

Constructor Summary

Constructors

Constructor and Description
ClusterSession(String sessionId, ClusterContext clusterContext, Map<ClusterSession.DistributedMapKey,Object> distributedPropertyMap, TyrusEndpointWrapper endpointWrapper, Session session) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMessageHandler(MessageHandler handler) Not supported (yet?).
void	close() Close the current conversation with a normal status code and no reason phrase.
void	close(CloseReason closeReason) Close the current conversation, giving a reason for the closure.
RemoteEndpoint.Async	getAsyncRemote() Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send messages asynchronously to the peer.
RemoteEndpoint.Basic	getBasicRemote() Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send messages synchronously to the peer.
WebSocketContainer	getContainer() Not supported (yet?).
String	getId() Returns a string containing the unique identifier assigned to this session.
int	getMaxBinaryMessageBufferSize() The maximum length of incoming binary messages that this Session can buffer.
long	getMaxIdleTimeout() Return the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e.
int	getMaxTextMessageBufferSize() The maximum length of incoming text messages that this Session can buffer.
Set<MessageHandler>	getMessageHandlers() Not supported (yet?).
List<Extension>	getNegotiatedExtensions() Return the list of extensions currently in use for this conversation.
String	getNegotiatedSubprotocol() Return the sub protocol agreed during the websocket handshake for this conversation.
Set<Session>	getOpenSessions() Not supported.
Map<String,String>	getPathParameters() Return a map of the path parameter names and values used associated with the request this session was opened under.
String	getProtocolVersion() Returns the version of the websocket protocol currently being used.
String	getQueryString() Return the query string associated with the request this session was opened under.
Map<String,List<String>>	getRequestParameterMap() Return the request parameters associated with the request this session was opened under.
URI	getRequestURI() Return the URI under which this session was opened, including the query string if there is one.
Principal	getUserPrincipal() Return the authenticated user for this Session or null if no user is authenticated for this session.
Map<String,Object>	getUserProperties() While the session is open, this method returns a Map that the developer may use to store application specific information relating to this session instance.
boolean	isOpen() Return true if and only if the underlying socket is open.
boolean	isSecure() Return true if and only if the underlying socket is using a secure transport.
void	removeMessageHandler(MessageHandler handler) Not supported (yet?).
void	setMaxBinaryMessageBufferSize(int length) Remote setters are not supported (yet?).
void	setMaxIdleTimeout(long milliseconds) Remote setters are not supported (yet?).
void	setMaxTextMessageBufferSize(int length) Remote setters are not supported (yet?).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterSession

public ClusterSession(String sessionId,
              ClusterContext clusterContext,
              Map<ClusterSession.DistributedMapKey,Object> distributedPropertyMap,
              TyrusEndpointWrapper endpointWrapper,
              Session session)

Constructor.

Parameters:

sessionId - session id.

clusterContext - cluster context.

endpointWrapper - used just to get encoders/decoders.

session - used just to get encoders/decoders.

Method Detail

getContainer

public WebSocketContainer getContainer()

Not supported (yet?).

Specified by:

getContainer in interface Session

Returns:

nothing.

addMessageHandler

public void addMessageHandler(MessageHandler handler)
                       throws IllegalStateException

Not supported (yet?).

Specified by:

addMessageHandler in interface Session

Parameters:

handler - nothing.

Throws:

IllegalStateException - newer.

getMessageHandlers

public Set<MessageHandler> getMessageHandlers()

Not supported (yet?).

Specified by:

getMessageHandlers in interface Session

Returns:

nothing.

removeMessageHandler

public void removeMessageHandler(MessageHandler handler)

Not supported (yet?).

Specified by:

removeMessageHandler in interface Session

Parameters:

handler - nothing.

getProtocolVersion

public String getProtocolVersion()

Description copied from interface: Session

Returns the version of the websocket protocol currently being used. This is taken as the value of the Sec-WebSocket-Version header used in the opening handshake. i.e. "13".

Specified by:

getProtocolVersion in interface Session

Returns:

the protocol version.

getNegotiatedSubprotocol

public String getNegotiatedSubprotocol()

Description copied from interface: Session

Return the sub protocol agreed during the websocket handshake for this conversation.

Specified by:

getNegotiatedSubprotocol in interface Session

Returns:

the negotiated subprotocol, or the empty string if there isn't one.

getNegotiatedExtensions

public List<Extension> getNegotiatedExtensions()

Description copied from interface: Session

Return the list of extensions currently in use for this conversation.

Specified by:

getNegotiatedExtensions in interface Session

Returns:

the negotiated extensions.

isSecure

public boolean isSecure()

Description copied from interface: Session

Return true if and only if the underlying socket is using a secure transport.

Specified by:

isSecure in interface Session

Returns:

whether its using a secure transport.

isOpen

public boolean isOpen()

Description copied from interface: Session

Return true if and only if the underlying socket is open.

Specified by:

isOpen in interface Session

Returns:

whether the session is active.

getMaxIdleTimeout

public long getMaxIdleTimeout()

Description copied from interface: Session

Return the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e. no messages are either sent or received in that time.

Specified by:

getMaxIdleTimeout in interface Session

Returns:

the timeout in milliseconds.

setMaxIdleTimeout

public void setMaxIdleTimeout(long milliseconds)

Remote setters are not supported (yet?).

Specified by:

setMaxIdleTimeout in interface Session

Parameters:

milliseconds - nothing.

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int length)

Remote setters are not supported (yet?).

Specified by:

setMaxBinaryMessageBufferSize in interface Session

Parameters:

length - nothing.

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

Description copied from interface: Session

The maximum length of incoming binary messages that this Session can buffer. If the implementation receives a binary message that it cannot buffer because it is too large, it must close the session with a close code of CloseReason.CloseCodes.TOO_BIG.

Specified by:

getMaxBinaryMessageBufferSize in interface Session

Returns:

the maximum binary message size that can be buffered.

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int length)

Remote setters are not supported (yet?).

Specified by:

setMaxTextMessageBufferSize in interface Session

Parameters:

length - nothing.

getMaxTextMessageBufferSize

public int getMaxTextMessageBufferSize()

Description copied from interface: Session

The maximum length of incoming text messages that this Session can buffer. If the implementation receives a text message that it cannot buffer because it is too large, it must close the session with a close code of CloseReason.CloseCodes.TOO_BIG.

Specified by:

getMaxTextMessageBufferSize in interface Session

Returns:

the maximum text message size that can be buffered.

getAsyncRemote

public RemoteEndpoint.Async getAsyncRemote()

Description copied from interface: Session

Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send messages asynchronously to the peer.

Specified by:

getAsyncRemote in interface Session

Returns:

the remote endpoint.

getBasicRemote

public RemoteEndpoint.Basic getBasicRemote()

Description copied from interface: Session

Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send messages synchronously to the peer.

Specified by:

getBasicRemote in interface Session

Returns:

the remote endpoint.

getId

public String getId()

Description copied from interface: Session

Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the web socket implementation and is implementation dependent.

Specified by:

getId in interface Session

Returns:

the unique identifier for this session instance.

close

public void close()
           throws IOException

Description copied from interface: Session

Close the current conversation with a normal status code and no reason phrase.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Session

Throws:

IOException - if there was a connection error closing the connection.

close

public void close(CloseReason closeReason)
           throws IOException

Description copied from interface: Session

Close the current conversation, giving a reason for the closure. The close call causes the implementation to attempt notify the client of the close as soon as it can. This may cause the sending of unsent messages immediately prior to the close notification. After the close notification has been sent the implementation notifies the endpoint's onClose method. Note the websocket specification defines the acceptable uses of status codes and reason phrases. If the application cannot determine a suitable close code to use for the closeReason, it is recommended to use CloseReason.CloseCodes.NO_STATUS_CODE.

Specified by:

close in interface Session

Parameters:

closeReason - the reason for the closure.

Throws:

IOException - if there was a connection error closing the connection

getRequestURI

public URI getRequestURI()

Description copied from interface: Session

Return the URI under which this session was opened, including the query string if there is one.

Specified by:

getRequestURI in interface Session

Returns:

the request URI.

getRequestParameterMap

public Map<String,List<String>> getRequestParameterMap()

Description copied from interface: Session

Return the request parameters associated with the request this session was opened under.

Specified by:

getRequestParameterMap in interface Session

Returns:

the unmodifiable map of the request parameters.

getQueryString

public String getQueryString()

Description copied from interface: Session

Return the query string associated with the request this session was opened under.

Specified by:

getQueryString in interface Session

Returns:

the query string

getPathParameters

public Map<String,String> getPathParameters()

Description copied from interface: Session

Return a map of the path parameter names and values used associated with the request this session was opened under.

Specified by:

getPathParameters in interface Session

Returns:

the unmodifiable map of path parameters. The key of the map is the parameter name, the values in the map are the parameter values.

getUserProperties

public Map<String,Object> getUserProperties()

Description copied from interface: Session

While the session is open, this method returns a Map that the developer may use to store application specific information relating to this session instance. The developer may retrieve information from this Map at any time between the opening of the session and during the onClose() method. But outside that time, any information stored using this Map may no longer be kept by the container. Web socket applications running on distributed implementations of the web container should make any application specific objects stored here java.io.Serializable, or the object may not be recreated after a failover.

Specified by:

getUserProperties in interface Session

Returns:

an editable Map of application data.

getUserPrincipal

public Principal getUserPrincipal()

Description copied from interface: Session

Return the authenticated user for this Session or null if no user is authenticated for this session.

Specified by:

getUserPrincipal in interface Session

Returns:

the user principal.

getOpenSessions

public Set<Session> getOpenSessions()

Not supported.

Session.getOpenSessions()."get()".getOpenSessions() .. why would anyone try to do that?

Specified by:

getOpenSessions in interface Session

Returns:

nothing.

toString

public String toString()

Overrides:

toString in class Object