TyrusSession (Tyrus 1.12 API)

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

All Implemented Interfaces:

Closeable, AutoCloseable, javax.websocket.Session, DistributedSession
```
public class TyrusSession
extends Object
implements javax.websocket.Session, DistributedSession
```
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)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T> void`	`addMessageHandler(Class<T> clazz, javax.websocket.MessageHandler.Partial<T> handler)` Register to handle to incoming messages in this conversation.
`<T> void`	`addMessageHandler(Class<T> clazz, javax.websocket.MessageHandler.Whole<T> handler)` Register to handle to incoming messages in this conversation.
`void`	`addMessageHandler(javax.websocket.MessageHandler handler)` Deprecated. please use `addMessageHandler(Class, javax.websocket.MessageHandler.Whole)` or `addMessageHandler(Class, javax.websocket.MessageHandler.Partial)`
`Map<javax.websocket.Session,Future<?>>`	`broadcast(ByteBuffer message)` Broadcasts binary message to all connected clients, including remote sessions (if any).
`Map<javax.websocket.Session,Future<?>>`	`broadcast(String message)` Broadcasts text message to all connected clients.
`void`	`close()`
`void`	`close(javax.websocket.CloseReason closeReason)`
`Set<DistributedSession>`	`getAllSessions()` Get set of all sessions opened to the same endpoint.
`javax.websocket.RemoteEndpoint.Async`	`getAsyncRemote()`
`javax.websocket.RemoteEndpoint.Basic`	`getBasicRemote()`
`javax.websocket.WebSocketContainer`	`getContainer()`
`Map<String,Object>`	`getDistributedProperties()` Get distributed properties.
`long`	`getHeartbeatInterval()` Return an interval in milliseconds between scheduled periodic Pong messages.
`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()`
`String`	`getQueryString()`
`String`	`getRemoteAddr()` Get the Internet Protocol (IP) address of the client or last proxy that sent the request.
`Set<RemoteSession>`	`getRemoteSessions()` Get set of remote sessions.
`Map<String,List<String>>`	`getRequestParameterMap()`
`URI`	`getRequestURI()`
`Principal`	`getUserPrincipal()`
`Map<String,Object>`	`getUserProperties()`
`boolean`	`isOpen()`
`boolean`	`isSecure()`
`void`	`removeMessageHandler(javax.websocket.MessageHandler handler)`
`void`	`setHeartbeatInterval(long heartbeatInterval)` Set an interval in milliseconds between scheduled periodic Pong messages.
`void`	`setMaxBinaryMessageBufferSize(int maxBinaryMessageBufferSize)`
`void`	`setMaxIdleTimeout(long maxIdleTimeout)`
`void`	`setMaxTextMessageBufferSize(int maxTextMessageBufferSize)`
`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()
```
    Specified by:
    
    getProtocolVersion in interface javax.websocket.Session
  - 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
```
    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
  - getRemoteSessions
```
public Set<RemoteSession> getRemoteSessions()
```
    Get set of remote sessions.
    Remote sessions are websocket sessions which are bound to another node in the cluster.
    
    Returns:
    
    set of remote sessions or empty set, when not running in cluster environment.
  - getAllSessions
```
public Set<DistributedSession> getAllSessions()
```
    Get set of all sessions opened to the same endpoint.
    Set returned from this method contains all "local" and remote sessions (if any).
    
    Returns:
    
    set of distributed sessions.
    
    See Also:
    
    RemoteSession
  - 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)
```
    Deprecated. please use addMessageHandler(Class, javax.websocket.MessageHandler.Whole) or addMessageHandler(Class, javax.websocket.MessageHandler.Partial)
    
    Specified by:
    
    addMessageHandler in interface javax.websocket.Session
  - addMessageHandler
```
public <T> void addMessageHandler(Class<T> clazz,
                                  javax.websocket.MessageHandler.Whole<T> handler)
```
    Register to handle to incoming messages in this conversation. A maximum of one message handler per native websocket message type (text, binary, pong) may be added to each Session. I.e. a maximum of one message handler to handle incoming text messages a maximum of one message handler for handling incoming binary messages, and a maximum of one for handling incoming pong messages. For further details of which message handlers handle which of the native websocket message types please see MessageHandler.Whole and MessageHandler.Partial. Adding more than one of any one type will result in a runtime exception.
    
    See Endpoint for a usage example.
    
    Specified by:
    
    addMessageHandler in interface javax.websocket.Session
    
    Parameters:
    
    clazz - type of the message processed by message handler to be registered.
    
    handler - the MessageHandler to be added.
    
    Throws:
    
    IllegalStateException - if there is already a MessageHandler registered for the same native websocket message type as this handler.
  - addMessageHandler
```
public <T> void addMessageHandler(Class<T> clazz,
                                  javax.websocket.MessageHandler.Partial<T> handler)
