A B C D E F G H I J M O P R S T V W

A

addMessageHandler(MessageHandler) - Method in interface javax.websocket.Session

Register to handle to incoming messages in this conversation.

afterResponse(HandshakeResponse) - Method in class javax.websocket.ClientEndpointConfig.Configurator

This method is called by the implementation after it has received a handshake response from the server as a result of a handshake interaction it initiated.

B

beforeRequest(Map<String, List<String>>) - Method in class javax.websocket.ClientEndpointConfig.Configurator

This method is called by the implementation after it has formulated the handshake request that will be used to initiate the connection to the server, but before it has sent any part of the request.

build() - Method in class javax.websocket.ClientEndpointConfig.Builder

Builds a configuration object using the attributes set on this builder.

C

ClientEndpoint - Annotation Type in javax.websocket

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.

ClientEndpointConfig - Interface in javax.websocket

The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.

ClientEndpointConfig.Builder - Class in javax.websocket

The ClientEndpointConfig.Builder is a class used for creating ClientEndpointConfig objects for the purposes of deploying a client endpoint.

ClientEndpointConfig.Configurator - Class in javax.websocket

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.

ClientEndpointConfig.Configurator() - Constructor for class javax.websocket.ClientEndpointConfig.Configurator

close() - Method in interface javax.websocket.Session

Close the current conversation with a normal status code and no reason phrase.

close(CloseReason) - Method in interface javax.websocket.Session

Close the current conversation, giving a reason for the closure.

CloseReason - Class in javax.websocket

A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.

CloseReason(CloseReason.CloseCode, String) - Constructor for class javax.websocket.CloseReason

Creates a reason for closing a web socket connection with the given code and reason phrase.

CloseReason.CloseCode - Interface in javax.websocket

A marker interface for the close codes.

CloseReason.CloseCodes - Enum in javax.websocket

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

configurator(ClientEndpointConfig.Configurator) - Method in class javax.websocket.ClientEndpointConfig.Builder

Sets the configurator object for the configuration this builder will build.

connectToServer(Object, URI) - Method in interface javax.websocket.WebSocketContainer

Connect the supplied annotated endpoint instance to its server.

connectToServer(Class<?>, URI) - Method in interface javax.websocket.WebSocketContainer

Connect the supplied annotated endpoint to its server.

connectToServer(Endpoint, ClientEndpointConfig, URI) - Method in interface javax.websocket.WebSocketContainer

Connect the supplied programmatic client endpoint instance to its server with the given configuration.

connectToServer(Class<? extends Endpoint>, ClientEndpointConfig, URI) - Method in interface javax.websocket.WebSocketContainer

Connect the supplied programmatic endpoint to its server with the given configuration.

ContainerProvider - Class in javax.websocket

Provider class that allows the developer to get a reference to the implementation of the WebSocketContainer.

ContainerProvider() - Constructor for class javax.websocket.ContainerProvider

create() - Static method in class javax.websocket.ClientEndpointConfig.Builder

Creates a new builder object with no subprotocols, extensions, encoders, decoders and a null configurator.

D

decode(ByteBuffer) - Method in interface javax.websocket.Decoder.Binary

Decode the given bytes into an object of type T.

decode(InputStream) - Method in interface javax.websocket.Decoder.BinaryStream

Decode the given bytes read from the input stream into an object of type T.

decode(String) - Method in interface javax.websocket.Decoder.Text

Decode the given String into an object of type T.

decode(Reader) - Method in interface javax.websocket.Decoder.TextStream

Reads the websocket message from the implementation provided Reader and decodes it into an instance of the supplied object type.

DecodeException - Exception in javax.websocket

A general exception that occurs when trying to decode a custom object from a text or binary message.

DecodeException(ByteBuffer, String, Throwable) - Constructor for exception javax.websocket.DecodeException

Constructor with the binary data that could not be decoded, and the reason why it failed to be, and the cause.

DecodeException(String, String, Throwable) - Constructor for exception javax.websocket.DecodeException

Constructor with the text data that could not be decoded, and the reason why it failed to be, and the cause.

DecodeException(ByteBuffer, String) - Constructor for exception javax.websocket.DecodeException

Constructs a DecodedException with the given ByteBuffer that cannot be decoded, and reason why.

DecodeException(String, String) - Constructor for exception javax.websocket.DecodeException

Constructs a DecodedException with the given encoded string that cannot be decoded, and reason why.

Decoder - Interface in javax.websocket

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> - Interface in javax.websocket

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> - Interface in javax.websocket

This interface defines how a custom object is decoded from a web socket message in the form of a binary stream.

