org.glassfish.tyrus
Class SessionImpl

java.lang.Object
  org.glassfish.tyrus.SessionImpl

All Implemented Interfaces:

Session

public class SessionImpl
extends Object
implements Session

Implementation of the WebSocketConversation.

Author:

Danny Coward (danny.coward at oracle.com), Stepan Kopriva (stepan.kopriva at oracle.com), Martin Matula (martin.matula at oracle.com)

Method Summary

void	addMessageHandler(MessageHandler listener) Register to handle to incoming messages in this conversation.
void	close() Close the current conversation with a normal status code and no reason phrase.
void	close(CloseReason closeReason) Closes the underlying connection this session is based upon.
ClientContainer	getContainer() Return the container that this session is part of.
long	getInactiveTime() Return the number of seconds since the underlying connection had any activity.
long	getMaximumMessageSize() The maximum total length of messages, text or binary, that this Session can handle.
Set<MessageHandler>	getMessageHandlers() Return an unmodifiable copy of the set of MessageHandlers for this Session.
List<String>	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.
Map<String,String>	getPathParameters() Return a map of the path parameter names and values used if the server endpoint was deployed with a URI-template and the client connected with a particular matching URL.
Map<String,Object>	getProperties()
String	getProtocolVersion() Web Socket protocol version used.
String	getQueryString() Return the query string associated with the request this session was opened under.
RemoteEndpoint	getRemote() Return a reference to the RemoteEndpoint object representing the other end of this conversation.
Map<String,String[]>	getRequestParameterMap() Return the request parameters associated with the request this session was opened under.
URI	getRequestURI() Return the URI that this session was opened under.
long	getTimeout() Return the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received in that time.
boolean	isActive() 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 listener) Remove the given MessageHandler from the set belonging to this session.
void	setEncoders(List<Encoder> encoders) Sets the list of encoders to be used in this session in order of preference.
void	setMaximumMessageSize(long maximumMessageSize) Sets the maximum total length of messages, text or binary, that this Session can handle.
void	setTimeout(long seconds) Set the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getProtocolVersion

public String getProtocolVersion()

Web Socket protocol version used.

Specified by:

getProtocolVersion in interface Session

Returns:

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.

getRemote

public RemoteEndpoint getRemote()

Description copied from interface: Session

Return a reference to the RemoteEndpoint object representing the other end of this conversation.

Specified by:

getRemote in interface Session

Returns:

the remote endpoint.

isActive

public boolean isActive()

Description copied from interface: Session

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

Specified by:

isActive in interface Session

Returns:

whether the session is active.

getTimeout

public long getTimeout()

Description copied from interface: Session

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

Specified by:

getTimeout in interface Session

Returns:

the timeout in milliseconds.

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 Session

Throws:

IOException

close

public void close(CloseReason closeReason)
           throws IOException

Closes the underlying connection this session is based upon.

Specified by:

close in interface Session

Parameters:

closeReason - the reason for the closure.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

setTimeout

public void setTimeout(long seconds)

Description copied from interface: Session

Set the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received.

Specified by:

setTimeout in interface Session

Parameters:

seconds - the number of milliseconds.

setMaximumMessageSize

public void setMaximumMessageSize(long maximumMessageSize)

Description copied from interface: Session

Sets the maximum total length of messages, text or binary, that this Session can handle.

Specified by:

setMaximumMessageSize in interface Session

Parameters:

maximumMessageSize - the maximum length

getMaximumMessageSize

public long getMaximumMessageSize()

Description copied from interface: Session

The maximum total length of messages, text or binary, that this Session can handle.

Specified by:

getMaximumMessageSize in interface Session

Returns:

the message size.

getNegotiatedExtensions

public List<String> 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.

getInactiveTime

public long getInactiveTime()

Description copied from interface: Session

Return the number of seconds since the underlying connection had any activity.

Specified by:

getInactiveTime in interface Session

Returns:

the inactive time.

getContainer

public ClientContainer getContainer()

Description copied from interface: Session

Return the container that this session is part of.

Specified by:

getContainer in interface Session

Returns:

the container

setEncoders

public void setEncoders(List<Encoder> encoders)

Description copied from interface: Session

Sets the list of encoders to be used in this session in order of preference. The first element in the list that matches for a given type will be used rather than a later element in the list that matches for a given type.

Specified by:

setEncoders in interface Session

Parameters:

encoders - the list of encoders.

addMessageHandler

public void addMessageHandler(MessageHandler listener)

Description copied from interface: Session

Register to handle to incoming messages in this conversation.

Specified by:

addMessageHandler in interface Session

Parameters:

listener - the MessageHandler to be added.

getMessageHandlers

public Set<MessageHandler> getMessageHandlers()

Description copied from interface: Session

Return an unmodifiable copy of the set of MessageHandlers for this Session.

Specified by:

getMessageHandlers in interface Session

Returns:

the set of message handlers.

removeMessageHandler

public void removeMessageHandler(MessageHandler listener)

Description copied from interface: Session

Remove the given MessageHandler from the set belonging to this session.

Specified by:

removeMessageHandler in interface Session

Parameters:

listener - the handler to be removed. TBD Threading issues wrt handler invocations vs removal

getRequestURI

public URI getRequestURI()

Description copied from interface: Session

Return the URI that this session was opened under.

Specified by:

getRequestURI in interface Session

Returns:

the request URI.

getRequestParameterMap

public Map<String,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.

getPathParameters

public Map<String,String> getPathParameters()

Description copied from interface: Session

Return a map of the path parameter names and values used if the server endpoint was deployed with a URI-template and the client connected with a particular matching URL.

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.

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:

getProperties

public Map<String,Object> getProperties()