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

A

addEncoder(Encoder) - Method in interface javax.net.websocket.Session

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

Register to handle to incoming messages in this conversation.

C

checkOrigin(String) - Method in class javax.net.websocket.DefaultServerConfiguration

Makes a check of the validity of the Origin header sent along with the opening handshake.

checkOrigin(String) - Method in interface javax.net.websocket.ServerConfiguration

Check the value of the Origin header (See definition) the client passed during the opening handshake.

ClientConfiguration - Interface in javax.net.websocket

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

ClientContainer - Interface in javax.net.websocket

A ClientContainer is an implementation provided object that allows the developer to initiate a web socket handshake from the provided endpoint.

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

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

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

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

CloseReason - Class in javax.net.websocket

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

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

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

CloseReason.Code - Enum in javax.net.websocket

Enumeration of status codes for a web socket close.

connectToServer(Endpoint, ClientConfiguration) - Method in interface javax.net.websocket.ClientContainer

Connect the supplied endpoint to its server using the supplied handshake parameters

createBinaryContinuationFrame(String, boolean) - Static method in class javax.net.websocket.extensions.FrameBuilder

Create a partial binary frame with the given string fragment, and indication of whether this is the last or not of a series.

createBinaryFrame(String) - Static method in class javax.net.websocket.extensions.FrameBuilder

Create a binary data frame with the given bytes.

createIncomingFrameHandler(FrameHandler) - Method in interface javax.net.websocket.extensions.Extension

The FrameHandler that is invoked for any incoming Frames.

createOutgoingFrameHandler(FrameHandler) - Method in interface javax.net.websocket.extensions.Extension

The FrameHandler that is invoked for any outgoing Frames.

createTextContinuationFrame(String, boolean) - Static method in class javax.net.websocket.extensions.FrameBuilder

Create a partial text frame with the given string fragment, and indication of whether this is the last or not of a series.

createTextFrame(String) - Static method in class javax.net.websocket.extensions.FrameBuilder

Create a text frame with the given string data.

D

decode(byte[]) - Method in interface javax.net.websocket.Decoder.Binary

Decode the given bytes into an object of type T.

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

Decode the given String into an object of type T.

DecodeException - Exception in javax.net.websocket

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

DecodeException() - Constructor for exception javax.net.websocket.DecodeException

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

This interface defines how binary messages are converted.

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

This interface defines how text messages are converted.

DefaultClientConfiguration - Class in javax.net.websocket

The DefaultClientConfiguration is a concrete implementation of a client configuration.

DefaultClientConfiguration(URI) - Constructor for class javax.net.websocket.DefaultClientConfiguration

Creates a client configuration that will attempt to connect to the given URI.

DefaultServerConfiguration - Class in javax.net.websocket

The DefaultServerConfiguration is a concrete class that embodies all the configuration parameters for an endpoint that is to be published as a server endpoint.

DefaultServerConfiguration() - Constructor for class javax.net.websocket.DefaultServerConfiguration

For subclass implementations.

DefaultServerConfiguration(URI) - Constructor for class javax.net.websocket.DefaultServerConfiguration

Creates a server configuration with the given URI.

E

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

Encode the given object into a byte array.

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

Encode the given object into a String.

EncodeException - Exception in javax.net.websocket

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

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

Encoder - Interface in javax.net.websocket

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

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

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

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

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

Endpoint - Class in javax.net.websocket

The Web Socket Endpoint represents and object that can handle web socket conversations.

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

EndpointConfiguration - Interface in javax.net.websocket

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

ERROR - Variable in class javax.net.websocket.SendResult

There was a problem sending the message.

Extension - Interface in javax.net.websocket.extensions

The Extension interface represents a web socket extension.

F

Frame - Interface in javax.net.websocket.extensions

Frame is the top level interface that represents some kind of web socket frame.

Frame.Control - Interface in javax.net.websocket.extensions

Super type for all the websocket control frames.

Frame.Control.Close - Interface in javax.net.websocket.extensions

A web socket Close frame.

Frame.Control.Ping - Interface in javax.net.websocket.extensions

A web socket Ping frame.

Frame.Control.Pong - Interface in javax.net.websocket.extensions

A web socket Pong frame.

Frame.Data - Interface in javax.net.websocket.extensions

Common super-type for all the web socket frames that carry application data.

Frame.Data.Binary - Interface in javax.net.websocket.extensions

A binary data frame

Frame.Data.Binary.Continuation - Interface in javax.net.websocket.extensions

A kind of binary frame that represents a fragment of a message in a series of such frames that, re-assembled, form a complete text message.

Frame.Data.Text - Interface in javax.net.websocket.extensions

A text data frame.

