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

A

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

Register to handle to incoming messages in this conversation.

C

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

Makes a check of the validity of the Origin header sent along with the opening handshake following the recommendation at: http://tools.ietf.org/html/rfc6455#section-4.2 .

checkOrigin(String) - Method in interface javax.websocket.ServerEndpointConfiguration

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

ClientContainer - Interface in javax.websocket

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

ClientEndpointConfiguration - Interface in javax.websocket

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

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.

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

Connect the supplied annotated object to its server using the supplied handshake parameters.

ContainerProvider - Class in javax.websocket

Provider class that uses the ServiceLoader mechanism to provide implementations of ServerContainer and ClientContainer.

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

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 data being 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 data being 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.

DefaultClientConfiguration - Class in javax.websocket

The DefaultClientConfiguration is a concrete implementation of a client configuration.

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

Creates a client configuration with no preferred sub protocols, extensions, decoders or encoders.

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

For subclass implementations.

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

Creates a server configuration with the given path

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.

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 interfaces 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.

Endpoint - Class in javax.websocket

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

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

EndpointConfiguration - Interface in javax.websocket

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

G

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

Return a copy of the Set of the currently active web socket sessions.

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

The application data inside the ping message from the peer.

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

Return the ByteBuffer that cannot be decoded.

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

Obtains a reference to the (singleton) ClientContainer implementation.

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.

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

Return the container that this session is part of.

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

Assign the list of decoders this client will use.

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

Return the Decoder implementations configured.

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

Return the Decoder implementations configured, the empty list if none.

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

Assign the list of encoders this client will use.

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

Return the Encoder implementations configured.

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

Return the Encoder implementations configured, the empty list if none.

getEndpointConfiguration() - Method in class javax.websocket.Endpoint

Developers must provide an EndpointConfiguration so that the container it is deployed in can configure it.

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

The problem sending the message.

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

http://java.net/jira/browse/WEBSOCKET_SPEC-45 Return the list of all the extensions that this client supports, the empty list if there are none.

getExtensions() - Method in class javax.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.websocket.HandshakeRequest

Return the read only Map of Http Headers that came with the handshake request.

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

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

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

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

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

Return the set of Extensions installed in the container.

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

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

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

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

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

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

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

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

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

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

getNegotiatedExtensions(List<String>) - Method in class javax.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, the empty list if none.

getNegotiatedExtensions(List<String>) - Method in interface javax.websocket.ServerEndpointConfiguration

http://java.net/jira/browse/WEBSOCKET_SPEC-45 Return the ordered list of extensions that this server will support given the requested extension list passed in, the empty list if none.

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

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

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

The default implementation of this method returns, the first subprotocol in the list sent by the client that the server supports, or null if there isn't one none.

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

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.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.

getParameterMap() - Method in interface javax.websocket.HandshakeRequest

Return the request parameters associated with the request.

getPath() - Method in class javax.websocket.DefaultServerConfiguration

Return the path of this server configuration.

getPath() - Method in interface javax.websocket.ServerEndpointConfiguration

Return the path for this endpoint configuration.

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

Return a map of the path parameter names and values used if the server endpoint was deployed with a URI-template and the client connected with a particular matching URL.

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

The ordered list of sub protocols a client endpoint would like to use, the empty list if there are none.

getPreferredSubprotocols() - Method in class javax.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.websocket.Session

Returns the version of the websocket protocol currently being used.

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

Return the query string associated with the request.

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.

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

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

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.HandshakeRequest

Return the request URI of the handshake request.

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

Return the URI that this session was opened under.

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

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

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

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

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

Obtains a reference to the (singletone) ServerContainer implementation.

getSession() - Method in interface javax.websocket.HandshakeRequest

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.websocket.DecodeException

Return the encoded string that cannot be decoded.

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

Return the number of milliseconds 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.websocket.HandshakeRequest

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

H

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

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

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

Determines if this result is ok or not.

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

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

isUserInRole(String) - Method in interface javax.websocket.HandshakeRequest

Checks whether the current user is in the given role.

J

javax.websocket - package javax.websocket

M

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

This default implementation matches the incoming path to the configuration's URI or URI template if and only if it is an exact match in the case the configuration is a URI, and if and only if it is a valid expansion of the configuration URI template, in the case where the configuration is a URI template.

matchesURI(URI) - Method in interface javax.websocket.ServerEndpointConfiguration

Answers whether the current configuration matches the given path.

MessageHandler - Interface in javax.websocket

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

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

This kind of listener listens is notified by the container as parts of a message arrive.

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

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

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

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

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

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

O

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

This method is called when the session with the client is terminated.

onError(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.

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

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

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

Called when the message has been fully received.

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

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

P

PingMessage - Interface in javax.websocket

The PingMessage interface represents a web socket ping.

publishServer(Class<? extends Endpoint>) - Method in interface javax.websocket.ServerContainer

Publish the given endpoint with the provided configuration information.

R

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

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

S

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

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

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

Initiates the asynchronous transmission of a binary message.

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

Initiates the asynchronous transmission of a binary message.

SendHandler - Interface in javax.websocket

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

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

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

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

Initiates the asynchronous transmission of a custom developer object.

sendObjectByFuture(Object) - Method in interface javax.websocket.RemoteEndpoint

Initiates the asynchronous transmission of a custom developer object.

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

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

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

Send a text message in pieces, blocking until all of the message 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 an no exception.

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

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

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

Initiates the asynchronous transmission of a text message.

sendStringByFuture(String) - Method in interface javax.websocket.RemoteEndpoint

Initiates the asynchronous transmission of a text message.

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

ServerEndpointConfiguration - Interface in javax.websocket

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

Session - Interface in javax.websocket

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

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

Assign the list of decoders this client will use.

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

Sets all the decoders that this configuration will support.

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

Assign the list of encoders this client will use.

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

Sets all the encoders that this configuration will support.

setEncoders(List<Encoder>) - Method in interface javax.websocket.Session

Sets the list of encoders to be used in this session in order of preference.

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

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

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

Sets all the extensions that this configuration will support.

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

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

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

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

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

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

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

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

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

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

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

Called once the message has been transmitted.

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

Sets all the subprotocols that this configuration will support.

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

Set the number of milliseconds 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.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

WebSocketClient - Annotation Type in javax.websocket

The WebSocketClient annotation a class level annotation is used to denote that a POJO is a web socket client and can be deployed as such.

WebSocketClose - 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 has closed.

WebSocketEndpoint - Annotation Type in javax.websocket

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.

WebSocketError - 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.

WebSocketMessage - Annotation Type in javax.websocket

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

WebSocketOpen - 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.

WebSocketPathParam - Annotation Type in javax.websocket

This annotation may be used to annotate method parameters on server side web socket POJOs where a URI-template has been used in the path-mapping of the WebSocketEndpoint annotation.

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 C D E G H I J M O P R S V W