Jakarta EE 11.0.0 · jakarta.websocket.Session · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	addMessageHandler(MessageHandler the MessageHandler to be added. handler) Register to handle to incoming messages in this conversation.
public < type of message that the given handler is intended for. T> void	addMessageHandler(Class<T> type of the message processed by message handler to be registered. clazz, MessageHandler.Whole<T> whole message handler to be added. handler) Register to handle to incoming messages in this conversation.
public < type of message that the given handler is intended for. T> void	addMessageHandler(Class<T> type of the message processed by message handler to be registered. clazz, MessageHandler.Partial<T> partial message handler to be added. handler) Register to handle to incoming messages in this conversation.
public void	close() Redeclares java.io.Closeable.close. Close the current conversation with a normal status code and no reason phrase.
public void	close(CloseReason the reason for the closure. closeReason) Close the current conversation, giving a reason for the closure.
public RemoteEndpoint.Async	Returns: the remote endpoint. getAsyncRemote() Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send messages asynchronously to the peer.
public RemoteEndpoint.Basic	Returns: the remote endpoint. getBasicRemote() Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send messages synchronously to the peer.
public WebSocketContainer	Returns: the container. getContainer() Return the container that this session is part of.
public String	Returns: the unique identifier for this session instance. getId() Returns a string containing the unique identifier assigned to this session.
public int	Returns: the maximum binary message size that can be buffered. getMaxBinaryMessageBufferSize() The maximum length of incoming binary messages that this Session can buffer.
public long	Returns: the timeout in milliseconds. getMaxIdleTimeout() Return the number of milliseconds before this session will be closed by the container if it is inactive, i.e. no messages are either sent or received in that time.
public int	Returns: the maximum text message size that can be buffered. getMaxTextMessageBufferSize() The maximum length of incoming text messages that this Session can buffer.
public Set<MessageHandler>	Returns: the set of message handlers. getMessageHandlers() Return an unmodifiable copy of the set of MessageHandlers for this Session.
public List<Extension>	Returns: the negotiated extensions. getNegotiatedExtensions() Return the list of extensions currently in use for this conversation.
public String	Returns: the negotiated subprotocol, or the empty string if there isn't one. getNegotiatedSubprotocol() Return the sub protocol agreed during the websocket handshake for this conversation.
public Set<Session>	Returns: the set of sessions, open at the time of return. getOpenSessions() Return a copy of the Set of all the open web socket sessions that represent connections to the same endpoint to which this session represents a connection.
public Map<String, String>	Returns: the unmodifiable map of path parameters. The key of the map is the parameter name, the values in the map are the parameter values. getPathParameters() Return a map of the path parameter names and values used associated with the request this session was opened under.
public String	Returns: the protocol version. getProtocolVersion() Returns the version of the websocket protocol currently being used.
public String	Returns: the query string getQueryString() Return the query string associated with the request this session was opened under.
public Map<String, List<String>>	Returns: the unmodifiable map of the request parameters. getRequestParameterMap() Return the request parameters associated with the request this session was opened under.
public URI	Returns: the request URI. getRequestURI() Return the complete URI under which this session was opened, from protocol to query string (if present).
public Principal	Returns: the user principal. getUserPrincipal() Return the authenticated user for this Session or `null` if no user is authenticated for this session.
public Map<String, Object>	Returns: an editable Map of application data. getUserProperties() While the session is open, this method returns a Map that the developer may use to store application specific information relating to this session instance.
public boolean	Returns: whether the session is active. isOpen() Return true if and only if the underlying socket is open.
public boolean	Returns: whether its using a secure transport. isSecure() Return true if and only if the underlying socket is using a secure transport.
public void	removeMessageHandler(MessageHandler the handler to be removed. handler) Remove the given MessageHandler from the set belonging to this session.
public void	setMaxBinaryMessageBufferSize(int the maximum length. length) Sets the maximum length of incoming binary messages that this Session can buffer.
public void	setMaxIdleTimeout(long the number of milliseconds. milliseconds) Set the number of milliseconds before this session will be closed by the container if it is inactive, i.e. no messages are either sent or received in that time.
public void	setMaxTextMessageBufferSize(int the maximum length. length) Sets the maximum length of incoming text messages that this Session can buffer.

Method Detail

addMessageHandler back to summary