Frame.Data.Text.Continuation - Interface in javax.net.websocket.extensions

A kind of text frame that represents a fragment of a message in a series of such frames that, re-assembled, form a complete text message.

FrameBuilder - Class in javax.net.websocket.extensions

A factory class for building Frames.

FrameBuilder() - Constructor for class javax.net.websocket.extensions.FrameBuilder

FrameHandler - Class in javax.net.websocket.extensions

A FrameHandler is a link in the chain of handlers associated with the web socket extensions configured for an endpoint.

FrameHandler(FrameHandler) - Constructor for class javax.net.websocket.extensions.FrameHandler

Constructor that creates a FrameHandler with the given framehandler as the next frame handler in the chain.

G

getActiveSessions() - Method in interface javax.net.websocket.ClientContainer

Return an unordered collection of the currently active web socket sessions.

getApplicationData() - Method in interface javax.net.websocket.extensions.Frame.Control.Ping

The application data within the Ping frame.

getApplicationData() - Method in interface javax.net.websocket.extensions.Frame.Control.Pong

The application data within the Pong frame.

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

getCloseCode() - Method in interface javax.net.websocket.extensions.Frame.Control.Close

The close code for this close.

getCloseStatus() - Method in interface javax.net.websocket.Session

If this session is no longer active, returns the reason for closure.

getCode() - Method in enum javax.net.websocket.CloseReason.Code

Return the code number of this status code.

getData() - Method in interface javax.net.websocket.extensions.Frame.Data.Binary

The application data in the binary frame.

getDecoders() - Method in class javax.net.websocket.DefaultClientConfiguration

Assign the list of decoders this client will use.

getDecoders() - Method in class javax.net.websocket.DefaultServerConfiguration

Return the Decoder implementations configured.

getDecoders() - Method in interface javax.net.websocket.EndpointConfiguration

Return the Decoder implementations configured.

getEncoders() - Method in class javax.net.websocket.DefaultClientConfiguration

Assign the list of encoders this client will use.

getEncoders() - Method in class javax.net.websocket.DefaultServerConfiguration

Return the Decoder implementations configured.

getEncoders() - Method in interface javax.net.websocket.EndpointConfiguration

Return the Encoder implementations configured.

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

The problem sending the message.

getExtensionData() - Method in interface javax.net.websocket.extensions.Frame.Data

Return data used by a web socket extension in this frame.

getExtensions() - Method in interface javax.net.websocket.ClientConfiguration

Return the list of all the extensions that this client supports.

getExtensions() - Method in class javax.net.websocket.DefaultClientConfiguration

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

getHeaders() - Method in interface javax.net.websocket.HandshakeRequest

Return the list of Http Headers that came with the handshake request.

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

Return the list of Http Headers that came with the handshake request.

getInactiveTime() - Method in interface javax.net.websocket.Session

Return the number of seconds since the underlying connection had any activity.

getMaxBinaryMessageBufferSize() - Method in interface javax.net.websocket.ClientContainer

Returns the maximum size of binary message in number of bytes that this container will buffer.

getMaximumMessageSize() - Method in interface javax.net.websocket.Session

The maximum total length of messages, text or binary, that this Session can handle.

getMaxSessionIdleTimeout() - Method in interface javax.net.websocket.ClientContainer

Return the maximum time in seconds that a web socket session may be idle before the container may close it.

getMaxTextMessageBufferSize() - Method in interface javax.net.websocket.ClientContainer

Sets the maximum size of text message in number of bytes that this container will buffer.

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

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

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

The name of this extension.

getNegotiatedExtensions(List<Extension>) - Method in class javax.net.websocket.DefaultServerConfiguration

Provides a simple algorithm to return the list of extensions this server will use for the web socket session: the configuration returns a list containing all of the requested extensions passed to this method that it supports, using the order in the requested extensions.

getNegotiatedExtensions(List<Extension>) - Method in interface javax.net.websocket.ServerConfiguration

Return the ordered list of extensions that this server will support given the requested extension list passed in.

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

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

getNegotiatedSubprotocol(List<String>) - Method in class javax.net.websocket.DefaultServerConfiguration

Return the subprotocol this server endpoint has chosen from the requested list supplied by a client who wishes to connect, or none if there wasn't one this server endpoint liked.

getNegotiatedSubprotocol(List<String>) - Method in interface javax.net.websocket.ServerConfiguration

Return the subprotocol this server endpoint has chosen from the requested list supplied by a client who wishes to connect, or none if there wasn't one this server endpoint liked.

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

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

getNextHandler() - Method in class javax.net.websocket.extensions.FrameHandler

The next handler in the handler chain.

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

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

The map name value pairs that are the web socket extension parameters for this extension.

