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,
List<Extension> negotiatedExtensions,
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 |
---|---|
<T> void |
addMessageHandler(Class<T> clazz,
MessageHandler.Partial<T> handler)
Registers a
MessageHandler for partial incoming messages. |
<T> void |
addMessageHandler(Class<T> clazz,
MessageHandler.Whole<T> handler)
Registers a
MessageHandler for whole incoming messages. |
void |
addMessageHandler(MessageHandler listener)
Registers a
MessageHandler for incoming messages. |
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.
|
void |
doClose(CloseReason closeReasonMessage,
CloseReason closeReasonLocal)
WebSocket 1.0.
|
void |
doClose(CloseReason closeReasonMessage,
CloseReason closeReasonLocal,
boolean closeSocket)
WebSocket 1.0.
|
RemoteEndpoint.Async |
getAsyncRemote() |
RemoteEndpoint.Basic |
getBasicRemote() |
protected MessageHandler |
getBinaryMessageHandler() |
WebSocketContainer |
getContainer()
Get 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 for binary messages.
|
long |
getMaxIdleTimeout()
Get the idle timeout for this session.
|
int |
getMaxTextMessageBufferSize()
Get the maximum buffer size for text messages.
|
Set<MessageHandler> |
getMessageHandlers() |
List<Extension> |
getNegotiatedExtensions() |
String |
getNegotiatedSubprotocol() |
Set<Session> |
getOpenSessions()
Obtain the set of open sessions associated with the same local endpoint
as this session.
|
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 for binary messages.
|
void |
setMaxIdleTimeout(long timeout)
Set the idle timeout for this session.
|
void |
setMaxTextMessageBufferSize(int max)
Set the maximum buffer size for text messages.
|
protected void |
unregisterFuture(org.apache.tomcat.websocket.FutureToSendHandler f2sh)
Remove a
FutureToSendHandler from the set of tracked instances. |
protected void |
updateLastActiveRead() |
protected void |
updateLastActiveWrite() |
public WsSession(Endpoint localEndpoint, WsRemoteEndpointImplBase wsRemoteEndpoint, WsWebSocketContainer wsWebSocketContainer, URI requestUri, Map<String,List<String>> requestParameterMap, String queryString, Principal userPrincipal, String httpSessionId, List<Extension> negotiatedExtensions, 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
- negotiatedExtensions
- DeploymentException
public WebSocketContainer getContainer()
Session
getContainer
in interface Session
public void addMessageHandler(MessageHandler listener)
Session
MessageHandler
for incoming messages. Only one
MessageHandler
may be registered for each message type (text,
binary, pong). The message type will be derived at runtime from the
provided MessageHandler
instance. It is not always possible to do
this so it is better to use
Session.addMessageHandler(Class, javax.websocket.MessageHandler.Partial)
or
Session.addMessageHandler(Class, javax.websocket.MessageHandler.Whole)
.addMessageHandler
in interface Session
listener
- The message handler for a incoming messagepublic <T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) throws IllegalStateException
Session
MessageHandler
for partial incoming messages. Only
one MessageHandler
may be registered for each message type (text
or binary, pong messages are never presented as partial messages).addMessageHandler
in interface Session
T
- The type of message that the given handler is intended
forclazz
- The Class that implements Thandler
- The message handler for a incoming messageIllegalStateException
- If a message handler has already been
registered for the associated message typepublic <T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler) throws IllegalStateException
Session
MessageHandler
for whole incoming messages. Only
one MessageHandler
may be registered for each message type (text,
binary, pong).addMessageHandler
in interface Session
T
- The type of message that the given handler is intended
forclazz
- The Class that implements Thandler
- The message handler for a incoming messageIllegalStateException
- If a message handler has already been
registered for the associated message typepublic Set<MessageHandler> getMessageHandlers()
getMessageHandlers
in interface Session
public void removeMessageHandler(MessageHandler listener)
removeMessageHandler
in interface Session
public String getProtocolVersion()
getProtocolVersion
in interface Session
public String getNegotiatedSubprotocol()
getNegotiatedSubprotocol
in interface Session
public List<Extension> getNegotiatedExtensions()
getNegotiatedExtensions
in interface Session
public long getMaxIdleTimeout()
Session
getMaxIdleTimeout
in interface Session
public void setMaxIdleTimeout(long timeout)
Session
setMaxIdleTimeout
in interface Session
timeout
- The new idle timeout for this session in milliseconds.
Zero or negative values indicate an infinite timeout.public void setMaxBinaryMessageBufferSize(int max)
Session
setMaxBinaryMessageBufferSize
in interface Session
max
- The new maximum buffer size in bytespublic int getMaxBinaryMessageBufferSize()
Session
getMaxBinaryMessageBufferSize
in interface Session
public void setMaxTextMessageBufferSize(int max)
Session
setMaxTextMessageBufferSize
in interface Session
max
- The new maximum buffer size in characters.public int getMaxTextMessageBufferSize()
Session
getMaxTextMessageBufferSize
in interface Session
public Set<Session> getOpenSessions()
Session
getOpenSessions
in interface Session
public RemoteEndpoint.Async getAsyncRemote()
getAsyncRemote
in interface Session
public RemoteEndpoint.Basic getBasicRemote()
getBasicRemote
in interface Session
public void close() throws IOException
Session
CloseReason.CloseCodes.NORMAL_CLOSURE
and an
empty reason phrase.close
in interface Closeable
close
in interface AutoCloseable
close
in interface Session
IOException
- if an I/O error occurs while the WebSocket session is
being closed.public void close(CloseReason closeReason) throws IOException
Session
close
in interface Session
closeReason
- The reason the WebSocket session is being closed.IOException
- if an I/O error occurs while the WebSocket session is
being closed.public void doClose(CloseReason closeReasonMessage, CloseReason closeReasonLocal)
public void doClose(CloseReason closeReasonMessage, CloseReason closeReasonLocal, boolean closeSocket)
closeReasonMessage
- The close reason to pass to the remote endpointcloseReasonLocal
- The close reason to pass to the local endpointcloseSocket
- Should the socket be closed immediately rather than waiting
for the server to respondpublic 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 Session
public Map<String,List<String>> getRequestParameterMap()
getRequestParameterMap
in interface Session
public String getQueryString()
getQueryString
in interface Session
public Principal getUserPrincipal()
getUserPrincipal
in interface Session
public Map<String,String> getPathParameters()
getPathParameters
in interface Session
public String getId()
Session
public Map<String,Object> getUserProperties()
getUserProperties
in interface Session
public Endpoint getLocal()
public String getHttpSessionId()
protected MessageHandler getTextMessageHandler()
protected MessageHandler getBinaryMessageHandler()
protected MessageHandler.Whole<PongMessage> getPongMessageHandler()
protected void updateLastActiveRead()
protected void updateLastActiveWrite()
protected void checkExpiration()
Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.