Index (WebSocket 2.1 API Documentation - Apache Tomcat 10.1.54)

# Index

A B C D E F G H I J M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## A

addEndpoint(ServerEndpointConfig) - Method in interface jakarta.websocket.server.ServerContainer
addEndpoint(Class) - Method in interface jakarta.websocket.server.ServerContainer
addMessageHandler(MessageHandler) - Method in interface jakarta.websocket.Session
  Registers a `MessageHandler` for incoming messages.
addMessageHandler(Class, MessageHandler.Partial) - Method in interface jakarta.websocket.Session
  Registers a `MessageHandler` for partial incoming messages.
addMessageHandler(Class, MessageHandler.Whole) - Method in interface jakarta.websocket.Session
  Registers a `MessageHandler` for whole incoming messages.
afterResponse(HandshakeResponse) - Method in class jakarta.websocket.ClientEndpointConfig.Configurator
  Provides the client with a mechanism to inspect the handshake response that is returned from the server.

## B

beforeRequest(Map) - Method in class jakarta.websocket.ClientEndpointConfig.Configurator
  Provides the client with a mechanism to inspect and/or modify the headers that are sent to the server to start the WebSocket handshake.
build() - Method in class jakarta.websocket.ClientEndpointConfig.Builder
build() - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder

## C

CANNOT_ACCEPT - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes
checkOrigin(String) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
ClientEndpoint - Annotation Type in jakarta.websocket
ClientEndpointConfig - Interface in jakarta.websocket
ClientEndpointConfig.Builder - Class in jakarta.websocket
ClientEndpointConfig.Configurator - Class in jakarta.websocket
close() - Method in interface jakarta.websocket.Session
  Close the connection to the remote end point using the code `CloseReason.CloseCodes.NORMAL_CLOSURE` and an empty reason phrase.
close(CloseReason) - Method in interface jakarta.websocket.Session
  Close the connection to the remote end point using the specified code and reason phrase.
CLOSED_ABNORMALLY - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes
CloseReason - Class in jakarta.websocket
CloseReason(CloseReason.CloseCode, String) - Constructor for class jakarta.websocket.CloseReason
CloseReason.CloseCode - Interface in jakarta.websocket
CloseReason.CloseCodes - Enum in jakarta.websocket
configurator() - Element in annotation type jakarta.websocket.ClientEndpoint
configurator() - Element in annotation type jakarta.websocket.server.ServerEndpoint
configurator(ClientEndpointConfig.Configurator) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
configurator(ServerEndpointConfig.Configurator) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
Configurator() - Constructor for class jakarta.websocket.ClientEndpointConfig.Configurator
Configurator() - Constructor for class jakarta.websocket.server.ServerEndpointConfig.Configurator
connectToServer(Endpoint, ClientEndpointConfig, URI) - Method in interface jakarta.websocket.WebSocketContainer
  Creates a new connection to the WebSocket.
connectToServer(Class, URI) - Method in interface jakarta.websocket.WebSocketContainer
connectToServer(Class, ClientEndpointConfig, URI) - Method in interface jakarta.websocket.WebSocketContainer
  Creates a new connection to the WebSocket.
connectToServer(Object, URI) - Method in interface jakarta.websocket.WebSocketContainer
ContainerProvider - Class in jakarta.websocket
  Use the `ServiceLoader` mechanism to provide instances of the WebSocket client container.
ContainerProvider() - Constructor for class jakarta.websocket.ContainerProvider
create() - Static method in class jakarta.websocket.ClientEndpointConfig.Builder
create(Class, String) - Static method in class jakarta.websocket.server.ServerEndpointConfig.Builder

## D

