org.glassfish.tyrus.platform
Class SessionImpl

java.lang.Object
  extended by org.glassfish.tyrus.platform.SessionImpl
All Implemented Interfaces:
javax.net.websocket.Session

public class SessionImpl
extends java.lang.Object
implements javax.net.websocket.Session

Implementation of the WebSocketConversation.

Author:
Danny Coward, Stepan Kopriva (stepan.kopriva at oracle.com)

Method Summary
 void addEncoder(javax.net.websocket.Encoder encoder)
           
 void addMessageHandler(javax.net.websocket.MessageHandler listener)
           
 void close()
           
 void close(javax.net.websocket.CloseReason closeReason)
          Closes the underlying connection this session is based upon.
 javax.net.websocket.CloseReason getCloseStatus()
           
 java.lang.Long getId()
          Return a unique ID for this session.
 long getInactiveTime()
           
 long getMaximumMessageSize()
           
 java.util.Set getMessageHandlers()
           
 java.util.List<javax.net.websocket.extensions.Extension> getNegotiatedExtensions()
           
 java.lang.String getNegotiatedSubprotocol()
           
 java.lang.String getProtocolVersion()
          Web Socket protocol version used.
 javax.net.websocket.RemoteEndpoint getRemote()
           
 javax.net.websocket.RemoteEndpoint getRemote(java.lang.Class c)
           
 java.net.URI getRequestURI()
           
 javax.servlet.http.HttpSession getSession()
           
 long getTimeout()
           
 boolean isActive()
           
 boolean isSecure()
           
 void removeMessageHandler(javax.net.websocket.MessageHandler listener)
           
 void setMaximumMessageSize(long maximumMessageSize)
           
 void setTimeout(long seconds)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getProtocolVersion

public java.lang.String getProtocolVersion()
Web Socket protocol version used.

Specified by:
getProtocolVersion in interface javax.net.websocket.Session
Returns:
protocol version

getSession

public javax.servlet.http.HttpSession getSession()
Specified by:
getSession in interface javax.net.websocket.Session

getNegotiatedSubprotocol

public java.lang.String getNegotiatedSubprotocol()
Specified by:
getNegotiatedSubprotocol in interface javax.net.websocket.Session

getRemote

public javax.net.websocket.RemoteEndpoint getRemote()
Specified by:
getRemote in interface javax.net.websocket.Session

getRemote

public javax.net.websocket.RemoteEndpoint getRemote(java.lang.Class c)
Specified by:
getRemote in interface javax.net.websocket.Session

getId

public java.lang.Long getId()
Return a unique ID for this session.

Returns:
id

isActive

public boolean isActive()
Specified by:
isActive in interface javax.net.websocket.Session

getTimeout

public long getTimeout()
Specified by:
getTimeout in interface javax.net.websocket.Session

close

public void close()
           throws java.io.IOException
Specified by:
close in interface javax.net.websocket.Session
Throws:
java.io.IOException

close

public void close(javax.net.websocket.CloseReason closeReason)
           throws java.io.IOException
Closes the underlying connection this session is based upon.

Specified by:
close in interface javax.net.websocket.Session
Throws:
java.io.IOException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getCloseStatus

public javax.net.websocket.CloseReason getCloseStatus()
Specified by:
getCloseStatus in interface javax.net.websocket.Session

setTimeout

public void setTimeout(long seconds)
Specified by:
setTimeout in interface javax.net.websocket.Session

setMaximumMessageSize

public void setMaximumMessageSize(long maximumMessageSize)
Specified by:
setMaximumMessageSize in interface javax.net.websocket.Session

getMaximumMessageSize

public long getMaximumMessageSize()
Specified by:
getMaximumMessageSize in interface javax.net.websocket.Session

getNegotiatedExtensions

public java.util.List<javax.net.websocket.extensions.Extension> getNegotiatedExtensions()
Specified by:
getNegotiatedExtensions in interface javax.net.websocket.Session

isSecure

public boolean isSecure()
Specified by:
isSecure in interface javax.net.websocket.Session

getInactiveTime

public long getInactiveTime()
Specified by:
getInactiveTime in interface javax.net.websocket.Session

addEncoder

public void addEncoder(javax.net.websocket.Encoder encoder)
Specified by:
addEncoder in interface javax.net.websocket.Session

addMessageHandler

public void addMessageHandler(javax.net.websocket.MessageHandler listener)
Specified by:
addMessageHandler in interface javax.net.websocket.Session

getMessageHandlers

public java.util.Set getMessageHandlers()
Specified by:
getMessageHandlers in interface javax.net.websocket.Session

removeMessageHandler

public void removeMessageHandler(javax.net.websocket.MessageHandler listener)
Specified by:
removeMessageHandler in interface javax.net.websocket.Session

getRequestURI

public java.net.URI getRequestURI()
Specified by:
getRequestURI in interface javax.net.websocket.Session


Copyright © 2012. All Rights Reserved.