Package javax.websocket

Interface Summary

Interface	Description
ClientContainer	A ClientContainer is an implementation provided object that allows the developer to initiate a web socket handshake from the provided endpoint.
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 interfaces 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.
HandshakeRequest	The handshake request represents the web socket defined Http request that for the opening handshake of a web socket session.
HandshakeResponse	The handshake response represents the web socket defined http response that will be sent by the web socket server during the opening handshake.
MessageHandler	Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.
MessageHandler.Async<T>	This kind of listener listens is notified by the container as parts of a message arrive.
MessageHandler.Basic<T>	This kind of handler is notified by the container on arrival of a complete message.
PingMessage	The PingMessage interface represents a web socket ping.
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.
ServerContainer	The ServerContainer is an implementation provided object that, in addition to being able to initiate web socket connections (client), can register endpoints that can handle incoming connection requests.
ServerEndpointConfiguration	The ServerEndpointConfiguration is a special kind of endpoint configuration object that contains web socket configuration information specific only to server endpoints.
Session	A Web Socket session represents a conversation between two web socket endpoints.

Class Summary

Class	Description
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 uses the ServiceLoader mechanism to provide implementations of ServerContainer and ClientContainer.
DefaultClientConfiguration	The DefaultClientConfiguration is a concrete implementation of a client configuration.
DefaultServerConfiguration	The DefaultServerConfiguration is a concrete class that embodies all the configuration parameters for an endpoint that is to be published as a server endpoint.
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

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

Exception Summary

Exception	Description
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

Annotation Type	Description
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.
WebSocketEndpoint	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.
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.
WebSocketPathParam	This annotation may be used to annotate method parameters on server side web socket POJOs where a URI-template has been used in the path-mapping of the WebSocketEndpoint annotation.