public class WsSession extends Object implements Session
| Constructor and Description |
|---|
WsSession(Endpoint localEndpoint,
WsRemoteEndpointImplBase wsRemoteEndpoint,
WsWebSocketContainer wsWebSocketContainer,
URI requestUri,
Map<String,List<String>> requestParameterMap,
String queryString,
Principal userPrincipal,
String httpSessionId,
String subProtocol,
Map<String,String> pathParameters,
boolean secure,
EndpointConfig endpointConfig)
Creates a new WebSocket session for communication between the two
provided end points.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addMessageHandler(MessageHandler listener) |
protected static void |
appendCloseReasonWithTruncation(ByteBuffer msg,
String reason)
Use protected so unit tests can access this method directly.
|
protected void |
checkExpiration() |
void |
close()
Close the connection to the remote end point using the code
CloseReason.CloseCodes.NORMAL_CLOSURE and an
empty reason phrase. |
void |
close(CloseReason closeReason)
Close the connection to the remote end point using the specified code
and reason phrase.
|
RemoteEndpoint.Async |
getAsyncRemote() |
RemoteEndpoint.Basic |
getBasicRemote() |
protected MessageHandler |
getBinaryMessageHandler() |
WebSocketContainer |
getContainer()
Returns the container that created this session.
|
String |
getHttpSessionId() |
String |
getId()
Provides a unique identifier for the session.
|
Endpoint |
getLocal() |
int |
getMaxBinaryMessageBufferSize()
Get the current maximum buffer size (in bytes) for binary messages.
|
long |
getMaxIdleTimeout()
Get the idle timeout for this session in milliseconds.
|
int |
getMaxTextMessageBufferSize()
Get the current maximum buffer size (in characters) for text messages.
|
Set<MessageHandler> |
getMessageHandlers() |
List<Extension> |
getNegotiatedExtensions() |
String |
getNegotiatedSubprotocol() |
Set<Session> |
getOpenSessions()
Obtain the set of currently open sessions for the local endpoint that
this session is associated with.
|
Map<String,String> |
getPathParameters() |
protected MessageHandler.Whole<PongMessage> |
getPongMessageHandler() |
String |
getProtocolVersion() |
String |
getQueryString() |
Map<String,List<String>> |
getRequestParameterMap() |
URI |
getRequestURI() |
protected MessageHandler |
getTextMessageHandler() |
Principal |
getUserPrincipal() |
Map<String,Object> |
getUserProperties() |
boolean |
isOpen() |
boolean |
isSecure() |
void |
onClose(CloseReason closeReason)
Called when a close message is received.
|
protected void |
registerFuture(org.apache.tomcat.websocket.FutureToSendHandler f2sh)
Make the session aware of a
FutureToSendHandler that will need to
be forcibly closed if the session closes before the
FutureToSendHandler completes. |
void |
removeMessageHandler(MessageHandler listener) |
void |
setMaxBinaryMessageBufferSize(int max)
Set the current maximum buffer size (in bytes) for binary messages.
|
void |
setMaxIdleTimeout(long timeout)
Set the idle timeout for this session in milliseconds.
|
void |
setMaxTextMessageBufferSize(int max)
Set the current maximum buffer size (in characters) for text messages.
|
protected void |
unregisterFuture(org.apache.tomcat.websocket.FutureToSendHandler f2sh)
Remove a
FutureToSendHandler from the set of tracked instances. |
protected void |
updateLastActive() |
public WsSession(Endpoint localEndpoint, WsRemoteEndpointImplBase wsRemoteEndpoint, WsWebSocketContainer wsWebSocketContainer, URI requestUri, Map<String,List<String>> requestParameterMap, String queryString, Principal userPrincipal, String httpSessionId, String subProtocol, Map<String,String> pathParameters, boolean secure, EndpointConfig endpointConfig) throws DeploymentException
Thread.getContextClassLoader()
at the time this constructor is called will be used when calling
Endpoint.onClose(Session, CloseReason).localEndpoint - wsRemoteEndpoint - DeploymentExceptionpublic WebSocketContainer getContainer()
javax.websocket.SessiongetContainer in interface Sessionpublic void addMessageHandler(MessageHandler listener)
addMessageHandler in interface Sessionpublic Set<MessageHandler> getMessageHandlers()
getMessageHandlers in interface Sessionpublic void removeMessageHandler(MessageHandler listener)
removeMessageHandler in interface Sessionpublic String getProtocolVersion()
getProtocolVersion in interface Sessionpublic String getNegotiatedSubprotocol()
getNegotiatedSubprotocol in interface Sessionpublic List<Extension> getNegotiatedExtensions()
getNegotiatedExtensions in interface Sessionpublic long getMaxIdleTimeout()
javax.websocket.SessiongetMaxIdleTimeout in interface Sessionpublic void setMaxIdleTimeout(long timeout)
javax.websocket.SessionsetMaxIdleTimeout in interface Sessionpublic void setMaxBinaryMessageBufferSize(int max)
javax.websocket.SessionsetMaxBinaryMessageBufferSize in interface Sessionpublic int getMaxBinaryMessageBufferSize()
javax.websocket.SessiongetMaxBinaryMessageBufferSize in interface Sessionpublic void setMaxTextMessageBufferSize(int max)
javax.websocket.SessionsetMaxTextMessageBufferSize in interface Sessionpublic int getMaxTextMessageBufferSize()
javax.websocket.SessiongetMaxTextMessageBufferSize in interface Sessionpublic Set<Session> getOpenSessions()
javax.websocket.SessiongetOpenSessions in interface Sessionpublic RemoteEndpoint.Async getAsyncRemote()
getAsyncRemote in interface Sessionpublic RemoteEndpoint.Basic getBasicRemote()
getBasicRemote in interface Sessionpublic void close()
throws IOException
javax.websocket.SessionCloseReason.CloseCodes.NORMAL_CLOSURE and an
empty reason phrase.close in interface Closeableclose in interface AutoCloseableclose in interface SessionIOExceptionpublic void close(CloseReason closeReason) throws IOException
javax.websocket.Sessionclose in interface SessionIOExceptionpublic void onClose(CloseReason closeReason)
protected static void appendCloseReasonWithTruncation(ByteBuffer msg, String reason)
protected void registerFuture(org.apache.tomcat.websocket.FutureToSendHandler f2sh)
FutureToSendHandler that will need to
be forcibly closed if the session closes before the
FutureToSendHandler completes.protected void unregisterFuture(org.apache.tomcat.websocket.FutureToSendHandler f2sh)
FutureToSendHandler from the set of tracked instances.public URI getRequestURI()
getRequestURI in interface Sessionpublic Map<String,List<String>> getRequestParameterMap()
getRequestParameterMap in interface Sessionpublic String getQueryString()
getQueryString in interface Sessionpublic Principal getUserPrincipal()
getUserPrincipal in interface Sessionpublic Map<String,String> getPathParameters()
getPathParameters in interface Sessionpublic String getId()
javax.websocket.Sessionpublic Map<String,Object> getUserProperties()
getUserProperties in interface Sessionpublic Endpoint getLocal()
public String getHttpSessionId()
protected MessageHandler getTextMessageHandler()
protected MessageHandler getBinaryMessageHandler()
protected MessageHandler.Whole<PongMessage> getPongMessageHandler()
protected void updateLastActive()
protected void checkExpiration()
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.