All Classes and Interfaces
Class
Description
The ClientEndpoint annotation a class level annotation is used to denote that a POJO
is a web socket client and can be deployed as such.
The ClientEndpointConfig is a special kind of endpoint configuration object that contains
web socket configuration information specific only to client endpoints.
The ClientEndpointConfig.Builder is a class used for creating
ClientEndpointConfig objects for the purposes of
deploying a client endpoint.The 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.
A class encapsulating the reason why a web socket has been closed, or why it is being asked to
close.
A marker interface for the close codes.
An Enumeration of status codes for a web socket close that
are defined in the specification.
Provider class that allows the developer to get a reference to
the implementation of the WebSocketContainer.
A general exception that occurs when trying to decode a custom object from a text or binary message.
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.
This interface defines how a custom object (of type T) is decoded from a web socket message in
the form of a byte buffer.
This interface defines how a custom object is decoded from a web socket message in
the form of a binary stream.
This interface defines how a custom object is decoded from a web socket message in
the form of a string.
This interface defines how a custom object of type T is decoded from a web socket message in
the form of a character stream.
The DefaultClientEndpointConfig is a concrete implementation of a client configuration.
The DefaultServerEndpointConfig is a concrete class that embodies all the configuration
parameters for an endpoint that is to be published as a server endpoint.
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.
A general exception that occurs when trying to encode a custom object to a string or binary message.
The Encoder interface defines how developers can provide a way to convert
their custom objects into web socket messages.
This interface defines how to provide a way to convert a custom
object into a binary message.
This interface may be implemented by encoding algorithms
that want to write the encoded object to a binary stream.
This interface defines how to provide a way to convert a custom
object into a text message.
This interface may be implemented by encoding algorithms
that want to write the encoded object to a character stream.
The Web Socket Endpoint represents an object that can handle websocket conversations.
The endpoint configuration contains all the information needed during the handshake process
for this end point.
A simple representation of a websocket extension as a name and map of extension parameters.
This member interface defines a single websocket extension parameter.
The handshake request represents the web socket defined Http GET request
for the opening handshake of a web socket session.
The handshake response represents the web socket-defined Http response
that is the response to the opening handshake request.
Developers implement MessageHandlers in order to receive incoming messages
during a web socket conversation.
This kind of handler is notified by the implementation as it becomes ready
to deliver parts of a whole message.
This kind of handler is notified by the container on arrival of a complete message.
This method level annotation can be used to decorate a Java method that wishes
to be called when a web socket session is closing.
This method level annotation can be used to decorate a Java method that wishes to be called in order
to handle errors.
This method level annotation can be used to make a Java method receive incoming web socket messages.
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.
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.The PongMessage interface represents a web socket pong.
The RemoteEndpoint object is supplied by the container and represents the
'other end' or peer of the Web Socket conversation.
This representation of the peer of a web socket conversation has the ability
to send messages asynchronously.
This representation of the peer of a web socket conversation has the ability
to send messages synchronously.
A simple callback object for asynchronous sending of web socket messages.
The result of asynchronously sending a web socket message.
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 creating
ServerEndpointConfig.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.
A Web Socket session represents a conversation between two web socket endpoints.
A SessionException represents a general exception type reporting problems
occurring on a websocket session.
A WebSocketContainer is an implementation provided object that provides applications
a view on the container running it.