Decoder.Text<T> - Interface in javax.websocket

This interface defines how a custom object is decoded from a web socket message in the form of a string.

Decoder.TextStream<T> - Interface in javax.websocket

This interface defines how a custom object of type T is decoded from a web socket message in the form of a character stream.

decoders(List<Class<? extends Decoder>>) - Method in class javax.websocket.ClientEndpointConfig.Builder

Assign the list of decoder implementation classes the client will use.

DeploymentException - Exception in javax.websocket

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.

DeploymentException(String) - Constructor for exception javax.websocket.DeploymentException

Creates a deployment exception with the given reason for the deployment failure.

DeploymentException(String, Throwable) - Constructor for exception javax.websocket.DeploymentException

Creates a deployment exception with the given reason for the deployment failure and wrapped cause of the failure.

destroy() - Method in interface javax.websocket.Decoder

This method is called when the decoder is about to be removed from service in order that any resources the encoder used may be closed gracefully.

destroy() - Method in interface javax.websocket.Encoder

This method is called when the encoder is about to be removed from service in order that any resources the encoder used may be closed gracefully.

E

encode(T) - Method in interface javax.websocket.Encoder.Binary

Encode the given object into a byte array.

encode(T, OutputStream) - Method in interface javax.websocket.Encoder.BinaryStream

Encode the given object into a binary stream written to the implementation provided OutputStream.

encode(T) - Method in interface javax.websocket.Encoder.Text

Encode the given object into a String.

encode(T, Writer) - Method in interface javax.websocket.Encoder.TextStream

Encode the given object to a character stream writing it to the supplied Writer.

EncodeException - Exception in javax.websocket

A general exception that occurs when trying to encode a custom object to a string or binary message.

EncodeException(Object, String) - Constructor for exception javax.websocket.EncodeException

Constructor with the object being encoded, and the reason why it failed to be.

EncodeException(Object, String, Throwable) - Constructor for exception javax.websocket.EncodeException

Constructor with the object being encoded, and the reason why it failed to be, and the cause.

Encoder - Interface in javax.websocket

The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.

Encoder.Binary<T> - Interface in javax.websocket

This interface defines how to provide a way to convert a custom object into a binary message.

Encoder.BinaryStream<T> - Interface in javax.websocket

This interface may be implemented by encoding algorithms that want to write the encoded object to a binary stream.

Encoder.Text<T> - Interface in javax.websocket

This interface defines how to provide a way to convert a custom object into a text message.

Encoder.TextStream<T> - Interface in javax.websocket

This interface may be implemented by encoding algorithms that want to write the encoded object to a character stream.

encoders(List<Class<? extends Encoder>>) - Method in class javax.websocket.ClientEndpointConfig.Builder

Assign the list of encoder implementation classes the client will use.

Endpoint - Class in javax.websocket

The Web Socket Endpoint represents an object that can handle websocket conversations.

Endpoint() - Constructor for class javax.websocket.Endpoint

EndpointConfig - Interface in javax.websocket

The endpoint configuration contains all the information needed during the handshake process for this end point.

Extension - Interface in javax.websocket

A simple representation of a websocket extension as a name and map of extension parameters.

Extension.Parameter - Interface in javax.websocket

This member interface defines a single websocket extension parameter.

extensions(List<Extension>) - Method in class javax.websocket.ClientEndpointConfig.Builder

Set the extensions for the configuration this builder will build.

F

flushBatch() - Method in interface javax.websocket.RemoteEndpoint

This method is only used when batching is allowed for this RemoteEndpint.

G

getApplicationData() - Method in interface javax.websocket.PongMessage

The application data inside the pong message from the peer.

getAsyncRemote() - Method in interface javax.websocket.Session

Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send messages asynchronously to the peer.

getBasicRemote() - Method in interface javax.websocket.Session

Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send messages synchronously to the peer.

getBatchingAllowed() - Method in interface javax.websocket.RemoteEndpoint

Return whether the implementation is allowed to batch outgoing messages before sending.

getBytes() - Method in exception javax.websocket.DecodeException

Return the ByteBuffer containing either the whole message, or the partial message, that could not be decoded, or null if this exception arose from a failure to decode a text message.

getCloseCode(int) - Static method in enum javax.websocket.CloseReason.CloseCodes

Creates a CloseCode from the given int code number.

getCloseCode() - Method in class javax.websocket.CloseReason

The Close code associated with this CloseReason.

getCode() - Method in interface javax.websocket.CloseReason.CloseCode

Returns the code number, for example the integer '1000' for normal closure.

getCode() - Method in enum javax.websocket.CloseReason.CloseCodes

Return the code number of this status code.

