Index (WebSocket 2.1 API Documentation

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: Deploys the endpoint configured by the given ServerEndpointConfig.
addEndpoint(Class) - Method in interface jakarta.websocket.server.ServerContainer: Deploys the given endpoint class.
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: Builds and returns a ClientEndpointConfig with the configured settings.
build() - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder: Builds and returns a ServerEndpointConfig with the configured settings.

C

CANNOT_ACCEPT - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates that the endpoint is terminating the connection because it has received a type of data it cannot accept.
checkOrigin(String) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator: Checks whether the given Origin header value is acceptable.
ClientEndpoint - Annotation Type in jakarta.websocket: Annotates a class as a WebSocket client endpoint.
ClientEndpointConfig - Interface in jakarta.websocket: Provides configuration information for WebSocket client endpoints.
ClientEndpointConfig.Builder - Class in jakarta.websocket: Builder for creating ClientEndpointConfig instances.
ClientEndpointConfig.Configurator - Class in jakarta.websocket: Provides a mechanism to customize the WebSocket handshake for client endpoints.
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: Indicates that the connection was closed abnormally without receiving a close frame.
CloseReason - Class in jakarta.websocket: Represents the reason for the closure of a WebSocket connection, including a close code and an optional reason phrase.
CloseReason(CloseReason.CloseCode, String) - Constructor for class jakarta.websocket.CloseReason: Creates a new CloseReason with the given close code and reason phrase.
CloseReason.CloseCode - Interface in jakarta.websocket: Represents a WebSocket close code.
CloseReason.CloseCodes - Enum in jakarta.websocket: Standard WebSocket close codes as defined by RFC 6455 and related specifications.
configurator() - Element in annotation type jakarta.websocket.ClientEndpoint: The configurator class used to customize the WebSocket handshake.
configurator() - Element in annotation type jakarta.websocket.server.ServerEndpoint: The configurator class used to customize the WebSocket handshake.
configurator(ClientEndpointConfig.Configurator) - Method in class jakarta.websocket.ClientEndpointConfig.Builder: Sets the configurator to use for the WebSocket handshake.
configurator(ServerEndpointConfig.Configurator) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder: Sets the configurator to use for the WebSocket handshake.
Configurator() - Constructor for class jakarta.websocket.ClientEndpointConfig.Configurator: Creates a new instance of the default Configurator.
Configurator() - Constructor for class jakarta.websocket.server.ServerEndpointConfig.Configurator: Creates a new instance of the 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: Creates a new connection to the WebSocket server endpoint.
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: Creates a new connection to the WebSocket server endpoint.
ContainerProvider - Class in jakarta.websocket: Use the ServiceLoader mechanism to provide instances of the WebSocket client container.
ContainerProvider() - Constructor for class jakarta.websocket.ContainerProvider: Creates a new ContainerProvider instance.
create() - Static method in class jakarta.websocket.ClientEndpointConfig.Builder: Creates a new ClientEndpointConfig.Builder instance for building a ClientEndpointConfig.
create(Class, String) - Static method in class jakarta.websocket.server.ServerEndpointConfig.Builder: Creates a new builder for the given endpoint class and path.

D

decode(InputStream) - Method in interface jakarta.websocket.Decoder.BinaryStream: Decodes the binary data from the input stream into an object.
decode(Reader) - Method in interface jakarta.websocket.Decoder.TextStream: Decodes the text data from the reader into an object.
decode(String) - Method in interface jakarta.websocket.Decoder.Text: Decodes the text data into an object.
decode(ByteBuffer) - Method in interface jakarta.websocket.Decoder.Binary: Decodes the binary data into an object.
DecodeException - Exception Class in jakarta.websocket: Exception thrown when a decoder fails to decode a WebSocket message.
DecodeException(String, String) - Constructor for exception class jakarta.websocket.DecodeException: Creates a DecodeException for text data with the specified detail message.
DecodeException(String, String, Throwable) - Constructor for exception class jakarta.websocket.DecodeException: Creates a DecodeException for text data with the specified detail message and cause.
DecodeException(ByteBuffer, String) - Constructor for exception class jakarta.websocket.DecodeException: Creates a DecodeException for binary data with the specified detail message.
DecodeException(ByteBuffer, String, Throwable) - Constructor for exception class jakarta.websocket.DecodeException: Creates a DecodeException for binary data with the specified detail message and cause.
Decoder - Interface in jakarta.websocket: Base interface for WebSocket message decoders.
Decoder.Binary<T> - Interface in jakarta.websocket: A decoder that decodes entire binary WebSocket messages into an object of type T.
Decoder.BinaryStream<T> - Interface in jakarta.websocket: A decoder that decodes entire binary WebSocket messages from an input stream into an object of type T.
Decoder.Text<T> - Interface in jakarta.websocket: A decoder that decodes entire text WebSocket messages into an object of type T.
Decoder.TextStream<T> - Interface in jakarta.websocket: A decoder that decodes entire text WebSocket messages from a reader into an object of type T.
decoders() - Element in annotation type jakarta.websocket.ClientEndpoint: The decoder classes that this client endpoint uses.
decoders() - Element in annotation type jakarta.websocket.server.ServerEndpoint: The decoder classes that this server endpoint uses.
decoders(List) - Method in class jakarta.websocket.ClientEndpointConfig.Builder: Sets the list of decoder classes to use for the WebSocket connection.
decoders(List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder: Sets the list of decoder classes to use for the WebSocket connection.
DeploymentException - Exception Class in jakarta.websocket: Exception thrown when a WebSocket endpoint cannot be deployed due to a configuration error.
DeploymentException(String) - Constructor for exception class jakarta.websocket.DeploymentException: Creates a DeploymentException with the specified detail message.
DeploymentException(String, Throwable) - Constructor for exception class jakarta.websocket.DeploymentException: Creates a DeploymentException with the specified detail message and cause.
destroy() - Method in interface jakarta.websocket.Decoder: Destroy the decoder.
destroy() - Method in interface jakarta.websocket.Encoder: Destroy the encoder.

E

encode(T) - Method in interface jakarta.websocket.Encoder.Binary: Encodes the given object into a ByteBuffer.
encode(T) - Method in interface jakarta.websocket.Encoder.Text: Encodes the given object into a text string.
encode(T, OutputStream) - Method in interface jakarta.websocket.Encoder.BinaryStream: Encodes the given object and writes the result to the output stream.
encode(T, Writer) - Method in interface jakarta.websocket.Encoder.TextStream: Encodes the given object and writes the result to the writer.
EncodeException - Exception Class in jakarta.websocket: Exception thrown when an encoder fails to encode an object as a WebSocket message.
EncodeException(Object, String) - Constructor for exception class jakarta.websocket.EncodeException: Creates an EncodeException with the specified object and detail message.
EncodeException(Object, String, Throwable) - Constructor for exception class jakarta.websocket.EncodeException: Creates an EncodeException with the specified object, detail message, and cause.
Encoder - Interface in jakarta.websocket: Base interface for WebSocket message encoders.
Encoder.Binary<T> - Interface in jakarta.websocket: An encoder that encodes an object of type T into a binary WebSocket message.
Encoder.BinaryStream<T> - Interface in jakarta.websocket: An encoder that encodes an object of type T into a binary WebSocket message written to an OutputStream.
Encoder.Text<T> - Interface in jakarta.websocket: An encoder that encodes an object of type T into a text WebSocket message.
Encoder.TextStream<T> - Interface in jakarta.websocket: An encoder that encodes an object of type T into a text WebSocket message written to a Writer.
encoders() - Element in annotation type jakarta.websocket.ClientEndpoint: The encoder classes that this client endpoint uses.
encoders() - Element in annotation type jakarta.websocket.server.ServerEndpoint: The encoder classes that this server endpoint uses.
encoders(List) - Method in class jakarta.websocket.ClientEndpointConfig.Builder: Sets the list of encoder classes to use for the WebSocket connection.
encoders(List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder: Sets the list of encoder classes to use for the WebSocket connection.
Endpoint - Class in jakarta.websocket: Base class for programmatic WebSocket endpoints.
Endpoint() - Constructor for class jakarta.websocket.Endpoint: Creates a new Endpoint instance.
EndpointConfig - Interface in jakarta.websocket: Provides configuration information for a WebSocket endpoint, including encoders, decoders, and user properties.
Extension - Interface in jakarta.websocket: Represents a WebSocket extension that can be negotiated during the handshake.
Extension.Parameter - Interface in jakarta.websocket: Represents a parameter of a WebSocket extension.
extensions(List) - Method in class jakarta.websocket.ClientEndpointConfig.Builder: Sets the list of extensions to use for the WebSocket connection.
extensions(List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder: Sets the list of extensions supported by the endpoint.

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: Returns the asynchronous remote endpoint for this session, used for non-blocking message sending.
getBasicRemote() - Method in interface jakarta.websocket.Session: Returns the synchronous remote endpoint for this session, used for blocking message sending.
getBatchingAllowed() - Method in interface jakarta.websocket.RemoteEndpoint: Obtains the current batching status of the endpoint.
getBytes() - Method in exception class jakarta.websocket.DecodeException: Returns the binary data that could not be decoded.
getCloseCode() - Method in class jakarta.websocket.CloseReason: Returns the close code.
getCloseCode(int) - Static method in enum jakarta.websocket.CloseReason.CloseCodes: Returns the CloseReason.CloseCode for the given numeric code value.
getCode() - Method in interface jakarta.websocket.CloseReason.CloseCode: Returns the numeric value of the close code.
getCode() - Method in enum jakarta.websocket.CloseReason.CloseCodes: Returns the numeric value of this close code.
getConfigurator() - Method in interface jakarta.websocket.ClientEndpointConfig: Returns the configurator used to customize the WebSocket handshake.
getConfigurator() - Method in interface jakarta.websocket.server.ServerEndpointConfig: Returns the configurator for this server endpoint.
getContainer() - Method in class jakarta.websocket.ContainerProvider: Returns the WebSocket container provided by this provider.
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: Returns the list of decoder classes for this endpoint.
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: Returns the list of encoder classes for this endpoint.
getEndpointClass() - Method in interface jakarta.websocket.server.ServerEndpointConfig: Returns the class of the endpoint.
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: Creates a new instance of the endpoint class.
getException() - Method in class jakarta.websocket.SendResult: Returns the exception that occurred during the send operation, or null if the operation was successful.
getExtensions() - Method in interface jakarta.websocket.ClientEndpointConfig: Returns the list of extensions that this client endpoint supports.
getExtensions() - Method in interface jakarta.websocket.server.ServerEndpointConfig: Returns the list of extensions supported by this endpoint.
getHeaders() - Method in interface jakarta.websocket.HandshakeResponse: Returns the HTTP headers from the handshake response.
getHeaders() - Method in interface jakarta.websocket.server.HandshakeRequest: Returns the HTTP headers from the handshake request.
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: Returns the set of message handlers currently registered on this session.
getName() - Method in interface jakarta.websocket.Extension: Returns the name of this extension.
getName() - Method in interface jakarta.websocket.Extension.Parameter: Returns the name of this parameter.
getNegotiatedExtensions() - Method in interface jakarta.websocket.Session: Returns the list of extensions negotiated for this session.
getNegotiatedExtensions(List, List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator: Determines the extensions to use for the WebSocket connection by comparing the installed and requested extensions.
getNegotiatedSubprotocol() - Method in interface jakarta.websocket.Session: Returns the sub-protocol negotiated for this session, or null if no sub-protocol was negotiated.
getNegotiatedSubprotocol(List, List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator: Determines the sub-protocol to use for the WebSocket connection by comparing the supported and requested sub-protocols.
getObject() - Method in exception class jakarta.websocket.EncodeException: Returns the object that could not be encoded.
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: Returns the query parameters from the handshake request.
getParameters() - Method in interface jakarta.websocket.Extension: Returns the parameters associated with this 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: Returns the path parameters extracted from the request URI using the endpoint's URI template.
getPreferredSubprotocols() - Method in interface jakarta.websocket.ClientEndpointConfig: Returns the list of sub-protocols that this client endpoint supports, in order of preference.
getProtocolVersion() - Method in interface jakarta.websocket.Session: Returns the version of the WebSocket protocol in use for this session.
getQueryString() - Method in interface jakarta.websocket.server.HandshakeRequest: Returns the query string from the handshake request.
getQueryString() - Method in interface jakarta.websocket.Session: Returns the query string from the request that initiated this WebSocket session.
getReasonPhrase() - Method in class jakarta.websocket.CloseReason: Returns the reason phrase.
getRequestParameterMap() - Method in interface jakarta.websocket.Session: Returns the query parameters from the request that initiated this WebSocket session.
getRequestURI() - Method in interface jakarta.websocket.server.HandshakeRequest: Returns the URI of the handshake request.
getRequestURI() - Method in interface jakarta.websocket.Session: Returns the URI of the request that initiated this WebSocket session.
getSendStream() - Method in interface jakarta.websocket.RemoteEndpoint.Basic: Returns an OutputStream for sending a binary message to the remote endpoint.
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: Returns a Writer for sending a text message to the remote endpoint.
getSession() - Method in exception class jakarta.websocket.SessionException: Returns the session on which the error occurred.
getSSLContext() - Method in interface jakarta.websocket.ClientEndpointConfig: Returns the SSL context to use for secure WebSocket connections.
getSubprotocols() - Method in interface jakarta.websocket.server.ServerEndpointConfig: Returns the list of sub-protocols supported by this endpoint.
getText() - Method in exception class jakarta.websocket.DecodeException: Returns the text data that could not be decoded.
getUserPrincipal() - Method in interface jakarta.websocket.server.HandshakeRequest: Returns the principal of the user associated with this request, or null if the user is not authenticated.
getUserPrincipal() - Method in interface jakarta.websocket.Session: Returns the principal of the user associated with this session, or null if the user is not authenticated.
getUserProperties() - Method in interface jakarta.websocket.EndpointConfig: Returns a map of user properties associated with this endpoint configuration.
getUserProperties() - Method in interface jakarta.websocket.Session: Returns a map of user properties associated with this session.
getValue() - Method in interface jakarta.websocket.Extension.Parameter: Returns the value of this 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: Indicates that the endpoint is going away, either because the browser is navigating away from the page, or because the server is shutting down.

H

HandshakeRequest - Interface in jakarta.websocket.server: Represents the HTTP request that asked to be upgraded to WebSocket.
HandshakeResponse - Interface in jakarta.websocket: Represents the HTTP response returned by the server during a WebSocket handshake.

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: Returns whether the send operation was successful.
isOpen() - Method in interface jakarta.websocket.Session: Returns whether this session is currently open.
isSecure() - Method in interface jakarta.websocket.Session: Returns whether this session is using a secure connection (wss://).
isUserInRole(String) - Method in interface jakarta.websocket.server.HandshakeRequest: Returns whether the user associated with this request is in the given role.

J

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

M

maxMessageSize() - Element in annotation type jakarta.websocket.OnMessage: The maximum message size in bytes that this handler will accept.
MessageHandler - Interface in jakarta.websocket: Base interface for WebSocket message handlers.
MessageHandler.Partial<T> - Interface in jakarta.websocket: A message handler that receives partial (fragmented) messages.
MessageHandler.Whole<T> - Interface in jakarta.websocket: A message handler that receives whole (complete) messages.
modifyHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator: Provides the opportunity to modify the handshake before it is completed.

N

NO_EXTENSION - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates that the client is terminating the connection because it expected the server to negotiate one or more extension, but the server didn't return them in the handshake response.
NO_STATUS_CODE - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates that no status code was included in the closing frame.
NORMAL_CLOSURE - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
NOT_CONSISTENT - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates that the endpoint is terminating the connection because it has received a message that contains data that is not consistent with the type of the message.

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: Annotates a method on a POJO endpoint to handle the close event.
onError(Session, Throwable) - Method in class jakarta.websocket.Endpoint: Event that is triggered when a protocol error occurs.
OnError - Annotation Type in jakarta.websocket: Annotates a method on a POJO endpoint to handle error events.
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: Annotates a method on a POJO endpoint to handle incoming WebSocket messages.
onOpen(Session, EndpointConfig) - Method in class jakarta.websocket.Endpoint: Event that is triggered when a new session starts.
OnOpen - Annotation Type in jakarta.websocket: Annotates a method on a POJO endpoint to handle the open event.
onResult(SendResult) - Method in interface jakarta.websocket.SendHandler: Called when the asynchronous send operation completes.

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: Sets the list of preferred sub-protocols for the WebSocket connection.
PROTOCOL_ERROR - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates that the endpoint is terminating the connection due to a protocol error.

R

RemoteEndpoint - Interface in jakarta.websocket: Interface for sending messages to the remote endpoint of a WebSocket session.
RemoteEndpoint.Async - Interface in jakarta.websocket: Asynchronous API for sending messages to the remote endpoint.
RemoteEndpoint.Basic - Interface in jakarta.websocket: Synchronous (blocking) API for sending messages to the remote endpoint.
removeMessageHandler(MessageHandler) - Method in interface jakarta.websocket.Session: Removes the specified message handler from this session.
RESERVED - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Reserved.

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: Name of the Sec-WebSocket-Extensions HTTP header.
SEC_WEBSOCKET_KEY - Static variable in interface jakarta.websocket.server.HandshakeRequest: Name of the Sec-WebSocket-Key HTTP header.
SEC_WEBSOCKET_PROTOCOL - Static variable in interface jakarta.websocket.server.HandshakeRequest: Name of the Sec-WebSocket-Protocol HTTP header.
SEC_WEBSOCKET_VERSION - Static variable in interface jakarta.websocket.server.HandshakeRequest: Name of the Sec-WebSocket-Version HTTP header.
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: Callback interface for handling the result of an asynchronous WebSocket message send operation.
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: Represents the result of an asynchronous WebSocket message send operation.
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: Annotates a class as a WebSocket server endpoint.
ServerEndpointConfig - Interface in jakarta.websocket.server: Provides configuration information for WebSocket endpoints published to a server.
ServerEndpointConfig.Builder - Class in jakarta.websocket.server: Builder for creating ServerEndpointConfig instances.
ServerEndpointConfig.Configurator - Class in jakarta.websocket.server: Provides a mechanism to customize the WebSocket handshake for server endpoints.
SERVICE_RESTART - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates that the server is restarting.
Session - Interface in jakarta.websocket: Represents a WebSocket session, which is the WebSocket connection between a client and a server.
SessionException - Exception Class in jakarta.websocket: Exception thrown when an error occurs on a WebSocket session.
SessionException(String, Throwable, Session) - Constructor for exception class jakarta.websocket.SessionException: Creates a SessionException with the specified detail message, cause, and session.
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: Sets the SSL context to use for secure WebSocket connections.
subprotocols() - Element in annotation type jakarta.websocket.ClientEndpoint: The sub-protocols that this client endpoint supports, in order of preference.
subprotocols() - Element in annotation type jakarta.websocket.server.ServerEndpoint: The sub-protocols that this server endpoint supports.
subprotocols(List) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder: Sets the list of sub-protocols supported by the endpoint.

T

TLS_HANDSHAKE_FAILURE - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates that the connection was closed due to a failure to perform a TLS handshake.
TOO_BIG - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates that the endpoint is terminating the connection because it has received a message that is too big to process.
toString() - Method in class jakarta.websocket.CloseReason
TRY_AGAIN_LATER - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates that the server is experiencing a temporary condition and the client should try to connect again later.

U

UNEXPECTED_CONDITION - Enum constant in enum jakarta.websocket.CloseReason.CloseCodes: Indicates that the server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
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: The name of the path parameter from the URI template.
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: Indicates that the endpoint is terminating the connection because it has received a message that violates its policy.

W

WebSocketContainer - Interface in jakarta.websocket: Provides the ability to create new WebSocket client connections.
willDecode(String) - Method in interface jakarta.websocket.Decoder.Text: Determines whether this decoder can decode the given text data.
willDecode(ByteBuffer) - Method in interface jakarta.websocket.Decoder.Binary: Determines whether this decoder can decode the given binary data.

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