Package jakarta.websocket
Interface Session
- All Superinterfaces:
- AutoCloseable,- Closeable
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddMessageHandler(MessageHandler handler) 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.voidclose()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.Get the container that created this session.getId()Provides a unique identifier for the session.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.booleanisOpen()booleanisSecure()voidremoveMessageHandler(MessageHandler listener) 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.
- 
Method Details- 
getContainerWebSocketContainer getContainer()Get the container that created this session.- Returns:
- the container that created this session.
 
- 
addMessageHandlerRegisters 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 useaddMessageHandler(Class, jakarta.websocket.MessageHandler.Partial)oraddMessageHandler(Class, jakarta.websocket.MessageHandler.Whole).- Parameters:
- handler- The message handler for a incoming message
- Throws:
- IllegalStateException- If a message handler has already been registered for the associated message type
 
- 
getMessageHandlersSet<MessageHandler> getMessageHandlers()
- 
removeMessageHandler
- 
getProtocolVersionString getProtocolVersion()
- 
getNegotiatedSubprotocolString getNegotiatedSubprotocol()
- 
getNegotiatedExtensions
- 
isSecureboolean isSecure()
- 
isOpenboolean isOpen()
- 
getMaxIdleTimeoutlong getMaxIdleTimeout()Get the idle timeout for this session.- Returns:
- The current idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout.
 
- 
setMaxIdleTimeoutvoid setMaxIdleTimeout(long timeout) Set the idle timeout for this session.- Parameters:
- timeout- The new idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout.
 
- 
setMaxBinaryMessageBufferSizevoid setMaxBinaryMessageBufferSize(int max) Set the current maximum buffer size for binary messages.- Parameters:
- max- The new maximum buffer size in bytes
 
- 
getMaxBinaryMessageBufferSizeint getMaxBinaryMessageBufferSize()Get the current maximum buffer size for binary messages.- Returns:
- The current maximum buffer size in bytes
 
- 
setMaxTextMessageBufferSizevoid setMaxTextMessageBufferSize(int max) Set the maximum buffer size for text messages.- Parameters:
- max- The new maximum buffer size in characters.
 
- 
getMaxTextMessageBufferSizeint getMaxTextMessageBufferSize()Get the maximum buffer size for text messages.- Returns:
- The maximum buffer size in characters.
 
- 
getAsyncRemoteRemoteEndpoint.Async getAsyncRemote()
- 
getBasicRemoteRemoteEndpoint.Basic getBasicRemote()
- 
getIdString getId()Provides a unique identifier for the session. This identifier should not be relied upon to be generated from a secure random source.- Returns:
- A unique identifier for the session.
 
- 
closeClose 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
- Throws:
- IOException- if an I/O error occurs while the WebSocket session is being closed.
 
- 
closeClose the connection to the remote end point using the specified code and reason phrase.- 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.
 
- 
getRequestURIURI getRequestURI()
- 
getRequestParameterMap
- 
getQueryStringString getQueryString()
- 
getPathParameters
- 
getUserProperties
- 
getUserPrincipalPrincipal getUserPrincipal()
- 
getOpenSessionsObtain the set of open sessions associated with the same local endpoint as this session.- Returns:
- The set of currently open sessions for the local endpoint that this session is associated with.
 
- 
addMessageHandler<T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) throws IllegalStateException Registers aMessageHandlerfor partial incoming messages. Only oneMessageHandlermay be registered for each message type (text or binary, pong messages are never presented as partial messages).- 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
- Since:
- WebSocket 1.1
 
- 
addMessageHandler<T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler) throws IllegalStateException Registers aMessageHandlerfor whole incoming messages. Only oneMessageHandlermay be registered for each message type (text, binary, pong).- 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
- Since:
- WebSocket 1.1
 
 
-