Tomcat 10.1.19 · jakarta.websocket.Session · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	addMessageHandler(MessageHandler The message handler for a incoming message handler) Registers a `MessageHandler` for incoming messages.
public < The type of message that the given handler is intended for T> void	addMessageHandler(Class<T> The Class that implements T clazz, MessageHandler.Partial<T> The message handler for a incoming message handler) Registers a `MessageHandler` for partial incoming messages.
public < The type of message that the given handler is intended for T> void	addMessageHandler(Class<T> The Class that implements T clazz, MessageHandler.Whole<T> The message handler for a incoming message handler) Registers a `MessageHandler` for whole incoming messages.
public void	close() Redeclares java.io.Closeable.close. Close the connection to the remote end point using the code `jakarta.websocket.CloseReason.CloseCodes#NORMAL_CLOSURE` and an empty reason phrase.
public void	close(CloseReason The reason the WebSocket session is being closed. closeReason) Close the connection to the remote end point using the specified code and reason phrase.
public RemoteEndpoint.Async	getAsyncRemote()
public RemoteEndpoint.Basic	getBasicRemote()
public WebSocketContainer	Returns: the container that created this session. getContainer() Get the container that created this session.
public String	Returns: A unique identifier for the session. getId() Provides a unique identifier for the session.
public int	Returns: The current maximum buffer size in bytes getMaxBinaryMessageBufferSize() Get the current maximum buffer size for binary messages.
public long	Returns: The current idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout. getMaxIdleTimeout() Get the idle timeout for this session.
public int	Returns: The maximum buffer size in characters. getMaxTextMessageBufferSize() Get the maximum buffer size for text messages.
public Set<MessageHandler>	getMessageHandlers()
public List<Extension>	getNegotiatedExtensions()
public String	getNegotiatedSubprotocol()
public Set<Session>	Returns: The set of currently open sessions for the local endpoint that this session is associated with. getOpenSessions() Obtain the set of open sessions associated with the same local endpoint as this session.
public Map<String, String>	getPathParameters()
public String	getProtocolVersion()
public String	getQueryString()
public Map<String, List<String>>	getRequestParameterMap()
public URI	getRequestURI()
public Principal	getUserPrincipal()
public Map<String, Object>	getUserProperties()
public boolean	isOpen()
public boolean	isSecure()
public void	removeMessageHandler(MessageHandler listener)
public void	setMaxBinaryMessageBufferSize(int The new maximum buffer size in bytes max) Set the current maximum buffer size for binary messages.
public void	setMaxIdleTimeout(long The new idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout. timeout) Set the idle timeout for this session.
public void	setMaxTextMessageBufferSize(int The new maximum buffer size in characters. max) Set the maximum buffer size for text messages.

Method Detail

addMessageHandler back to summary

addMessageHandler	back to summary
public void addMessageHandler(MessageHandler handler) throws IllegalStateException Registers a `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 `addMessageHandler(Class, jakarta.websocket.MessageHandler.Partial)` or `addMessageHandler(Class, jakarta.websocket.MessageHandler.Whole)`. Parameters handler:MessageHandler The message handler for a incoming message Exceptions IllegalStateException: If a message handler has already been registered for the associated message type

public void addMessageHandler(MessageHandler handler) throws IllegalStateException

Registers a 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 addMessageHandler(Class, jakarta.websocket.MessageHandler.Partial) or addMessageHandler(Class, jakarta.websocket.MessageHandler.Whole).

Parameters

handler:MessageHandler: The message handler for a incoming message

Exceptions

IllegalStateException:: If a message handler has already been registered for the associated message type

addMessageHandler back to summary

addMessageHandler	back to summary
public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) throws IllegalStateException Registers a `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). Parameters <T> The type of message that the given handler is intended for clazz:Class<T> The Class that implements T handler:MessageHandler.Partial<T> The message handler for a incoming message Exceptions IllegalStateException: If a message handler has already been registered for the associated message type Since WebSocket 1.1

public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) throws IllegalStateException

Registers a 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).

Parameters

<T>: The type of message that the given handler is intended for
clazz:Class<T>: The Class that implements T
handler:MessageHandler.Partial<T>: The message handler for a incoming message

Exceptions

IllegalStateException:: If a message handler has already been registered for the associated message type

Since

WebSocket 1.1

addMessageHandler back to summary

addMessageHandler	back to summary
public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler) throws IllegalStateException Registers a `MessageHandler` for whole incoming messages. Only one `MessageHandler` may be registered for each message type (text, binary, pong). Parameters <T> The type of message that the given handler is intended for clazz:Class<T> The Class that implements T handler:MessageHandler.Whole<T> The message handler for a incoming message Exceptions IllegalStateException: If a message handler has already been registered for the associated message type Since WebSocket 1.1

public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler) throws IllegalStateException

Registers a MessageHandler for whole incoming messages. Only one MessageHandler may be registered for each message type (text, binary, pong).

Parameters

<T>: The type of message that the given handler is intended for
clazz:Class<T>: The Class that implements T
handler:MessageHandler.Whole<T>: The message handler for a incoming message

Exceptions

IllegalStateException:: If a message handler has already been registered for the associated message type

Since

WebSocket 1.1

close back to summary

