SessionImpl (Tyrus Core 1.2.1 API)

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

All Implemented Interfaces:

Closeable, AutoCloseable, javax.websocket.Session
```
public class SessionImpl
extends Object
implements javax.websocket.Session
```
Implementation of the Session.

Author:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SessionImpl.State
Session state.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SessionImpl.State` Session state.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMessageHandler(javax.websocket.MessageHandler handler)`
`void`	`close()`
`void`	`close(javax.websocket.CloseReason closeReason)` Closes the underlying connection this session is based upon.
`javax.websocket.RemoteEndpoint.Async`	`getAsyncRemote()`
`javax.websocket.RemoteEndpoint.Basic`	`getBasicRemote()`
`javax.websocket.WebSocketContainer`	`getContainer()`
`String`	`getId()`
`int`	`getMaxBinaryMessageBufferSize()`
`long`	`getMaxIdleTimeout()`
`int`	`getMaxTextMessageBufferSize()`
`Set<javax.websocket.MessageHandler>`	`getMessageHandlers()`
`List<javax.websocket.Extension>`	`getNegotiatedExtensions()`
`String`	`getNegotiatedSubprotocol()`
`Set<javax.websocket.Session>`	`getOpenSessions()`
`Map<String,String>`	`getPathParameters()`
`String`	`getProtocolVersion()` Web Socket protocol version used.
`String`	`getQueryString()`
`Map<String,List<String>>`	`getRequestParameterMap()`
`URI`	`getRequestURI()`
`Principal`	`getUserPrincipal()`
`Map<String,Object>`	`getUserProperties()`
`boolean`	`isOpen()`
`boolean`	`isSecure()`
`void`	`removeMessageHandler(javax.websocket.MessageHandler handler)`
`void`	`setMaxBinaryMessageBufferSize(int maxBinaryMessageBufferSize)`
`void`	`setMaxIdleTimeout(long maxIdleTimeout)`
`void`	`setMaxTextMessageBufferSize(int maxTextMessageBufferSize)`
`void`	`setState(SessionImpl.State state)` Set the state of the `Session`.
`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 javax.websocket.Session
    
    Returns:
    protocol version
  - getNegotiatedSubprotocol
```
public String getNegotiatedSubprotocol()
```
    Specified by:
    
    getNegotiatedSubprotocol in interface javax.websocket.Session
  - getAsyncRemote
```
public javax.websocket.RemoteEndpoint.Async getAsyncRemote()
```
    Specified by:
    
    getAsyncRemote in interface javax.websocket.Session
  - getBasicRemote
```
public javax.websocket.RemoteEndpoint.Basic getBasicRemote()
```
    Specified by:
    
    getBasicRemote in interface javax.websocket.Session
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface javax.websocket.Session
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface javax.websocket.Session
    
    Throws:
    
    IOException
  - close
```
public void close(javax.websocket.CloseReason closeReason)
           throws IOException
```
    Closes the underlying connection this session is based upon.
    
    Specified by:
    
    close in interface javax.websocket.Session
    
    Throws:
    
    IOException
  - getMaxBinaryMessageBufferSize
```
public int getMaxBinaryMessageBufferSize()
```
    Specified by:
    
    getMaxBinaryMessageBufferSize in interface javax.websocket.Session
  - setMaxBinaryMessageBufferSize
```
public void setMaxBinaryMessageBufferSize(int maxBinaryMessageBufferSize)
```
    Specified by:
    
    setMaxBinaryMessageBufferSize in interface javax.websocket.Session
  - getMaxTextMessageBufferSize
```
public int getMaxTextMessageBufferSize()
```
    Specified by:
    
    getMaxTextMessageBufferSize in interface javax.websocket.Session
  - setMaxTextMessageBufferSize
```
public void setMaxTextMessageBufferSize(int maxTextMessageBufferSize)
```
    Specified by:
    
    setMaxTextMessageBufferSize in interface javax.websocket.Session
  - getOpenSessions
```
public Set<javax.websocket.Session> getOpenSessions()
```
    Specified by:
    
    getOpenSessions in interface javax.websocket.Session
  - getNegotiatedExtensions
```
public List<javax.websocket.Extension> getNegotiatedExtensions()
```
    Specified by:
    
    getNegotiatedExtensions in interface javax.websocket.Session
  - getMaxIdleTimeout
```
public long getMaxIdleTimeout()
```
    Specified by:
    
    getMaxIdleTimeout in interface javax.websocket.Session
  - setMaxIdleTimeout
```
public void setMaxIdleTimeout(long maxIdleTimeout)
```
    Specified by:
    
    setMaxIdleTimeout in interface javax.websocket.Session
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface javax.websocket.Session
  - getContainer
```
public javax.websocket.WebSocketContainer getContainer()
```
    Specified by:
    
    getContainer in interface javax.websocket.Session
  - addMessageHandler
```
public void addMessageHandler(javax.websocket.MessageHandler handler)
```
    Specified by:
    
    addMessageHandler in interface javax.websocket.Session
  - getMessageHandlers
```
public Set<javax.websocket.MessageHandler> getMessageHandlers()
```
    Specified by:
    
    getMessageHandlers in interface javax.websocket.Session
  - removeMessageHandler
```
public void removeMessageHandler(javax.websocket.MessageHandler handler)
```
    Specified by:
    
    removeMessageHandler in interface javax.websocket.Session
  - getRequestURI
```
public URI getRequestURI()
```
    Specified by:
    
    getRequestURI in interface javax.websocket.Session
  - getRequestParameterMap
```
public Map<String,List<String>> getRequestParameterMap()
```
    Specified by:
    
    getRequestParameterMap in interface javax.websocket.Session
  - getPathParameters
```
public Map<String,String> getPathParameters()
```
    Specified by:
    
    getPathParameters in interface javax.websocket.Session
  - getUserProperties
```
public Map<String,Object> getUserProperties()
```
    Specified by:
    
    getUserProperties in interface javax.websocket.Session
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.websocket.Session
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface javax.websocket.Session
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface javax.websocket.Session
  - setState
```
public void setState(SessionImpl.State state)
```
    Set the state of the Session.
    
    Parameters:
    state - the newly set state.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SessionImpl

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getProtocolVersion

getNegotiatedSubprotocol

getAsyncRemote

getBasicRemote

isOpen

close

close

getMaxBinaryMessageBufferSize

setMaxBinaryMessageBufferSize

getMaxTextMessageBufferSize

setMaxTextMessageBufferSize

getOpenSessions

getNegotiatedExtensions

getMaxIdleTimeout

setMaxIdleTimeout

isSecure

getContainer

addMessageHandler

getMessageHandlers

removeMessageHandler

getRequestURI

getRequestParameterMap

getPathParameters

getUserProperties

getQueryString

getId

getUserPrincipal

setState

toString