Package org.apache.tomcat.websocket
Class WsSession
java.lang.Object
org.apache.tomcat.websocket.WsSession
- All Implemented Interfaces:
- Session,- Closeable,- AutoCloseable
- 
Constructor SummaryConstructorsConstructorDescriptionWsSession(ClientEndpointHolder clientEndpointHolder, WsRemoteEndpointImplBase wsRemoteEndpoint, WsWebSocketContainer wsWebSocketContainer, List<Extension> negotiatedExtensions, String subProtocol, Map<String, String> pathParameters, boolean secure, ClientEndpointConfig clientEndpointConfig) Creates a new WebSocket session for communication between the provided client and remote end points.WsSession(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, ServerEndpointConfig serverEndpointConfig) Creates a new WebSocket session for communication between the provided server and remote end points.
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddMessageHandler(MessageHandler listener) Registers aMessageHandlerfor incoming messages.<T> voidaddMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) Registers aMessageHandlerfor partial incoming messages.<T> voidaddMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler) Registers aMessageHandlerfor whole incoming messages.protected static voidappendCloseReasonWithTruncation(ByteBuffer msg, String reason) Use protected so unit tests can access this method directly.protected voidprotected voidvoidclose()Close the connection to the remote end point using the codeCloseReason.CloseCodes.NORMAL_CLOSUREand an empty reason phrase.voidclose(CloseReason closeReason) Close the connection to the remote end point using the specified code and reason phrase.voiddoClose(CloseReason closeReasonMessage, CloseReason closeReasonLocal) WebSocket 1.0.voiddoClose(CloseReason closeReasonMessage, CloseReason closeReasonLocal, boolean closeSocket) WebSocket 1.0.protected MessageHandlerGet the container that created this session.getId()Provides a unique identifier for the session.getLocal()intGet the current maximum buffer size for binary messages.longGet the idle timeout for this session.intGet the maximum buffer size for text messages.Obtain the set of open sessions associated with the same local endpoint as this session.protected MessageHandler.Whole<PongMessage>protected longprotected MessageHandlerbooleanisClosed()booleanisOpen()booleanisSecure()voidonClose(CloseReason closeReason) Called when a close message is received.protected voidregisterFuture(org.apache.tomcat.websocket.FutureToSendHandler f2sh) Make the session aware of aFutureToSendHandlerthat will need to be forcibly closed if the session closes before theFutureToSendHandlercompletes.voidremoveMessageHandler(MessageHandler listener) voidresume()Resumes the reading of the incoming messages.voidsetMaxBinaryMessageBufferSize(int max) Set the current maximum buffer size for binary messages.voidsetMaxIdleTimeout(long timeout) Set the idle timeout for this session.voidsetMaxTextMessageBufferSize(int max) Set the maximum buffer size for text messages.voidsuspend()Suspends the reading of the incoming messages.protected voidunregisterFuture(org.apache.tomcat.websocket.FutureToSendHandler f2sh) Remove aFutureToSendHandlerfrom the set of tracked instances.protected voidprotected void
- 
Constructor Details- 
WsSessionpublic WsSession(ClientEndpointHolder clientEndpointHolder, WsRemoteEndpointImplBase wsRemoteEndpoint, WsWebSocketContainer wsWebSocketContainer, List<Extension> negotiatedExtensions, String subProtocol, Map<String, String> pathParameters, boolean secure, ClientEndpointConfig clientEndpointConfig) throws DeploymentExceptionCreates a new WebSocket session for communication between the provided client and remote end points. The result ofThread.getContextClassLoader()at the time this constructor is called will be used when callingEndpoint.onClose(Session, CloseReason).- Parameters:
- clientEndpointHolder- The end point managed by this code
- wsRemoteEndpoint- The other / remote end point
- wsWebSocketContainer- The container that created this session
- negotiatedExtensions- The agreed extensions to use for this session
- subProtocol- The agreed sub-protocol to use for this session
- pathParameters- The path parameters associated with the request that initiated this session or- nullif this is a client session
- secure- Was this session initiated over a secure connection?
- clientEndpointConfig- The configuration information for the client end point
- Throws:
- DeploymentException- if an invalid encode is specified
 