getConfigurator() - Method in interface javax.websocket.ClientEndpointConfig

Return the custom configurator for this configuration.

getContainer() - Method in class javax.websocket.ContainerProvider

Load the container implementation.

getContainer() - Method in interface javax.websocket.Session

Return the container that this session is part of.

getDecoders() - Method in interface javax.websocket.EndpointConfig

Return the Decoder implementation classes configured.

getDefaultAsyncSendTimeout() - Method in interface javax.websocket.WebSocketContainer

Return the number of milliseconds the implementation will timeout attempting to send a websocket message for all RemoteEndpoints associated with this container.

getDefaultMaxBinaryMessageBufferSize() - Method in interface javax.websocket.WebSocketContainer

Returns the default maximum size of incoming binary message that this container will buffer.

getDefaultMaxSessionIdleTimeout() - Method in interface javax.websocket.WebSocketContainer

Return the default time in milliseconds after which any web socket sessions in this container will be closed if it has been inactive.

getDefaultMaxTextMessageBufferSize() - Method in interface javax.websocket.WebSocketContainer

Returns the default maximum size of incoming text message that this container will buffer.

getEncoders() - Method in interface javax.websocket.EndpointConfig

Return the Encoder implementation classes configured.

getException() - Method in class javax.websocket.SendResult

The problem sending the message.

getExtensions() - Method in interface javax.websocket.ClientEndpointConfig

Return the extensions, in order of preference, favorite first, that this client would like to use for its sessions.

getHeaders() - Method in interface javax.websocket.HandshakeResponse

Return the list of Http headers sent by the web socket server.

getId() - Method in interface javax.websocket.Session

Returns a string containing the unique identifier assigned to this session.

getInstalledExtensions() - Method in interface javax.websocket.WebSocketContainer

Return the set of Extensions installed in the container.

getMaxBinaryMessageBufferSize() - Method in interface javax.websocket.Session

The maximum length of incoming binary messages that this Session can buffer.

getMaxIdleTimeout() - Method in interface javax.websocket.Session

Return the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e.

getMaxTextMessageBufferSize() - Method in interface javax.websocket.Session

The maximum length of incoming text messages that this Session can buffer.

getMessageHandlers() - Method in interface javax.websocket.Session

Return an unmodifiable copy of the set of MessageHandlers for this Session.

getName() - Method in interface javax.websocket.Extension

The name of the extension.

getName() - Method in interface javax.websocket.Extension.Parameter

Return the name of the extension parameter.

getNegotiatedExtensions() - Method in interface javax.websocket.Session

Return the list of extensions currently in use for this conversation.

getNegotiatedSubprotocol() - Method in interface javax.websocket.Session

Return the sub protocol agreed during the websocket handshake for this conversation.

getObject() - Method in exception javax.websocket.EncodeException

Return the Object that could not be encoded.

getOpenSessions() - Method in interface javax.websocket.Session

Return a copy of the Set of all the open web socket sessions that represent connections to the same endpoint to which this session represents a connection.

getParameters() - Method in interface javax.websocket.Extension

The extension parameters for this extension in the order they appear in the http headers.

getPathParameters() - Method in interface javax.websocket.Session

Return a map of the path parameter names and values used associated with the request this session was opened under.

getPreferredSubprotocols() - Method in interface javax.websocket.ClientEndpointConfig

Return the ordered list of sub protocols a client endpoint would like to use, in order of preference, favorite first that this client would like to use for its sessions.

getProtocolVersion() - Method in interface javax.websocket.Session

Returns the version of the websocket protocol currently being used.

getQueryString() - Method in interface javax.websocket.Session

Return the query string associated with the request this session was opened under.

getReasonPhrase() - Method in class javax.websocket.CloseReason

The reason phrase associated with this CloseReason.

getRequestParameterMap() - Method in interface javax.websocket.Session

Return the request parameters associated with the request this session was opened under.

getRequestURI() - Method in interface javax.websocket.Session

Return the URI under which this session was opened, including the query string if there is one.

getSendStream() - Method in interface javax.websocket.RemoteEndpoint.Basic

Opens an output stream on which a binary message may be sent.

getSendTimeout() - Method in interface javax.websocket.RemoteEndpoint.Async

Return the number of milliseconds the implementation will timeout attempting to send a websocket message.

getSendWriter() - Method in interface javax.websocket.RemoteEndpoint.Basic

Opens an character stream on which a text message may be sent.

getSession() - Method in exception javax.websocket.SessionException

Return the Session on which the problem occurred.

getText() - Method in exception javax.websocket.DecodeException

