# Uses of Package
javax.websocket

- Packages that use javax.websocket
  Package | Description
  --- | ---
  javax.websocket | This package contains all the WebSocket APIs common to both the client and server side.
  javax.websocket.server | This package contains all the WebSocket APIs used only by server side applications.

- Classes in javax.websocket used by javax.websocket
  Class and Description
  ClientEndpointConfig The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
  ClientEndpointConfig.Builder The ClientEndpointConfig.Builder is a class used for creating `ClientEndpointConfig` objects for the purposes of deploying a client endpoint.
  ClientEndpointConfig.Configurator 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.
  CloseReason A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.
  CloseReason.CloseCode A marker interface for the close codes.
  CloseReason.CloseCodes An Enumeration of status codes for a web socket close that are defined in the specification.
  DecodeException A general exception that occurs when trying to decode a custom object from a text or binary message.
  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.
  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.
  Encoder The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
  Endpoint The Web Socket Endpoint represents an object that can handle websocket conversations.
  EndpointConfig 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.Partial This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.
  MessageHandler.Whole This kind of handler is notified by the container on arrival of a complete message.
  RemoteEndpoint The RemoteEndpoint object is supplied by the container and represents the 'other end' or peer of the Web Socket conversation.
  RemoteEndpoint.Async This representation of the peer of a web socket conversation has the ability to send messages asynchronously.
  RemoteEndpoint.Basic This representation of the peer of a web socket conversation has the ability to send messages synchronously.
  SendHandler A simple callback object for asynchronous sending of web socket messages.
  SendResult The result of asynchronously sending a web socket message.
  Session A Web Socket session represents a conversation between two web socket endpoints.
  WebSocketContainer A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

- Classes in javax.websocket used by javax.websocket.server
  Class and Description
  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.
  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.
  Encoder The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
  Endpoint The Web Socket Endpoint represents an object that can handle websocket conversations.
  EndpointConfig 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.
  HandshakeResponse The handshake response represents the web socket-defined Http response that is the response to the opening handshake request.
  WebSocketContainer A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

Copyright © 1996-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.