Module jakarta.websocket
Package jakarta.websocket.server
package jakarta.websocket.server
This package contains all the Jakarta WebSocket APIs used only by server side applications.
-
ClassDescriptionThe handshake request represents the WebSocket defined HTTP GET request for the opening handshake of a WebSocket session.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.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.The ServerContainer is the specialized view of the WebSocketContainer available in server-side deployments.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.The ServerEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to server endpoints.The ServerEndpointConfig.Builder is a class used for creatingServerEndpointConfig.Builder
objects for the purposes of deploying a server endpoint.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.