public class ClusterSession extends Object implements Session
Modifier and Type | Class and Description |
---|---|
static class |
ClusterSession.DistributedMapKey |
Constructor and Description |
---|
ClusterSession(String sessionId,
ClusterContext clusterContext,
Map<ClusterSession.DistributedMapKey,Object> distributedPropertyMap,
TyrusEndpointWrapper endpointWrapper,
Session session)
Constructor.
|
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?).
|
public ClusterSession(String sessionId, ClusterContext clusterContext, Map<ClusterSession.DistributedMapKey,Object> distributedPropertyMap, TyrusEndpointWrapper endpointWrapper, Session session)
sessionId
- session id.clusterContext
- cluster context.endpointWrapper
- used just to get encoders/decoders.session
- used just to get encoders/decoders.public WebSocketContainer getContainer()
getContainer
in interface Session
public void addMessageHandler(MessageHandler handler) throws IllegalStateException
addMessageHandler
in interface Session
handler
- nothing.IllegalStateException
- newer.public Set<MessageHandler> getMessageHandlers()
getMessageHandlers
in interface Session
public void removeMessageHandler(MessageHandler handler)
removeMessageHandler
in interface Session
handler
- nothing.public String getProtocolVersion()
Session
getProtocolVersion
in interface Session
public String getNegotiatedSubprotocol()
Session
getNegotiatedSubprotocol
in interface Session
public List<Extension> getNegotiatedExtensions()
Session
getNegotiatedExtensions
in interface Session
public boolean isSecure()
Session
public boolean isOpen()
Session
public long getMaxIdleTimeout()
Session
getMaxIdleTimeout
in interface Session
public void setMaxIdleTimeout(long milliseconds)
setMaxIdleTimeout
in interface Session
milliseconds
- nothing.public void setMaxBinaryMessageBufferSize(int length)
setMaxBinaryMessageBufferSize
in interface Session
length
- nothing.public int getMaxBinaryMessageBufferSize()
Session
CloseReason.CloseCodes.TOO_BIG
.getMaxBinaryMessageBufferSize
in interface Session
public void setMaxTextMessageBufferSize(int length)
setMaxTextMessageBufferSize
in interface Session
length
- nothing.public int getMaxTextMessageBufferSize()
Session
CloseReason.CloseCodes.TOO_BIG
.getMaxTextMessageBufferSize
in interface Session
public RemoteEndpoint.Async getAsyncRemote()
Session
getAsyncRemote
in interface Session
public RemoteEndpoint.Basic getBasicRemote()
Session
getBasicRemote
in interface Session
public String getId()
Session
public void close() throws IOException
Session
close
in interface Closeable
close
in interface AutoCloseable
close
in interface Session
IOException
- if there was a connection error closing the connection.public void close(CloseReason closeReason) throws IOException
Session
CloseReason.CloseCodes.NO_STATUS_CODE
.close
in interface Session
closeReason
- the reason for the closure.IOException
- if there was a connection error closing the connectionpublic URI getRequestURI()
Session
getRequestURI
in interface Session
public Map<String,List<String>> getRequestParameterMap()
Session
getRequestParameterMap
in interface Session
public String getQueryString()
Session
getQueryString
in interface Session
public Map<String,String> getPathParameters()
Session
getPathParameters
in interface Session
public Map<String,Object> getUserProperties()
Session
getUserProperties
in interface Session
public Principal getUserPrincipal()
Session
null
if no user is authenticated for this session.getUserPrincipal
in interface Session
public Set<Session> getOpenSessions()
getOpenSessions
in interface Session
Copyright © 2012-2014, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.