This package contains all the Jakarta WebSocket APIs common to both the client and server side.
Interface Summary Interface Description ClientEndpointConfigThe ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints. CloseReason.CloseCodeA marker interface for the close codes. DecoderThe Decoder interface holds member interfaces that define how a developer can provide the web socket container a way web socket messages into developer defined custom objects. Decoder.Binary<T>This interface defines how a custom object (of type T) is decoded from a web socket message in the form of a byte buffer. Decoder.BinaryStream<T>This interface defines how a custom object is decoded from a web socket message in the form of a binary stream. Decoder.Text<T>This interface defines how a custom object is decoded from a web socket message in the form of a string. Decoder.TextStream<T>This interface defines how a custom object of type T is decoded from a web socket message in the form of a character stream. EncoderThe Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages. Encoder.Binary<T>This interface defines how to provide a way to convert a custom object into a binary message. Encoder.BinaryStream<T>This interface may be implemented by encoding algorithms that want to write the encoded object to a binary stream. Encoder.Text<T>This interface defines how to provide a way to convert a custom object into a text message. Encoder.TextStream<T>This interface may be implemented by encoding algorithms that want to write the encoded object to a character stream. EndpointConfigThe endpoint configuration contains all the information needed during the handshake process for this end point. ExtensionA simple representation of a websocket extension as a name and map of extension parameters. Extension.ParameterThis member interface defines a single websocket extension parameter. HandshakeResponseThe handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake request. MessageHandlerDevelopers implement MessageHandlers in order to receive incoming messages during a web socket conversation. MessageHandler.Partial<T>This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message. MessageHandler.Whole<T>This kind of handler is notified by the container on arrival of a complete message. PongMessageThe PongMessage interface represents a web socket pong. RemoteEndpointThe RemoteEndpoint object is supplied by the container and represents the 'other end' or peer of the Web Socket conversation. RemoteEndpoint.AsyncThis representation of the peer of a web socket conversation has the ability to send messages asynchronously. RemoteEndpoint.BasicThis representation of the peer of a web socket conversation has the ability to send messages synchronously. SendHandlerA simple callback object for asynchronous sending of web socket messages. SessionA Web Socket session represents a conversation between two web socket endpoints. WebSocketContainerA WebSocketContainer is an implementation provided object that provides applications a view on the container running it.
Class Summary Class Description ClientEndpointConfig.BuilderThe ClientEndpointConfig.Builder is a class used for creating
ClientEndpointConfigobjects for the purposes of deploying a client endpoint.
ClientEndpointConfig.ConfiguratorThe 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. CloseReasonA class encapsulating the reason why a web socket has been closed, or why it is being asked to close. ContainerProviderProvider class that allows the developer to get a reference to the implementation of the WebSocketContainer. EndpointThe Web Socket Endpoint represents an object that can handle websocket conversations. SendResultThe result of asynchronously sending a web socket message.
Enum Summary Enum Description CloseReason.CloseCodesAn Enumeration of status codes for a web socket close that are defined in the specification.
Exception Summary Exception Description DecodeExceptionA general exception that occurs when trying to decode a custom object from a text or binary message. DeploymentExceptionChecked exception indicating some kind of failure either to publish an endpoint on its server, or a failure to connect a client to its server. EncodeExceptionA general exception that occurs when trying to encode a custom object to a string or binary message. SessionExceptionA SessionException represents a general exception type reporting problems occurring on a websocket session.
Annotation Types Summary Annotation Type Description ClientEndpointThe ClientEndpoint annotation a class level annotation is used to denote that a POJO is a web socket client and can be deployed as such. OnCloseThis method level annotation can be used to decorate a Java method that wishes to be called when a web socket session is closing. OnErrorThis method level annotation can be used to decorate a Java method that wishes to be called in order to handle errors. OnMessageThis method level annotation can be used to make a Java method receive incoming web socket messages. OnOpenThis method level annotation can be used to decorate a Java method that wishes to be called when a new web socket session is open.