Return the encoded string that is either the whole message, or the partial message that could not be decoded, or null if this exception arose from a failure to decode a binary message..

getUserPrincipal() - Method in interface javax.websocket.Session

Return the authenticated user for this Session or null if no user is authenticated for this session.

getUserProperties() - Method in interface javax.websocket.EndpointConfig

This method returns a modifiable Map that the developer may use to store application specific information relating to the endpoint that uses this configuration instance.

getUserProperties() - Method in interface javax.websocket.Session

While the session is open, this method returns a Map that the developer may use to store application specific information relating to this session instance.

getValue() - Method in interface javax.websocket.Extension.Parameter

Return the value of the extension parameter.

getWebSocketContainer() - Static method in class javax.websocket.ContainerProvider

Obtain a new instance of a WebSocketContainer.

H

HandshakeResponse - Interface in javax.websocket

The handshake response represents the web socket-defined Http response that is the response to the opening handshake request.

I

init(EndpointConfig) - Method in interface javax.websocket.Decoder

This method is called with the endpoint configuration object of the endpoint this decoder is intended for when it is about to be brought into service.

init(EndpointConfig) - Method in interface javax.websocket.Encoder

This method is called with the endpoint configuration object of the endpoint this encoder is intended for when it is about to be brought into service.

isOK() - Method in class javax.websocket.SendResult

Determines if this result is ok or not.

isOpen() - Method in interface javax.websocket.Session

Return true if and only if the underlying socket is open.

isSecure() - Method in interface javax.websocket.Session

Return true if and only if the underlying socket is using a secure transport.

J

javax.websocket - package javax.websocket

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

M

MessageHandler - Interface in javax.websocket

Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.

MessageHandler.Partial<T> - Interface in javax.websocket

This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.

MessageHandler.Whole<T> - Interface in javax.websocket

This kind of handler is notified by the container on arrival of a complete message.

O

onClose(Session, CloseReason) - Method in class javax.websocket.Endpoint

This method is called immediately prior to the session with the remote peer being closed.

OnClose - Annotation Type in javax.websocket

This method level annotation can be used to decorate a Java method that wishes to be called when a web socket session is closing.

onError(Session, Throwable) - Method in class javax.websocket.Endpoint

Developers may implement this method when the web socket session creates some kind of error that is not modeled in the web socket protocol.

OnError - Annotation Type in javax.websocket

This method level annotation can be used to decorate a Java method that wishes to be called in order to handle errors.

onMessage(T, boolean) - Method in interface javax.websocket.MessageHandler.Partial

Called when the next part of a message has been fully received.

onMessage(T) - Method in interface javax.websocket.MessageHandler.Whole

Called when the message has been fully received.

OnMessage - Annotation Type in javax.websocket

This method level annotation can be used to make a Java method receive incoming web socket messages.

onOpen(Session, EndpointConfig) - Method in class javax.websocket.Endpoint

Developers must implement this method to be notified when a new conversation has just begun.

OnOpen - Annotation Type in javax.websocket

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.

onResult(SendResult) - Method in interface javax.websocket.SendHandler

Called once the message has been transmitted.

P

PongMessage - Interface in javax.websocket

The PongMessage interface represents a web socket pong.

preferredSubprotocols(List<String>) - Method in class javax.websocket.ClientEndpointConfig.Builder

Set the preferred sub protocols for the configuration this builder will build.

R

RemoteEndpoint - Interface in javax.websocket

The RemoteEndpoint object is supplied by the container and represents the 'other end' or peer of the Web Socket conversation.

RemoteEndpoint.Async - Interface in javax.websocket

This representation of the peer of a web socket conversation has the ability to send messages asynchronously.

RemoteEndpoint.Basic - Interface in javax.websocket

This representation of the peer of a web socket conversation has the ability to send messages synchronously.

removeMessageHandler(MessageHandler) - Method in interface javax.websocket.Session

Remove the given MessageHandler from the set belonging to this session.

S

SEC_WEBSOCKET_ACCEPT - Static variable in interface javax.websocket.HandshakeResponse

The Sec-WebSocket-Accept header name.

sendBinary(ByteBuffer) - Method in interface javax.websocket.RemoteEndpoint.Async

Initiates the asynchronous transmission of a binary message.

sendBinary(ByteBuffer, SendHandler) - Method in interface javax.websocket.RemoteEndpoint.Async

Initiates the asynchronous transmission of a binary message.

sendBinary(ByteBuffer) - Method in interface javax.websocket.RemoteEndpoint.Basic

Send a binary message, returning when all of the message has been transmitted.

sendBinary(ByteBuffer, boolean) - Method in interface javax.websocket.RemoteEndpoint.Basic