- 
WsSessionpublic WsSession(WsRemoteEndpointImplBase wsRemoteEndpoint, WsWebSocketContainer wsWebSocketContainer, URI requestUri, Map<String, List<String>> requestParameterMap, String queryString, Principal userPrincipal, String httpSessionId, List<Extension> negotiatedExtensions, String subProtocol, Map<String, throws DeploymentExceptionString> pathParameters, boolean secure, ServerEndpointConfig serverEndpointConfig) Creates a new WebSocket session for communication between the provided server and remote end points. The result ofThread.getContextClassLoader()at the time this constructor is called will be used when callingEndpoint.onClose(Session, CloseReason).- Parameters:
- wsRemoteEndpoint- The other / remote end point
- wsWebSocketContainer- The container that created this session
- requestUri- The URI used to connect to this end point or- nullif this is a client session
- requestParameterMap- The parameters associated with the request that initiated this session or- nullif this is a client session
- queryString- The query string associated with the request that initiated this session or- nullif this is a client session
- userPrincipal- The principal associated with the request that initiated this session or- nullif this is a client session
- httpSessionId- The HTTP session ID associated with the request that initiated this session or- nullif this is a client session
- negotiatedExtensions- The agreed extensions to use for this session
- subProtocol- The agreed sub-protocol to use for this session
- pathParameters- The path parameters associated with the request that initiated this session or- nullif this is a client session
- secure- Was this session initiated over a secure connection?
- serverEndpointConfig- The configuration information for the server end point
- Throws:
- DeploymentException- if an invalid encode is specified
 
 
- 
- 
Method Details- 
getInstanceManager
- 
getContainerDescription copied from interface:jakarta.websocket.SessionGet the container that created this session.- Specified by:
- getContainerin interface- Session
- Returns:
- the container that created this session.
 
- 
addMessageHandlerDescription copied from interface:jakarta.websocket.SessionRegisters aMessageHandlerfor incoming messages. Only oneMessageHandlermay be registered for each message type (text, binary, pong). The message type will be derived at runtime from the providedMessageHandlerinstance. It is not always possible to do this so it is better to useSession.addMessageHandler(Class, jakarta.websocket.MessageHandler.Partial)orSession.addMessageHandler(Class, jakarta.websocket.MessageHandler.Whole).- Specified by:
- addMessageHandlerin interface- Session
- Parameters:
- listener- The message handler for a incoming message
 
- 
addMessageHandlerpublic <T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) throws IllegalStateException Description copied from interface:jakarta.websocket.SessionRegisters aMessageHandlerfor partial incoming messages. Only oneMessageHandlermay be registered for each message type (text or binary, pong messages are never presented as partial messages).- Specified by:
- addMessageHandlerin interface- Session
- Type Parameters:
- T- The type of message that the given handler is intended for
- Parameters:
- clazz- The Class that implements T
- handler- The message handler for a incoming message
- Throws:
- IllegalStateException- If a message handler has already been registered for the associated message type
 
- 
addMessageHandlerpublic <T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler) throws IllegalStateException Description copied from interface:jakarta.websocket.SessionRegisters aMessageHandlerfor whole incoming messages. Only oneMessageHandlermay be registered for each message type (text, binary, pong).- Specified by:
- addMessageHandlerin interface- Session
- Type Parameters:
- T- The type of message that the given handler is intended for
- Parameters:
- clazz- The Class that implements T
- handler- The message handler for a incoming message
- Throws:
- IllegalStateException- If a message handler has already been registered for the associated message type
 
- 
getMessageHandlers- Specified by:
- getMessageHandlersin interface- Session
 
- 
removeMessageHandler- Specified by:
- removeMessageHandlerin interface- Session
 
- 
getProtocolVersion- Specified by:
- getProtocolVersionin interface- Session
 
- 
getNegotiatedSubprotocol- Specified by:
- getNegotiatedSubprotocolin interface- Session
 
- 
getNegotiatedExtensions- Specified by:
- getNegotiatedExtensionsin interface- Session
 
- 
isSecurepublic boolean isSecure()
- 
isOpenpublic boolean isOpen()
- 
isClosedpublic boolean isClosed()
- 
getMaxIdleTimeoutpublic long getMaxIdleTimeout()Description copied from interface:jakarta.websocket.SessionGet the idle timeout for this session.- Specified by:
- getMaxIdleTimeoutin interface- Session
- Returns:
- The current idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout.
 
- 
setMaxIdleTimeoutpublic void setMaxIdleTimeout(long timeout) Description copied from interface:jakarta.websocket.SessionSet the idle timeout for this session.- Specified by:
- setMaxIdleTimeoutin interface- Session
- Parameters:
- timeout- The new idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout.
 
- 
setMaxBinaryMessageBufferSizepublic void setMaxBinaryMessageBufferSize(int max) Description copied from interface:jakarta.websocket.SessionSet the current maximum buffer size for binary messages.- Specified by:
- setMaxBinaryMessageBufferSizein interface- Session
- Parameters:
- max- The new maximum buffer size in bytes
 
- 
getMaxBinaryMessageBufferSizepublic int getMaxBinaryMessageBufferSize()Description copied from interface:jakarta.websocket.SessionGet the current maximum buffer size for binary messages.- Specified by:
- getMaxBinaryMessageBufferSizein interface- Session
- Returns:
- The current maximum buffer size in bytes
 
