Package jakarta.websocket
Interface Session
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addMessageHandler
(MessageHandler handler) Registers aMessageHandler
for incoming messages.<T> void
addMessageHandler
(Class<T> clazz, MessageHandler.Partial<T> handler) Registers aMessageHandler
for partial incoming messages.<T> void
addMessageHandler
(Class<T> clazz, MessageHandler.Whole<T> handler) Registers aMessageHandler
for whole incoming messages.void
close()
Close the connection to the remote end point using the codeCloseReason.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.Get the container that created this session.getId()
Provides a unique identifier for the session.int
Get the current maximum buffer size for binary messages.long
Get the idle timeout for this session.int
Get the maximum buffer size for text messages.Obtain the set of open sessions associated with the same local endpoint as this session.boolean
isOpen()
boolean
isSecure()
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.
-
Method Details
-
getContainer
WebSocketContainer getContainer()Get the container that created this session.- Returns:
- the container that created this session.
-
addMessageHandler
Registers aMessageHandler
for incoming messages. Only oneMessageHandler
may be registered for each message type (text, binary, pong). The message type will be derived at runtime from the providedMessageHandler
instance. 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
-
getMessageHandlers
Set<MessageHandler> getMessageHandlers() -
removeMessageHandler
-
getProtocolVersion
String getProtocolVersion() -
getNegotiatedSubprotocol
String getNegotiatedSubprotocol() -
getNegotiatedExtensions
-
isSecure
boolean isSecure() -
isOpen
boolean isOpen() -
getMaxIdleTimeout
long 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.
-
setMaxIdleTimeout
void 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.
-
setMaxBinaryMessageBufferSize
void setMaxBinaryMessageBufferSize(int max) Set the current maximum buffer size for binary messages.- Parameters:
max
- The new maximum buffer size in bytes
-
getMaxBinaryMessageBufferSize
int getMaxBinaryMessageBufferSize()Get the current maximum buffer size for binary messages.- Returns:
- The current maximum buffer size in bytes
-
setMaxTextMessageBufferSize
void setMaxTextMessageBufferSize(int max) Set the maximum buffer size for text messages.- Parameters:
max
- The new maximum buffer size in characters.
-
getMaxTextMessageBufferSize
int getMaxTextMessageBufferSize()Get the maximum buffer size for text messages.- Returns:
- The maximum buffer size in characters.
-
getAsyncRemote
RemoteEndpoint.Async getAsyncRemote() -
getBasicRemote
RemoteEndpoint.Basic getBasicRemote() -
getId
String 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.
-
close
Close the connection to the remote end point using the codeCloseReason.CloseCodes.NORMAL_CLOSURE
and an empty reason phrase.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
- if an I/O error occurs while the WebSocket session is being closed.
-
close
Close 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.
-
getRequestURI
URI getRequestURI() -
getRequestParameterMap
-
getQueryString
String getQueryString() -
getPathParameters
-
getUserProperties
-
getUserPrincipal
Principal getUserPrincipal() -
getOpenSessions
-
addMessageHandler
<T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) throws IllegalStateException Registers aMessageHandler
for partial incoming messages. Only oneMessageHandler
may 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 Thandler
- 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 aMessageHandler
for whole incoming messages. Only oneMessageHandler
may 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 Thandler
- 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
-