Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addEndpoint(ServerEndpointConfig) - Method in interface jakarta.websocket.server.ServerContainer
-
Deploys the given endpoint described by the provided configuration into this ServerContainer.
- addEndpoint(Class<?>) - Method in interface jakarta.websocket.server.ServerContainer
-
Deploys the given annotated endpoint into this ServerContainer.
B
- build() - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Builds the configuration object using the current attributes that have been set on this builder object.
C
- checkOrigin(String) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Check the value of the Origin header (See Origin Header) the client passed during the opening handshake.
- configurator() - Element in annotation type jakarta.websocket.server.ServerEndpoint
-
The optional custom configurator class that the developer would like to use to further configure new instances of this endpoint.
- configurator(ServerEndpointConfig.Configurator) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the custom configurator to use on the configuration object built by this builder.
- Configurator() - Constructor for class jakarta.websocket.server.ServerEndpointConfig.Configurator
- create(Class<?>, String) - Static method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Creates the builder with the mandatory information of the endpoint class (programmatic or annotated), the relative URI or URI-template to use, and with no subprotocols, extensions, encoders, decoders or custom configurator.
D
- decoders() - Element in annotation type jakarta.websocket.server.ServerEndpoint
-
The ordered array of decoder classes this endpoint will use.
- decoders(List<Class<? extends Decoder>>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the decoder implementation classes to use in the configuration.
E
- encoders() - Element in annotation type jakarta.websocket.server.ServerEndpoint
-
The ordered array of encoder classes this endpoint will use.
- encoders(List<Class<? extends Encoder>>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the list of encoder implementation classes for this builder.
- extensions(List<Extension>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the extensions to use in the configuration.
G
- getAnnotatedEndpointClasses(Set<Class<?>>) - Method in interface jakarta.websocket.server.ServerApplicationConfig
-
Return a set of annotated endpoint classes that the server container must deploy.
- getConfigurator() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the
ServerEndpointConfig.Configurator
this configuration is using. - getContainerDefaultConfigurator() - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Return the platform default configurator.
- getEndpointClass() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Returns the Class of the endpoint this configuration is configuring.
- getEndpointConfigs(Set<Class<? extends Endpoint>>) - Method in interface jakarta.websocket.server.ServerApplicationConfig
-
Return a set of ServerEndpointConfig instances that the server container will use to deploy the programmatic endpoints.
- getEndpointInstance(Class<T>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
This method is called by the container each time a new client connects to the logical endpoint this configurator configures.
- getExtensions() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the websocket extensions configured.
- getHeaders() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the read only map of HTTP headers to header values that came with the handshake request.
- getHttpSession() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return a reference to the HttpSession that the web socket handshake that started this conversation was part of, if the implementation is part of a Java EE web container.
- getNegotiatedExtensions(List<Extension>, List<Extension>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Return the ordered list of extensions that t server endpoint will support given the requested extension list passed in, the empty list if none.
- getNegotiatedSubprotocol(List<String>, List<String>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Return the subprotocol the server endpoint has chosen from the requested list supplied by a client who wishes to connect, or none if there wasn't one this server endpoint liked.
- getParameterMap() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the request parameters associated with the request.
- getPath() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the path for this endpoint configuration.
- getQueryString() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the query string associated with the request.
- getRequestURI() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the request URI of the handshake request.
- getSubprotocols() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the websocket subprotocols configured.
- getUserPrincipal() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the authenticated user or
null
if no user is authenticated for this handshake.
H
- HandshakeRequest - Interface in jakarta.websocket.server
-
The handshake request represents the WebSocket defined HTTP GET request for the opening handshake of a WebSocket session.
I
- isUserInRole(String) - Method in interface jakarta.websocket.server.HandshakeRequest
-
Checks whether the current user is in the given role.
J
- jakarta.websocket.server - package jakarta.websocket.server
-
This package contains all the Jakarta WebSocket APIs used only by server side applications.
M
- modifyHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Called by the container after it has formulated a handshake response resulting from a well-formed handshake request.
P
- PathParam - Annotation Type in jakarta.websocket.server
-
This annotation may be used to annotate method parameters on server endpoints where a URI-template has been used in the path-mapping of the
ServerEndpoint
annotation.
S
- SEC_WEBSOCKET_EXTENSIONS - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Extensions header name
- SEC_WEBSOCKET_KEY - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Key header name
- SEC_WEBSOCKET_PROTOCOL - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Protocol header name
- SEC_WEBSOCKET_VERSION - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Version header name
- ServerApplicationConfig - Interface in jakarta.websocket.server
-
Developers include implementations of ServerApplicationConfig in an archive containing websocket endpoints (WAR file, or JAR file within the WAR file) in order to specify the websocket endpoints within the archive the implementation must deploy.
- ServerContainer - Interface in jakarta.websocket.server
-
The ServerContainer is the specialized view of the WebSocketContainer available in server-side deployments.
- ServerEndpoint - Annotation Type in jakarta.websocket.server
-
This class level annotation declares that the class it decorates is a web socket endpoint that will be deployed and made available in the URI-space of a web socket server.
- ServerEndpointConfig - Interface in jakarta.websocket.server
-
The ServerEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to server endpoints.
- ServerEndpointConfig.Builder - Class in jakarta.websocket.server
-
The ServerEndpointConfig.Builder is a class used for creating
ServerEndpointConfig.Builder
objects for the purposes of deploying a server endpoint. - ServerEndpointConfig.Configurator - Class in jakarta.websocket.server
-
The ServerEndpointConfig.Configurator class may be extended by developers who want to provide custom configuration algorithms, such as intercepting the opening handshake, or providing arbitrary methods and algorithms that can be accessed from each endpoint instance configured with this configurator.
- subprotocols() - Element in annotation type jakarta.websocket.server.ServerEndpoint
-
The ordered array of web socket protocols this endpoint supports.
- subprotocols(List<String>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the subprotocols to use in the configuration.
U
- upgradeHttpToWebSocket(Object, Object, ServerEndpointConfig, Map<String, String>) - Method in interface jakarta.websocket.server.ServerContainer
-
Upgrade the HTTP connection represented by the
HttpServletRequest
andHttpServletResponse
to the WebSocket protocol and establish a WebSocket connection as per the providedServerEndpointConfig
.
V
- value() - Element in annotation type jakarta.websocket.server.PathParam
-
The name of the variable used in the URI-template.
- value() - Element in annotation type jakarta.websocket.server.ServerEndpoint
-
The URI or URI-template, level-1 (See RFC 6570) where the endpoint will be deployed.
All Classes and Interfaces|All Packages|Constant Field Values