getPreferredSubprotocols() - Method in interface javax.net.websocket.ClientConfiguration

The ordered list of sub protocols a client endpoint would like to use.

getPreferredSubprotocols() - Method in class javax.net.websocket.DefaultClientConfiguration

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

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

Returns the version of the websocket protocol currently being used.

getReasonPhrase() - Method in interface javax.net.websocket.extensions.Frame.Control.Close

The reason phrase for this close.

getRemote() - Method in interface javax.net.websocket.Session

Return a reference to the RemoteEndpoint object representing the other end of this conversation.

getRemote(Class) - Method in interface javax.net.websocket.Session

Return a reference to the RemoteEndpoint that can send messages in the form of objects of class c.

getRequestURI() - Method in interface javax.net.websocket.HandshakeRequest

Return the request URI of the handshake request.

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

Return the URI that this session was opened under.

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

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

getSession() - Method in interface javax.net.websocket.Session

Return a reference to the HttpSession that the web socket handshake that started this conversation was part of, if applicable.

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

getText() - Method in interface javax.net.websocket.extensions.Frame.Data.Text

Return the textual data in this text frame.

getTimeout() - Method in interface javax.net.websocket.Session

Return the number of seconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received in that time.

getUserPrincipal() - Method in interface javax.net.websocket.HandshakeRequest

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

H

handleFrame(Frame) - Method in class javax.net.websocket.extensions.FrameHandler

This method is invoked whenever the implementation is ready to invoke this framehandler as part of the framehandler chain.

HandshakeRequest - Interface in javax.net.websocket

The handshake request represents the web socket defined Http request that for the opening handshake of a web socket session.

HandshakeResponse - Interface in javax.net.websocket

The handshake response represents the web socket defined http response that will be sent by the web socket server during the opening handshake.

I

isActive() - Method in interface javax.net.websocket.Session

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

isLast() - Method in interface javax.net.websocket.extensions.Frame.Data.Binary.Continuation

Indicates whether this text message fragment is the last in the series or not.

isLast() - Method in interface javax.net.websocket.extensions.Frame.Data.Text.Continuation

Indicates whether this text message fragment is the last in the series or not.

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

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

J

javax.net.websocket - package javax.net.websocket

javax.net.websocket.annotations - package javax.net.websocket.annotations

javax.net.websocket.extensions - package javax.net.websocket.extensions

M

matchesURI(URI) - Method in class javax.net.websocket.DefaultServerConfiguration

A URI is a match if and only if it is an exact match (.equals()) the URI used to create this configuration.

matchesURI(URI) - Method in interface javax.net.websocket.ServerConfiguration

Answers whether the current configuration matches the given URI.

MessageHandler - Interface in javax.net.websocket

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

MessageHandler.AsyncBinary - Interface in javax.net.websocket

This kind of handler is called to process for binary messages which may arrive in multiple parts.

MessageHandler.AsyncText - Interface in javax.net.websocket

This kind of handler is called to process for text messages which may arrive in multiple parts.

MessageHandler.Binary - Interface in javax.net.websocket

This kind of listener listens for binary messages.

MessageHandler.BinaryStream - Interface in javax.net.websocket

This kind of handler is called when a new binary message arrives that is to be read using a blocking stream.

MessageHandler.CharacterStream - Interface in javax.net.websocket

This kind of handler is called when a new text message arrives that is to be read using a blocking stream.

MessageHandler.DecodedObject<T> - Interface in javax.net.websocket

This kind of listener listens for messages that the container knows how to decode into an object of type T.

MessageHandler.Pong - Interface in javax.net.websocket

This handler is called back by the container when the container receives a pong message.

MessageHandler.Text - Interface in javax.net.websocket

This kind of listener listens for text messages.

modifyHandshake(HandshakeRequest, HandshakeResponse) - Method in class javax.net.websocket.DefaultServerConfiguration

The default server configuration does not make any changes to the response.

modifyHandshake(HandshakeRequest, HandshakeResponse) - Method in interface javax.net.websocket.ServerConfiguration

Called by the container after it has formulated a handshake response resulting from a well-formed handshake request.

O

OK - Variable in class javax.net.websocket.SendResult

The message was transmitted ok.

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

Developers may implement this method to be notified when an active conversation has just been terminated.

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

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

onMessage(byte[]) - Method in interface javax.net.websocket.MessageHandler.Binary

Called when the binary message has been fully received.

onMessage(InputStream) - Method in interface javax.net.websocket.MessageHandler.BinaryStream

This method is called when a new binary message has begun to arrive.

onMessage(Reader) - Method in interface javax.net.websocket.MessageHandler.CharacterStream

This method is called when a new text message has begun to arrive.

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

Called when the container receives a message that it has been able to decode into an object of type T.

