Package javax.websocket

Interface Summary

ClientEndpointConfiguration	The ClientEndpointConfiguration is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
CloseReason.CloseCode	A marker interface for the close codes.
Decoder	The 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.
Encoder	The 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.
EndpointConfiguration	The endpoint configuration contains all the information needed during the handshake process for this end point.
Extension	A simple representation of a websocket extension as a name and map of extension parameters.
Extension.Parameter	This member interface defines a single websocket extension parameter.
HandshakeResponse	The handshake response represents the web socket-defined Http response that is the response to the opening handshake request.
MessageHandler	Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.
MessageHandler.Async<T>	This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.
MessageHandler.Basic<T>	This kind of handler is notified by the container on arrival of a complete message.
PongMessage	The PongMessage interface represents a web socket pong.
RemoteEndpoint	The RemoteEndpoint object is supplied by the container and represents the 'other end' of the Web Socket conversation.
SendHandler	A simple callback object for asynchronous sending of web socket messages.
Session	A Web Socket session represents a conversation between two web socket endpoints.
WebSocketContainer	A WebSocketContainer is an implementation provided object that allows the developer to initiate a web socket handshake from the provided endpoint.

Class Summary

CloseReason	A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
ContainerProvider	Provider class that allows the developer to get a reference to the implementation of the WebSocketContainer.
DefaultClientConfiguration	The DefaultClientConfiguration is a concrete implementation of a client configuration.
Endpoint	The Web Socket Endpoint represents an object that can handle a web socket conversations.
SendResult	The result of asynchronously sending a web socket message.

Enum Summary

CloseReason.CloseCodes

An Enumeration of status codes for a web socket close that are defined in the specification.

Exception Summary

DecodeException	A general exception that occurs when trying to decode a custom object from a text or binary message.
DeploymentException	Checked exception indicating some kind of failure either to publish an endpoint on its server, or a failure to connect a client to its server.
EncodeException	A general exception that occurs when trying to encode a custom object to a string or binary message.

Annotation Types Summary

WebSocketClient	The WebSocketClient annotation a class level annotation is used to denote that a POJO is a web socket client and can be deployed as such.
WebSocketClose	This method level annotation can be used to decorate a Java method that wishes to be called when a web socket session has closed.
WebSocketError	This method level annotation can be used to decorate a Java method that wishes to be called in order to handle errors.
WebSocketMessage	This method level annotation can be used to make a Java method receive incoming web socket messages.
WebSocketOpen	This method level annotation can be used to decorate a Java method that wishes to be called when a new web socket session is open.