Top Description Interfaces Annotations Classes

[default module]

Package javax.websocket

This package contains all the WebSocket APIs common to both the client and server side.

Interface Summary

Modifier and Type	Interface and Description
public interface	ClientEndpointConfig The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
public interface	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.
public interface	Encoder The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
public interface	EndpointConfig The endpoint configuration contains all the information needed during the handshake process for this end point.
public interface	Extension A simple representation of a websocket extension as a name and map of extension parameters.
public interface	HandshakeResponse The handshake response represents the web socket-defined Http response that is the response to the opening handshake request.
public interface	MessageHandler Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.
public interface	PongMessage The PongMessage interface represents a web socket pong.
public interface	RemoteEndpoint The RemoteEndpoint object is supplied by the container and represents the 'other end' or peer of the Web Socket conversation.
public interface	SendHandler A simple callback object for asynchronous sending of web socket messages.
public interface	Session A Web Socket session represents a conversation between two web socket endpoints.
public interface	WebSocketContainer A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	ClientEndpoint 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.
public @interface	OnClose This method level annotation can be used to decorate a Java method that wishes to be called when a web socket session is closing.
public @interface	OnError This method level annotation can be used to decorate a Java method that wishes to be called in order to handle errors.
public @interface	OnMessage This method level annotation can be used to make a Java method receive incoming web socket messages.
public @interface	OnOpen 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.

Class Summary

Modifier and Type	Class and Description
public class	CloseReason A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
public abstract class	ContainerProvider Provider class that allows the developer to get a reference to the implementation of the WebSocketContainer.
public class	DecodeException A general exception that occurs when trying to decode a custom object from a text or binary message.
pack-priv class	DefaultClientEndpointConfig The DefaultClientEndpointConfig is a concrete implementation of a client configuration.
public class	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.
public class	EncodeException A general exception that occurs when trying to encode a custom object to a string or binary message.
public abstract class	Endpoint The Web Socket Endpoint represents an object that can handle websocket conversations.
public class	SendResult The result of asynchronously sending a web socket message.
public class	SessionException A SessionException represents a general exception type reporting problems occurring on a websocket session.