- 
setMaxTextMessageBufferSizepublic void setMaxTextMessageBufferSize(int max) Description copied from interface:jakarta.websocket.SessionSet the maximum buffer size for text messages.- Specified by:
- setMaxTextMessageBufferSizein interface- Session
- Parameters:
- max- The new maximum buffer size in characters.
 
- 
getMaxTextMessageBufferSizepublic int getMaxTextMessageBufferSize()Description copied from interface:jakarta.websocket.SessionGet the maximum buffer size for text messages.- Specified by:
- getMaxTextMessageBufferSizein interface- Session
- Returns:
- The maximum buffer size in characters.
 
- 
getOpenSessionsDescription copied from interface:jakarta.websocket.SessionObtain the set of open sessions associated with the same local endpoint as this session.- Specified by:
- getOpenSessionsin interface- Session
- Returns:
- The set of currently open sessions for the local endpoint that this session is associated with.
 
- 
getAsyncRemote- Specified by:
- getAsyncRemotein interface- Session
 
- 
getBasicRemote- Specified by:
- getBasicRemotein interface- Session
 
- 
closeDescription copied from interface:jakarta.websocket.SessionClose the connection to the remote end point using the codeCloseReason.CloseCodes.NORMAL_CLOSUREand an empty reason phrase.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Specified by:
- closein interface- Session
- Throws:
- IOException- if an I/O error occurs while the WebSocket session is being closed.
 
- 
closeDescription copied from interface:jakarta.websocket.SessionClose the connection to the remote end point using the specified code and reason phrase.- Specified by:
- closein interface- Session
- Parameters:
- closeReason- The reason the WebSocket session is being closed.
- Throws:
- IOException- if an I/O error occurs while the WebSocket session is being closed.
 
- 
doCloseWebSocket 1.0. Section 2.1.5. Need internal close method as spec requires that the local endpoint receives a 1006 on timeout.- Parameters:
- closeReasonMessage- The close reason to pass to the remote endpoint
- closeReasonLocal- The close reason to pass to the local endpoint
 
- 
doClosepublic void doClose(CloseReason closeReasonMessage, CloseReason closeReasonLocal, boolean closeSocket) WebSocket 1.0. Section 2.1.5. Need internal close method as spec requires that the local endpoint receives a 1006 on timeout.- Parameters:
- closeReasonMessage- The close reason to pass to the remote endpoint
- closeReasonLocal- The close reason to pass to the local endpoint
- closeSocket- Should the socket be closed immediately rather than waiting for the server to respond
 
- 
onCloseCalled when a close message is received. Should only ever happen once. Also called after a protocol error when the ProtocolHandler needs to force the closing of the connection.- Parameters:
- closeReason- The reason contained within the received close message.
 
- 
getSessionCloseTimeoutprotected long getSessionCloseTimeout()
- 
checkCloseTimeoutprotected void checkCloseTimeout()
- 
appendCloseReasonWithTruncationUse protected so unit tests can access this method directly.- Parameters:
- msg- The message
- reason- The reason
 
- 
registerFutureprotected void registerFuture(org.apache.tomcat.websocket.FutureToSendHandler f2sh) Make the session aware of aFutureToSendHandlerthat will need to be forcibly closed if the session closes before theFutureToSendHandlercompletes.- Parameters:
- f2sh- The handler
 
- 
unregisterFutureprotected void unregisterFuture(org.apache.tomcat.websocket.FutureToSendHandler f2sh) Remove aFutureToSendHandlerfrom the set of tracked instances.- Parameters:
- f2sh- The handler
 
- 
getRequestURI- Specified by:
- getRequestURIin interface- Session
 
- 
getRequestParameterMap- Specified by:
- getRequestParameterMapin interface- Session
 
- 
getQueryString- Specified by:
- getQueryStringin interface- Session
 
- 
getUserPrincipal- Specified by:
- getUserPrincipalin interface- Session
 
- 
getUserPrincipalInternal
- 
getPathParameters- Specified by:
- getPathParametersin interface- Session
 
- 
getIdDescription copied from interface:jakarta.websocket.SessionProvides a unique identifier for the session. This identifier should not be relied upon to be generated from a secure random source.
- 
getUserProperties- Specified by:
- getUserPropertiesin interface- Session
 
- 
getLocal
- 
getHttpSessionId
- 
getTextMessageHandler
- 
getBinaryMessageHandler
- 
getPongMessageHandler
- 
updateLastActiveReadprotected void updateLastActiveRead()
- 
updateLastActiveWriteprotected void updateLastActiveWrite()
- 
checkExpirationprotected void checkExpiration()
- 
suspendpublic void suspend()Suspends the reading of the incoming messages.
- 
resumepublic void resume()Resumes the reading of the incoming messages.
 
-