```
    Register to handle to incoming messages in this conversation. A maximum of one message handler per native websocket message type (text, binary, pong) may be added to each Session. I.e. a maximum of one message handler to handle incoming text messages a maximum of one message handler for handling incoming binary messages, and a maximum of one for handling incoming pong messages. For further details of which message handlers handle which of the native websocket message types please see MessageHandler.Whole and MessageHandler.Partial. Adding more than one of any one type will result in a runtime exception.
    
    See Endpoint for a usage example.
    
    Specified by:
    
    addMessageHandler in interface javax.websocket.Session
    
    Parameters:
    
    clazz - type of the message processed by message handler to be registered.
    
    handler - the MessageHandler to be added.
    
    Throws:
    
    IllegalStateException - if there is already a MessageHandler registered for the same native websocket message type as this handler.
  - 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
  - getDistributedProperties
```
public Map<String,Object> getDistributedProperties()
```
    Description copied from interface: DistributedSession
    
    Get distributed properties.
    Values put into this map must be Serializable or serializable by other, implementation-dependent alternative.
    Content of this map is synchronized among all cluster nodes, so putting an entry on any of the nodes will be visible on all other nodes which have reference to current session (in form of TyrusSession or RemoteSession).
    Please note that when not running in the distributed environment, this map behaves similarly to Session.getUserProperties(), so no serialization or deserialization is performed when values are read from or stored to the returned map.
    
    Specified by:
    
    getDistributedProperties in interface DistributedSession
    
    Returns:
    
    map of distributed properties.
    
    See Also:
    
    TyrusSession, RemoteSession
  - 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
  - broadcast
```
public Map<javax.websocket.Session,Future<?>> broadcast(String message)
```
    Broadcasts text message to all connected clients.
    The broadcast can be executed in parallel, which can be enabled by setting TyrusWebSocketEngine.PARALLEL_BROADCAST_ENABLED to true in server properties.
    
    Parameters:
    
    message - message to be broadcasted.
    
    Returns:
    
    map of local sessions and futures for user to get the information about status of the message.
  - broadcast
```
public Map<javax.websocket.Session,Future<?>> broadcast(ByteBuffer message)
```
    Broadcasts binary message to all connected clients, including remote sessions (if any).
    The broadcast can be executed in parallel, which can be enabled by setting TyrusWebSocketEngine.PARALLEL_BROADCAST_ENABLED to true in server properties.
    
    Parameters:
    
    message - message to be broadcasted.
    
    Returns:
    
    map of local sessions and futures for user to get the information about status of the message.
  - getHeartbeatInterval
```
public long getHeartbeatInterval()
```
    Return an interval in milliseconds between scheduled periodic Pong messages. A negative value or 0 means that sending of periodic Pong messages is not turned on.
    
    Returns:
    
    heartbeatInterval interval between periodic pong messages in milliseconds.
  - setHeartbeatInterval
```
public void setHeartbeatInterval(long heartbeatInterval)
```
    Set an interval in milliseconds between scheduled periodic Pong messages. Setting the interval to a negative value or 0 will cancel sending of periodic Pong messages.
    
    Parameters:
    
    heartbeatInterval - interval between periodic Pong messages in milliseconds.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Get the Internet Protocol (IP) address of the client or last proxy that sent the request.
    
    Returns:
    
    a String containing the IP address of the client that sent the request or null when method is called on client-side.

Class TyrusSession

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getProtocolVersion

getNegotiatedSubprotocol

getAsyncRemote

getBasicRemote

isOpen

close

close

getMaxBinaryMessageBufferSize

setMaxBinaryMessageBufferSize

getMaxTextMessageBufferSize

setMaxTextMessageBufferSize

getOpenSessions

getRemoteSessions

getAllSessions

getNegotiatedExtensions

getMaxIdleTimeout

setMaxIdleTimeout

isSecure

getContainer

addMessageHandler

addMessageHandler

addMessageHandler

getMessageHandlers

removeMessageHandler

getRequestURI

getRequestParameterMap

getPathParameters

getUserProperties

getDistributedProperties

getQueryString

getId

getUserPrincipal

broadcast

broadcast

getHeartbeatInterval

setHeartbeatInterval

toString

getRemoteAddr