decode(InputStream) - Method in interface jakarta.websocket.Decoder.BinaryStream
decode(Reader) - Method in interface jakarta.websocket.Decoder.TextStream
decode(String) - Method in interface jakarta.websocket.Decoder.Text
decode(ByteBuffer) - Method in interface jakarta.websocket.Decoder.Binary
DecodeException - Exception Class in jakarta.websocket
DecodeException(String, String) - Constructor for exception class jakarta.websocket.DecodeException
DecodeException(String, String, Throwable) - Constructor for exception class jakarta.websocket.DecodeException
DecodeException(ByteBuffer, String) - Constructor for exception class jakarta.websocket.DecodeException
DecodeException(ByteBuffer, String, Throwable) - Constructor for exception class jakarta.websocket.DecodeException
Decoder - Interface in jakarta.websocket
Decoder.Binary<T> - Interface in jakarta.websocket
Decoder.BinaryStream<T> - Interface in jakarta.websocket
Decoder.Text<T> - Interface in jakarta.websocket
Decoder.TextStream<T> - Interface in jakarta.websocket
decoders() - Element in annotation type jakarta.websocket.ClientEndpoint
decoders() - Element in annotation type jakarta.websocket.server.ServerEndpoint
decoders(List) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
decoders(List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
DeploymentException - Exception Class in jakarta.websocket
DeploymentException(String) - Constructor for exception class jakarta.websocket.DeploymentException
DeploymentException(String, Throwable) - Constructor for exception class jakarta.websocket.DeploymentException
destroy() - Method in interface jakarta.websocket.Decoder
  Destroy the decoder.
destroy() - Method in interface jakarta.websocket.Encoder
  Destroy the decoder.

## E

encode(T) - Method in interface jakarta.websocket.Encoder.Binary
encode(T) - Method in interface jakarta.websocket.Encoder.Text
encode(T, OutputStream) - Method in interface jakarta.websocket.Encoder.BinaryStream
encode(T, Writer) - Method in interface jakarta.websocket.Encoder.TextStream
EncodeException - Exception Class in jakarta.websocket
EncodeException(Object, String) - Constructor for exception class jakarta.websocket.EncodeException
EncodeException(Object, String, Throwable) - Constructor for exception class jakarta.websocket.EncodeException
Encoder - Interface in jakarta.websocket
Encoder.Binary<T> - Interface in jakarta.websocket
Encoder.BinaryStream<T> - Interface in jakarta.websocket
Encoder.Text<T> - Interface in jakarta.websocket
Encoder.TextStream<T> - Interface in jakarta.websocket
encoders() - Element in annotation type jakarta.websocket.ClientEndpoint
encoders() - Element in annotation type jakarta.websocket.server.ServerEndpoint
encoders(List) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
encoders(List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
Endpoint - Class in jakarta.websocket
Endpoint() - Constructor for class jakarta.websocket.Endpoint
EndpointConfig - Interface in jakarta.websocket
Extension - Interface in jakarta.websocket
Extension.Parameter - Interface in jakarta.websocket
extensions(List) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
extensions(List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder

## F

flushBatch() - Method in interface jakarta.websocket.RemoteEndpoint
  Flush any currently batched messages to the remote endpoint.

## G

getAnnotatedEndpointClasses(Set) - Method in interface jakarta.websocket.server.ServerApplicationConfig
  Enables applications to filter the discovered classes annotated with `ServerEndpoint`.
getApplicationData() - Method in interface jakarta.websocket.PongMessage
  Get the payload of the Pong message.
getAsyncRemote() - Method in interface jakarta.websocket.Session
getBasicRemote() - Method in interface jakarta.websocket.Session
getBatchingAllowed() - Method in interface jakarta.websocket.RemoteEndpoint
  Obtains the current batching status of the endpoint.
getBytes() - Method in exception class jakarta.websocket.DecodeException
getCloseCode() - Method in class jakarta.websocket.CloseReason
getCloseCode(int) - Static method in enum jakarta.websocket.CloseReason.CloseCodes
getCode() - Method in interface jakarta.websocket.CloseReason.CloseCode
getCode() - Method in enum jakarta.websocket.CloseReason.CloseCodes
getConfigurator() - Method in interface jakarta.websocket.ClientEndpointConfig
getConfigurator() - Method in interface jakarta.websocket.server.ServerEndpointConfig
getContainer() - Method in class jakarta.websocket.ContainerProvider
getContainer() - Method in interface jakarta.websocket.Session
  Get the container that created this session.
getContainerDefaultConfigurator() - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
  Return the platform default configurator.
getDecoders() - Method in interface jakarta.websocket.EndpointConfig
getDefaultAsyncSendTimeout() - Method in interface jakarta.websocket.WebSocketContainer
  Get the default timeout for sending a message asynchronously.
getDefaultMaxBinaryMessageBufferSize() - Method in interface jakarta.websocket.WebSocketContainer
  Get the default maximum buffer size for binary messages.
getDefaultMaxSessionIdleTimeout() - Method in interface jakarta.websocket.WebSocketContainer
  Get the current default session idle timeout.
getDefaultMaxTextMessageBufferSize() - Method in interface jakarta.websocket.WebSocketContainer
  Get the default maximum buffer size for text messages.
getEncoders() - Method in interface jakarta.websocket.EndpointConfig
getEndpointClass() - Method in interface jakarta.websocket.server.ServerEndpointConfig
getEndpointConfigs(Set) - Method in interface jakarta.websocket.server.ServerApplicationConfig
  Enables applications to filter the discovered implementations of `ServerEndpointConfig`.
getEndpointInstance(Class) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
getException() - Method in class jakarta.websocket.SendResult
getExtensions() - Method in interface jakarta.websocket.ClientEndpointConfig
getExtensions() - Method in interface jakarta.websocket.server.ServerEndpointConfig
getHeaders() - Method in interface jakarta.websocket.HandshakeResponse
getHeaders() - Method in interface jakarta.websocket.server.HandshakeRequest
getHttpSession() - Method in interface jakarta.websocket.server.HandshakeRequest
  Get the HTTP Session object associated with this request.
getId() - Method in interface jakarta.websocket.Session
  Provides a unique identifier for the session.
getInstalledExtensions() - Method in interface jakarta.websocket.WebSocketContainer
  Get the installed extensions.
getMaxBinaryMessageBufferSize() - Method in interface jakarta.websocket.Session
  Get the current maximum buffer size for binary messages.
getMaxIdleTimeout() - Method in interface jakarta.websocket.Session
  Get the idle timeout for this session.
getMaxTextMessageBufferSize() - Method in interface jakarta.websocket.Session
  Get the maximum buffer size for text messages.
getMessageHandlers() - Method in interface jakarta.websocket.Session
getName() - Method in interface jakarta.websocket.Extension
getName() - Method in interface jakarta.websocket.Extension.Parameter
getNegotiatedExtensions() - Method in interface jakarta.websocket.Session
getNegotiatedExtensions(List, List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
getNegotiatedSubprotocol() - Method in interface jakarta.websocket.Session
getNegotiatedSubprotocol(List, List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
getObject() - Method in exception class jakarta.websocket.EncodeException
getOpenSessions() - Method in interface jakarta.websocket.Session
  Obtain the set of open sessions associated with the same local endpoint as this session.
getParameterMap() - Method in interface jakarta.websocket.server.HandshakeRequest
getParameters() - Method in interface jakarta.websocket.Extension
getPath() - Method in interface jakarta.websocket.server.ServerEndpointConfig
  Returns the path at which this WebSocket server endpoint has been registered.
getPathParameters() - Method in interface jakarta.websocket.Session
getPreferredSubprotocols() - Method in interface jakarta.websocket.ClientEndpointConfig
getProtocolVersion() - Method in interface jakarta.websocket.Session
getQueryString() - Method in interface jakarta.websocket.server.HandshakeRequest
getQueryString() - Method in interface jakarta.websocket.Session
getReasonPhrase() - Method in class jakarta.websocket.CloseReason
getRequestParameterMap() - Method in interface jakarta.websocket.Session
getRequestURI() - Method in interface jakarta.websocket.server.HandshakeRequest
getRequestURI() - Method in interface jakarta.websocket.Session
getSendStream() - Method in interface jakarta.websocket.RemoteEndpoint.Basic
getSendTimeout() - Method in interface jakarta.websocket.RemoteEndpoint.Async
  Obtain the timeout (in milliseconds) for sending a message asynchronously.
getSendWriter() - Method in interface jakarta.websocket.RemoteEndpoint.Basic
getSession() - Method in exception class jakarta.websocket.SessionException
getSSLContext() - Method in interface jakarta.websocket.ClientEndpointConfig
getSubprotocols() - Method in interface jakarta.websocket.server.ServerEndpointConfig
getText() - Method in exception class jakarta.websocket.DecodeException
getUserPrincipal() - Method in interface jakarta.websocket.server.HandshakeRequest
getUserPrincipal() - Method in interface jakarta.websocket.Session
getUserProperties() - Method in interface jakarta.websocket.EndpointConfig
getUserProperties() - Method in interface jakarta.websocket.Session
getValue() - Method in interface jakarta.websocket.Extension.Parameter
getWebSocketContainer() - Static method in class jakarta.websocket.ContainerProvider
  Create a new container used to create outgoing WebSocket connections.
GOING_AWAY - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes

## H

HandshakeRequest - Interface in jakarta.websocket.server
  Represents the HTTP request that asked to be upgraded to WebSocket.
HandshakeResponse - Interface in jakarta.websocket

## I

init(EndpointConfig) - Method in interface jakarta.websocket.Decoder
  Initialise the decoder.
init(EndpointConfig) - Method in interface jakarta.websocket.Encoder
  Initialise the encoder.
isOK() - Method in class jakarta.websocket.SendResult
isOpen() - Method in interface jakarta.websocket.Session
isSecure() - Method in interface jakarta.websocket.Session
isUserInRole(String) - Method in interface jakarta.websocket.server.HandshakeRequest

## J

jakarta.websocket - package jakarta.websocket
jakarta.websocket.server - package jakarta.websocket.server

## M

maxMessageSize() - Element in annotation type jakarta.websocket.OnMessage
MessageHandler - Interface in jakarta.websocket
MessageHandler.Partial<T> - Interface in jakarta.websocket
MessageHandler.Whole<T> - Interface in jakarta.websocket
modifyHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator

## N

NO_EXTENSION - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes
NO_STATUS_CODE - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes
NORMAL_CLOSURE - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes
NOT_CONSISTENT - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes

## O

onClose(Session, CloseReason) - Method in class jakarta.websocket.Endpoint
  Event that is triggered when a session has closed.
OnClose - Annotation Type in jakarta.websocket
onError(Session, Throwable) - Method in class jakarta.websocket.Endpoint
  Event that is triggered when a protocol error occurs.
OnError - Annotation Type in jakarta.websocket
onMessage(T) - Method in interface jakarta.websocket.MessageHandler.Whole
  Called when a whole message is available to be processed.
onMessage(T, boolean) - Method in interface jakarta.websocket.MessageHandler.Partial
  Called when part of a message is available to be processed.
OnMessage - Annotation Type in jakarta.websocket
onOpen(Session, EndpointConfig) - Method in class jakarta.websocket.Endpoint
  Event that is triggered when a new session starts.
OnOpen - Annotation Type in jakarta.websocket
onResult(SendResult) - Method in interface jakarta.websocket.SendHandler

## P

PathParam - Annotation Type in jakarta.websocket.server
  Used to annotate method parameters on POJO endpoints the the `ServerEndpoint` has been defined with a `ServerEndpoint.value()` that uses a URI template.
PongMessage - Interface in jakarta.websocket
  Represents a WebSocket Pong message and used by message handlers to enable applications to process the response to any Pings they send.
preferredSubprotocols(List) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
PROTOCOL_ERROR - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes

## R

RemoteEndpoint - Interface in jakarta.websocket
RemoteEndpoint.Async - Interface in jakarta.websocket
RemoteEndpoint.Basic - Interface in jakarta.websocket
removeMessageHandler(MessageHandler) - Method in interface jakarta.websocket.Session
RESERVED - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes

## S

SEC_WEBSOCKET_ACCEPT - Static variable in interface jakarta.websocket.HandshakeResponse
  Name of the WebSocket accept HTTP header.
SEC_WEBSOCKET_EXTENSIONS - Static variable in interface jakarta.websocket.server.HandshakeRequest
SEC_WEBSOCKET_KEY - Static variable in interface jakarta.websocket.server.HandshakeRequest
SEC_WEBSOCKET_PROTOCOL - Static variable in interface jakarta.websocket.server.HandshakeRequest
SEC_WEBSOCKET_VERSION - Static variable in interface jakarta.websocket.server.HandshakeRequest
sendBinary(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint.Async
  Send the message asynchronously, using the Future to signal to the client when the message has been sent.
sendBinary(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
  Send the message, blocking until the message is sent.
sendBinary(ByteBuffer, boolean) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
  Sends part of a binary message to the remote endpoint.
sendBinary(ByteBuffer, SendHandler) - Method in interface jakarta.websocket.RemoteEndpoint.Async
  Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.
SendHandler - Interface in jakarta.websocket
sendObject(Object) - Method in interface jakarta.websocket.RemoteEndpoint.Async
  Encodes object as a message and sends it asynchronously, using the Future to signal to the client when the message has been sent.
sendObject(Object) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
  Encodes object as a message and sends it to the remote endpoint.
sendObject(Object, SendHandler) - Method in interface jakarta.websocket.RemoteEndpoint.Async
  Encodes object as a message and sends it asynchronously, using the SendHandler to signal to the client when the message has been sent.
sendPing(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint
  Send a ping message blocking until the message has been sent.
sendPong(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint
  Send a pong message blocking until the message has been sent.
SendResult - Class in jakarta.websocket
SendResult() - Constructor for class jakarta.websocket.SendResult
SendResult(Throwable) - Constructor for class jakarta.websocket.SendResult
sendText(String) - Method in interface jakarta.websocket.RemoteEndpoint.Async
  Send the message asynchronously, using the Future to signal to the client when the message has been sent.
sendText(String) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
  Send the message, blocking until the message is sent.
sendText(String, boolean) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
  Sends part of a text message to the remote endpoint.
sendText(String, SendHandler) - Method in interface jakarta.websocket.RemoteEndpoint.Async
  Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.
ServerApplicationConfig - Interface in jakarta.websocket.server
  Applications may provide an implementation of this interface to filter the discovered WebSocket endpoints that are deployed.
ServerContainer - Interface in jakarta.websocket.server
  Provides the ability to deploy endpoints programmatically.
ServerEndpoint - Annotation Type in jakarta.websocket.server
ServerEndpointConfig - Interface in jakarta.websocket.server
  Provides configuration information for WebSocket endpoints published to a server.
ServerEndpointConfig.Builder - Class in jakarta.websocket.server
ServerEndpointConfig.Configurator - Class in jakarta.websocket.server
SERVICE_RESTART - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes
Session - Interface in jakarta.websocket
SessionException - Exception Class in jakarta.websocket
SessionException(String, Throwable, Session) - Constructor for exception class jakarta.websocket.SessionException
setAsyncSendTimeout(long) - Method in interface jakarta.websocket.WebSocketContainer
  Set the default timeout for sending a message asynchronously.
setBatchingAllowed(boolean) - Method in interface jakarta.websocket.RemoteEndpoint
  Enable or disable the batching of outgoing messages for this endpoint.
setDefaultMaxBinaryMessageBufferSize(int) - Method in interface jakarta.websocket.WebSocketContainer
  Set the default maximum buffer size for binary messages.
setDefaultMaxSessionIdleTimeout(long) - Method in interface jakarta.websocket.WebSocketContainer
  Set the default session idle timeout.
setDefaultMaxTextMessageBufferSize(int) - Method in interface jakarta.websocket.WebSocketContainer
  Set the default maximum buffer size for text messages.
setMaxBinaryMessageBufferSize(int) - Method in interface jakarta.websocket.Session
  Set the current maximum buffer size for binary messages.
setMaxIdleTimeout(long) - Method in interface jakarta.websocket.Session
  Set the idle timeout for this session.
setMaxTextMessageBufferSize(int) - Method in interface jakarta.websocket.Session
  Set the maximum buffer size for text messages.
setSendTimeout(long) - Method in interface jakarta.websocket.RemoteEndpoint.Async
  Set the timeout (in milliseconds) for sending a message asynchronously.
sslContext(SSLContext) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
subprotocols() - Element in annotation type jakarta.websocket.ClientEndpoint
subprotocols() - Element in annotation type jakarta.websocket.server.ServerEndpoint
subprotocols(List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder

## T

TLS_HANDSHAKE_FAILURE - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes
TOO_BIG - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes
toString() - Method in class jakarta.websocket.CloseReason
TRY_AGAIN_LATER - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes

## U

UNEXPECTED_CONDITION - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes
upgradeHttpToWebSocket(Object, Object, ServerEndpointConfig, Map) - Method in interface jakarta.websocket.server.ServerContainer
  Upgrade the HTTP connection represented by the `HttpServletRequest` and `HttpServletResponse` to the WebSocket protocol and establish a WebSocket connection as per the provided `ServerEndpointConfig`.

## V

value() - Element in annotation type jakarta.websocket.server.PathParam
value() - Element in annotation type jakarta.websocket.server.ServerEndpoint
  URI or URI-template that the annotated class should be mapped to.
valueOf(String) - Static method in enum jakarta.websocket.CloseReason.CloseCodes
  Returns the enum constant of this type with the specified name.
values() - Static method in enum jakarta.websocket.CloseReason.CloseCodes
  Returns an array containing the constants of this enum type, in the order they are declared.
VIOLATED_POLICY - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes

## W

WebSocketContainer - Interface in jakarta.websocket
willDecode(String) - Method in interface jakarta.websocket.Decoder.Text
willDecode(ByteBuffer) - Method in interface jakarta.websocket.Decoder.Binary

A B C D E F G H I J M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form