close	back to summary
public void close() throws IOException Redeclares java.io.Closeable.close. Close the connection to the remote end point using the code `jakarta.websocket.CloseReason.CloseCodes#NORMAL_CLOSURE` and an empty reason phrase. Annotations @Override Exceptions IOException: if an I/O error occurs while the WebSocket session is being closed.

public void close() throws IOException

Redeclares java.io.Closeable.close.

Close the connection to the remote end point using the code jakarta.websocket.CloseReason.CloseCodes#NORMAL_CLOSURE and an empty reason phrase.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs while the WebSocket session is being closed.

close	back to summary
public void close(CloseReason closeReason) throws IOException Close the connection to the remote end point using the specified code and reason phrase. Parameters closeReason:CloseReason The reason the WebSocket session is being closed. Exceptions IOException: if an I/O error occurs while the WebSocket session is being closed.

back to summary

public void close(CloseReason closeReason) throws IOException

Close the connection to the remote end point using the specified code and reason phrase.

Parameters

closeReason:CloseReason: The reason the WebSocket session is being closed.

Exceptions

IOException:: if an I/O error occurs while the WebSocket session is being closed.

getAsyncRemote	back to summary
public RemoteEndpoint.Async getAsyncRemote()

getBasicRemote	back to summary
public RemoteEndpoint.Basic getBasicRemote()

getContainer	back to summary
public WebSocketContainer getContainer() Get the container that created this session. Returns:WebSocketContainer the container that created this session.

getContainer

back to summary

public WebSocketContainer getContainer()

Get the container that created this session.

Returns:WebSocketContainer: the container that created this session.

getId	back to summary
public 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:String A unique identifier for the session.

getId

back to summary

public 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:String: A unique identifier for the session.

getMaxBinaryMessageBufferSize	back to summary
public int getMaxBinaryMessageBufferSize() Get the current maximum buffer size for binary messages. Returns:int The current maximum buffer size in bytes

getMaxBinaryMessageBufferSize

back to summary

public int getMaxBinaryMessageBufferSize()

Get the current maximum buffer size for binary messages.

Returns:int: The current maximum buffer size in bytes

getMaxIdleTimeout	back to summary
public long getMaxIdleTimeout() Get the idle timeout for this session. Returns:long The current idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout.

getMaxIdleTimeout

back to summary

public long getMaxIdleTimeout()

Get the idle timeout for this session.

Returns:long: The current idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout.

getMaxTextMessageBufferSize	back to summary
public int getMaxTextMessageBufferSize() Get the maximum buffer size for text messages. Returns:int The maximum buffer size in characters.

getMaxTextMessageBufferSize

back to summary

public int getMaxTextMessageBufferSize()

Get the maximum buffer size for text messages.

Returns:int: The maximum buffer size in characters.

getMessageHandlers	back to summary
public Set<MessageHandler> getMessageHandlers()

getNegotiatedExtensions	back to summary
public List<Extension> getNegotiatedExtensions()

getNegotiatedSubprotocol	back to summary
public String getNegotiatedSubprotocol()

getOpenSessions	back to summary
public Set<Session> getOpenSessions() Obtain the set of open sessions associated with the same local endpoint as this session. Returns:Set<Session> The set of currently open sessions for the local endpoint that this session is associated with.

getOpenSessions

back to summary

public Set<Session> getOpenSessions()

Obtain the set of open sessions associated with the same local endpoint as this session.

Returns:Set<Session>: The set of currently open sessions for the local endpoint that this session is associated with.

getPathParameters	back to summary
public Map<String, String> getPathParameters()

getProtocolVersion	back to summary
public String getProtocolVersion()

getQueryString	back to summary
public String getQueryString()

getRequestParameterMap	back to summary
public Map<String, List<String>> getRequestParameterMap()

getRequestURI	back to summary
public URI getRequestURI()

getUserPrincipal	back to summary
public Principal getUserPrincipal()

getUserProperties	back to summary
public Map<String, Object> getUserProperties()

isOpen	back to summary
public boolean isOpen()

isSecure	back to summary
public boolean isSecure()

removeMessageHandler	back to summary
public void removeMessageHandler(MessageHandler listener)

setMaxBinaryMessageBufferSize	back to summary
public void setMaxBinaryMessageBufferSize(int max) Set the current maximum buffer size for binary messages. Parameters max:int The new maximum buffer size in bytes

setMaxBinaryMessageBufferSize

back to summary

public void setMaxBinaryMessageBufferSize(int max)

Set the current maximum buffer size for binary messages.

Parameters

max:int: The new maximum buffer size in bytes

setMaxIdleTimeout	back to summary
public void setMaxIdleTimeout(long timeout) Set the idle timeout for this session. Parameters timeout:long The new idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout.

setMaxIdleTimeout

back to summary

public void setMaxIdleTimeout(long timeout)

Set the idle timeout for this session.

Parameters

timeout:long: The new idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout.

setMaxTextMessageBufferSize	back to summary
public void setMaxTextMessageBufferSize(int max) Set the maximum buffer size for text messages. Parameters max:int The new maximum buffer size in characters.

setMaxTextMessageBufferSize

back to summary

public void setMaxTextMessageBufferSize(int max)

Set the maximum buffer size for text messages.

Parameters

max:int: The new maximum buffer size in characters.

public Interface Session

Method Summary

Method Detail