addMessageHandler	back to summary
public void addMessageHandler(MessageHandler handler) throws IllegalStateException Register to handle to incoming messages in this conversation. A maximum of one message handler per native websocket message type (text, binary, pong) may be added to each Session. I.e. a maximum of one message handler to handle incoming text messages a maximum of one message handler for handling incoming binary messages, and a maximum of one for handling incoming pong messages. For further details of which message handlers handle which of the native websocket message types please see `MessageHandler.Whole` and `MessageHandler.Partial`. Adding more than one of any one type will result in a runtime exception. This method is not safe to use unless you are providing an anonymous class derived directly from `jakarta.websocket.MessageHandler.Whole` or `jakarta.websocket.MessageHandler.Partial`. In all other cases (Lambda Expressions, more complex inheritance or generic type arrangements), one of the following methods have to be used: `addMessageHandler(Class, jakarta.websocket.MessageHandler.Whole)` or `addMessageHandler(Class, jakarta.websocket.MessageHandler.Partial)`. Once the container has identified a MessageHandler for a message, the MessageHandler is used for the entirety of the message irrespective of any subsequent changes to the MessageHandlers configured for the Session. Parameters handler:MessageHandler the MessageHandler to be added. Exceptions IllegalStateException: if there is already a MessageHandler registered for the same native websocket message type as this handler.

public void addMessageHandler(MessageHandler handler) throws IllegalStateException

Register to handle to incoming messages in this conversation. A maximum of one message handler per native websocket message type (text, binary, pong) may be added to each Session. I.e. a maximum of one message handler to handle incoming text messages a maximum of one message handler for handling incoming binary messages, and a maximum of one for handling incoming pong messages. For further details of which message handlers handle which of the native websocket message types please see MessageHandler.Whole and MessageHandler.Partial. Adding more than one of any one type will result in a runtime exception.

This method is not safe to use unless you are providing an anonymous class derived directly from jakarta.websocket.MessageHandler.Whole or jakarta.websocket.MessageHandler.Partial. In all other cases (Lambda Expressions, more complex inheritance or generic type arrangements), one of the following methods have to be used: addMessageHandler(Class, jakarta.websocket.MessageHandler.Whole) or addMessageHandler(Class, jakarta.websocket.MessageHandler.Partial).

Once the container has identified a MessageHandler for a message, the MessageHandler is used for the entirety of the message irrespective of any subsequent changes to the MessageHandlers configured for the Session.

Parameters

handler:MessageHandler: the MessageHandler to be added.

Exceptions

IllegalStateException:: if there is already a MessageHandler registered for the same native websocket message type as this handler.

addMessageHandler back to summary

addMessageHandler	back to summary
public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler) Register to handle to incoming messages in this conversation. A maximum of one message handler per native websocket message type (text, binary, pong) may be added to each Session. I.e. a maximum of one message handler to handle incoming text messages a maximum of one message handler for handling incoming binary messages, and a maximum of one for handling incoming pong messages. For further details of which message handlers handle which of the native websocket message types please see `MessageHandler.Whole` and `MessageHandler.Partial`. Adding more than one of any one type will result in a runtime exception. Once the container has identified a MessageHandler for a message, the MessageHandler is used for the entirety of the message irrespective of any subsequent changes to the MessageHandlers configured for the Session. Parameters <T> type of message that the given handler is intended for. clazz:Class<T> type of the message processed by message handler to be registered. handler:MessageHandler.Whole<T> whole message handler to be added. Exceptions IllegalStateException: if there is already a MessageHandler registered for the same native websocket message type as this handler. Since WebSocket 1.1

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

Parameters

<T>: type of message that the given handler is intended for.
clazz:Class<T>: type of the message processed by message handler to be registered.
handler:MessageHandler.Whole<T>: whole message handler to be added.

Exceptions

IllegalStateException:: if there is already a MessageHandler registered for the same native websocket message type as this handler.

Since

WebSocket 1.1

addMessageHandler back to summary

addMessageHandler	back to summary
public <T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) Register to handle to incoming messages in this conversation. A maximum of one message handler per native websocket message type (text, binary, pong) may be added to each Session. I.e. a maximum of one message handler to handle incoming text messages a maximum of one message handler for handling incoming binary messages, and a maximum of one for handling incoming pong messages. For further details of which message handlers handle which of the native websocket message types please see `MessageHandler.Whole` and `MessageHandler.Partial`. Adding more than one of any one type will result in a runtime exception. Once the container has identified a MessageHandler for a message, the MessageHandler is used for the entirety of the message irrespective of any subsequent changes to the MessageHandlers configured for the Session. Parameters <T> type of message that the given handler is intended for. clazz:Class<T> type of the message processed by message handler to be registered. handler:MessageHandler.Partial<T> partial message handler to be added. Exceptions IllegalStateException: if there is already a MessageHandler registered for the same native websocket message type as this handler. Since WebSocket 1.1

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

Parameters

<T>: type of message that the given handler is intended for.
clazz:Class<T>: type of the message processed by message handler to be registered.
handler:MessageHandler.Partial<T>: partial message handler to be added.

Exceptions

IllegalStateException:: if there is already a MessageHandler registered for the same native websocket message type as this handler.

Since

WebSocket 1.1

close	back to summary
public void close() throws IOException Redeclares java.io.Closeable.close. Close the current conversation with a normal status code and no reason phrase. Annotations @Override Exceptions IOException: if there was a connection error closing the connection.

public Interface Session

Method Summary

Method Detail