onMessage(String) - Method in interface javax.net.websocket.MessageHandler.Text

Called when the text message has been fully received.

onMessagePart(byte[], boolean) - Method in interface javax.net.websocket.MessageHandler.AsyncBinary

Called when part of a binary message has been received.

onMessagePart(String, boolean) - Method in interface javax.net.websocket.MessageHandler.AsyncText

Called when part of a text message has been received.

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

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

onPong(byte[]) - Method in interface javax.net.websocket.MessageHandler.Pong

Called when the container receives a pong message containing the given application data.

P

publishServer(Endpoint, ServerConfiguration) - Method in interface javax.net.websocket.ServerContainer

Publish the given endpoint with the provided configuration information.

R

RemoteEndpoint<T> - Interface in javax.net.websocket

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

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

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

S

sendBytes(byte[]) - Method in interface javax.net.websocket.RemoteEndpoint

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

sendBytes(byte[], SendHandler) - Method in interface javax.net.websocket.RemoteEndpoint

Initiates the asynchronous transmission of a binary message.

SendHandler - Interface in javax.net.websocket

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

sendObject(T) - Method in interface javax.net.websocket.RemoteEndpoint

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

sendObject(T, SendHandler) - Method in interface javax.net.websocket.RemoteEndpoint

Initiates the transmission of a custom developer object.

sendPartialBytes(byte[], boolean) - Method in interface javax.net.websocket.RemoteEndpoint

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

sendPartialString(String, boolean) - Method in interface javax.net.websocket.RemoteEndpoint

sendPing(byte[]) - Method in interface javax.net.websocket.RemoteEndpoint

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

sendPong(byte[]) - Method in interface javax.net.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.net.websocket

The result of asynchronously sending a web socket message.

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

sendString(String) - Method in interface javax.net.websocket.RemoteEndpoint

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

sendString(String, SendHandler) - Method in interface javax.net.websocket.RemoteEndpoint

Initiates the asynchronous transmission of a text message.

sentOK() - Method in class javax.net.websocket.SendResult

Determines if this result is ok or not.

ServerConfiguration - Interface in javax.net.websocket

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

ServerContainer - Interface in javax.net.websocket

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.

Session - Interface in javax.net.websocket

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

setDecoders(List<Decoder>) - Method in class javax.net.websocket.DefaultClientConfiguration

Assign the list of decoders this client will use.

setDecoders(List<Decoder>) - Method in class javax.net.websocket.DefaultServerConfiguration

Sets all the decoders that this configuration will support.

setEncoders(List<Encoder>) - Method in class javax.net.websocket.DefaultClientConfiguration

Assign the list of encoders this client will use.

setEncoders(List<Encoder>) - Method in class javax.net.websocket.DefaultServerConfiguration

setExtensions(List<Extension>) - Method in class javax.net.websocket.DefaultClientConfiguration

Assign the List of preferred subprotocols that this client would like to use.

setExtensions(List<Extension>) - Method in class javax.net.websocket.DefaultServerConfiguration

Sets all the extensions that this configuration will support.

setMaxBinaryMessageBufferSize(long) - Method in interface javax.net.websocket.ClientContainer

Sets the maximum size of binary message in number of bytes that this container will buffer.

setMaximumMessageSize(long) - Method in interface javax.net.websocket.Session

Sets the maximum total length of messages, text or binary, that this Session can handle.

setMaxSessionIdleTimeout(long) - Method in interface javax.net.websocket.ClientContainer

Sets the maximum time in seconds that a web socket session may be idle before the container may close it.

setMaxTextMessageBufferSize(long) - Method in interface javax.net.websocket.ClientContainer

Returns the maximum size of text message in number of bytes that this container will buffer.

setPreferredSubprotocols(List<String>) - Method in class javax.net.websocket.DefaultClientConfiguration

Assign the List of preferred subprotocols that this client would like to use.

setResult(SendResult) - Method in interface javax.net.websocket.SendHandler

Called once the message has been transmitted.

setSubprotocols(List<String>) - Method in class javax.net.websocket.DefaultServerConfiguration

Sets all the subprotocols that this configuration will support.

setTimeout(long) - Method in interface javax.net.websocket.Session

Set the number of seconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received.

V

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

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

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

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

W

WebSocketClose - Annotation Type in javax.net.websocket.annotations

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 - Annotation Type in javax.net.websocket.annotations

This class level annotation declares that the class it decorates is a web socket endpoint.

WebSocketMessage - Annotation Type in javax.net.websocket.annotations

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

WebSocketOpen - Annotation Type in javax.net.websocket.annotations

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.

willDecode(byte[]) - Method in interface javax.net.websocket.Decoder.Binary

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

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

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

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