Send a binary message in parts, blocking until all of the message has been transmitted.

SendHandler - Interface in javax.websocket

A simple callback object for asynchronous sending of web socket messages.

sendObject(Object) - Method in interface javax.websocket.RemoteEndpoint.Async

Initiates the asynchronous transmission of a custom developer object.

sendObject(Object, SendHandler) - Method in interface javax.websocket.RemoteEndpoint.Async

Initiates the asynchronous transmission of a custom developer object.

sendObject(Object) - Method in interface javax.websocket.RemoteEndpoint.Basic

Sends a custom developer object, blocking until it has been transmitted.

sendPing(ByteBuffer) - Method in interface javax.websocket.RemoteEndpoint

Send a Ping message containing the given application data to the remote endpoint.

sendPong(ByteBuffer) - Method in interface javax.websocket.RemoteEndpoint

Allows the developer to send an unsolicited Pong message containing the given application data in order to serve as a unidirectional heartbeat for the session.

SendResult - Class in javax.websocket

The result of asynchronously sending a web socket message.

SendResult(Throwable) - Constructor for class javax.websocket.SendResult

Construct a SendResult carrying an exception.

SendResult() - Constructor for class javax.websocket.SendResult

Construct a SendResult signifying a successful send carrying no exception.

sendText(String, SendHandler) - Method in interface javax.websocket.RemoteEndpoint.Async

Initiates the asynchronous transmission of a text message.

sendText(String) - Method in interface javax.websocket.RemoteEndpoint.Async

Initiates the asynchronous transmission of a text message.

sendText(String) - Method in interface javax.websocket.RemoteEndpoint.Basic

Send a text message, blocking until all of the message has been transmitted.

sendText(String, boolean) - Method in interface javax.websocket.RemoteEndpoint.Basic

Send a text message in parts, blocking until all of the message has been transmitted.

Session - Interface in javax.websocket

A Web Socket session represents a conversation between two web socket endpoints.

SessionException - Exception in javax.websocket

A SessionException represents a general exception type reporting problems occurring on a websocket session.

SessionException(String, Throwable, Session) - Constructor for exception javax.websocket.SessionException

Creates a new instance of this exception with the given message, the wrapped cause of the exception and the session with which the problem is associated.

setAsyncSendTimeout(long) - Method in interface javax.websocket.WebSocketContainer

Sets the number of milliseconds the implementation will timeout attempting to send a websocket message for all RemoteEndpoints associated with this container.

setBatchingAllowed(boolean) - Method in interface javax.websocket.RemoteEndpoint

Indicate to the implementation that it is allowed to batch outgoing messages before sending.

setDefaultMaxBinaryMessageBufferSize(int) - Method in interface javax.websocket.WebSocketContainer

Sets the default maximum size of incoming binary message that this container will buffer.

setDefaultMaxSessionIdleTimeout(long) - Method in interface javax.websocket.WebSocketContainer

Sets the default time in milliseconds after which any web socket sessions in this container will be closed if it has been inactive.

setDefaultMaxTextMessageBufferSize(int) - Method in interface javax.websocket.WebSocketContainer

Sets the maximum size of incoming text message that this container will buffer.

setMaxBinaryMessageBufferSize(int) - Method in interface javax.websocket.Session

Sets the maximum length of incoming binary messages that this Session can buffer.

setMaxIdleTimeout(long) - Method in interface javax.websocket.Session

Set the non-zero number of milliseconds before this session will be closed by the container if it is inactive, ie no messages are either sent or received.

setMaxTextMessageBufferSize(int) - Method in interface javax.websocket.Session

Sets the maximum length of incoming text messages that this Session can buffer.

setSendTimeout(long) - Method in interface javax.websocket.RemoteEndpoint.Async

Sets the number of milliseconds the implementation will timeout attempting to send a websocket message.

T

toString() - Method in class javax.websocket.CloseReason

Converts the CloseReason to a debug-friendly string.

V

valueOf(String) - Static method in enum javax.websocket.CloseReason.CloseCodes

Returns the enum constant of this type with the specified name.

values() - Static method in enum javax.websocket.CloseReason.CloseCodes

Returns an array containing the constants of this enum type, in the order they are declared.

W

WebSocketContainer - Interface in javax.websocket

A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.

willDecode(ByteBuffer) - Method in interface javax.websocket.Decoder.Binary

Answer whether the given bytes can be decoded into an object of type T.

willDecode(String) - Method in interface javax.websocket.Decoder.Text

Answer whether the given String can be decoded into an object of type T.

A B C D E F G H I J M O P R S T V W