WebSocket 1.0 - Apache Tomcat 7.0.55
A B C D E F G H I J M O P R S T V W 

A

addEndpoint(Class<?>) - Method in interface javax.websocket.server.ServerContainer
 
addEndpoint(ServerEndpointConfig) - Method in interface javax.websocket.server.ServerContainer
 
addMessageHandler(MessageHandler) - Method in interface javax.websocket.Session
 
afterResponse(HandshakeResponse) - Method in class javax.websocket.ClientEndpointConfig.Configurator
Provides the client with a mechanism to inspect the handshake response that is returned from the server.

B

beforeRequest(Map<String, List<String>>) - Method in class javax.websocket.ClientEndpointConfig.Configurator
Provides the client with a mechanism to inspect and/or modify the headers that are sent to the server to start the WebSocket handshake.
build() - Method in class javax.websocket.ClientEndpointConfig.Builder
 
build() - Method in class javax.websocket.server.ServerEndpointConfig.Builder
 

C

checkOrigin(String) - Method in class javax.websocket.server.ServerEndpointConfig.Configurator
 
ClientEndpoint - Annotation Type in javax.websocket
 
ClientEndpointConfig - Interface in javax.websocket
 
ClientEndpointConfig.Builder - Class in javax.websocket
 
ClientEndpointConfig.Configurator - Class in javax.websocket
 
ClientEndpointConfig.Configurator() - Constructor for class javax.websocket.ClientEndpointConfig.Configurator
 
close() - Method in interface javax.websocket.Session
Close the connection to the remote end point using the code CloseReason.CloseCodes.NORMAL_CLOSURE and an empty reason phrase.
close(CloseReason) - Method in interface javax.websocket.Session
Close the connection to the remote end point using the specified code and reason phrase.
CloseReason - Class in javax.websocket
 
CloseReason(CloseReason.CloseCode, String) - Constructor for class javax.websocket.CloseReason
 
CloseReason.CloseCode - Interface in javax.websocket
 
CloseReason.CloseCodes - Enum in javax.websocket
 
configurator(ClientEndpointConfig.Configurator) - Method in class javax.websocket.ClientEndpointConfig.Builder
 
configurator(ServerEndpointConfig.Configurator) - Method in class javax.websocket.server.ServerEndpointConfig.Builder
 
connectToServer(Object, URI) - Method in interface javax.websocket.WebSocketContainer
 
connectToServer(Class<?>, URI) - Method in interface javax.websocket.WebSocketContainer
 
connectToServer(Endpoint, ClientEndpointConfig, URI) - Method in interface javax.websocket.WebSocketContainer
Creates a new connection to the WebSocket.
connectToServer(Class<? extends Endpoint>, ClientEndpointConfig, URI) - Method in interface javax.websocket.WebSocketContainer
Creates a new connection to the WebSocket.
ContainerProvider - Class in javax.websocket
Use the ServiceLoader mechanism to provide instances of the WebSocket client container.
ContainerProvider() - Constructor for class javax.websocket.ContainerProvider
 
create() - Static method in class javax.websocket.ClientEndpointConfig.Builder
 
create(Class<?>, String) - Static method in class javax.websocket.server.ServerEndpointConfig.Builder
 

D

decode(ByteBuffer) - Method in interface javax.websocket.Decoder.Binary
 
decode(InputStream) - Method in interface javax.websocket.Decoder.BinaryStream
 
decode(String) - Method in interface javax.websocket.Decoder.Text
 
decode(Reader) - Method in interface javax.websocket.Decoder.TextStream
 
DecodeException - Exception in javax.websocket
 
DecodeException(ByteBuffer, String, Throwable) - Constructor for exception javax.websocket.DecodeException
 
DecodeException(String, String, Throwable) - Constructor for exception javax.websocket.DecodeException
 
DecodeException(ByteBuffer, String) - Constructor for exception javax.websocket.DecodeException
 
DecodeException(String, String) - Constructor for exception javax.websocket.DecodeException
 
Decoder - Interface in javax.websocket
 
Decoder.Binary<T> - Interface in javax.websocket
 
Decoder.BinaryStream<T> - Interface in javax.websocket
 
Decoder.Text<T> - Interface in javax.websocket
 
Decoder.TextStream<T> - Interface in javax.websocket
 
decoders(List<Class<? extends Decoder>>) - Method in class javax.websocket.ClientEndpointConfig.Builder
 
decoders(List<Class<? extends Decoder>>) - Method in class javax.websocket.server.ServerEndpointConfig.Builder
 
DeploymentException - Exception in javax.websocket
 
DeploymentException(String) - Constructor for exception javax.websocket.DeploymentException
 
DeploymentException(String, Throwable) - Constructor for exception javax.websocket.DeploymentException
 
destroy() - Method in interface javax.websocket.Decoder
 
destroy() - Method in interface javax.websocket.Encoder
 

E

encode(T) - Method in interface javax.websocket.Encoder.Binary
 
encode(T, OutputStream) - Method in interface javax.websocket.Encoder.BinaryStream
 
encode(T) - Method in interface javax.websocket.Encoder.Text
 
encode(T, Writer) - Method in interface javax.websocket.Encoder.TextStream
 
EncodeException - Exception in javax.websocket
 
EncodeException(Object, String) - Constructor for exception javax.websocket.EncodeException
 
EncodeException(Object, String, Throwable) - Constructor for exception javax.websocket.EncodeException
 
Encoder - Interface in javax.websocket
 
Encoder.Binary<T> - Interface in javax.websocket
 
Encoder.BinaryStream<T> - Interface in javax.websocket
 
Encoder.Text<T> - Interface in javax.websocket
 
Encoder.TextStream<T> - Interface in javax.websocket
 
encoders(List<Class<? extends Encoder>>) - Method in class javax.websocket.ClientEndpointConfig.Builder
 
encoders(List<Class<? extends Encoder>>) - Method in class javax.websocket.server.ServerEndpointConfig.Builder
 
Endpoint - Class in javax.websocket
 
Endpoint() - Constructor for class javax.websocket.Endpoint
 
EndpointConfig - Interface in javax.websocket
 
Extension - Interface in javax.websocket
 
Extension.Parameter - Interface in javax.websocket
 
extensions(List<Extension>) - Method in class javax.websocket.ClientEndpointConfig.Builder
 
extensions(List<Extension>) - Method in class javax.websocket.server.ServerEndpointConfig.Builder
 

F

flushBatch() - Method in interface javax.websocket.RemoteEndpoint
Flush any currently batched messages to the remote endpoint.

G

getAnnotatedEndpointClasses(Set<Class<?>>) - Method in interface javax.websocket.server.ServerApplicationConfig
Enables applications to filter the discovered classes annotated with ServerEndpoint.
getApplicationData() - Method in interface javax.websocket.PongMessage
Obtain the payload of the Pong message as a ByteBuffer.
getAsyncRemote() - Method in interface javax.websocket.Session
 
getBasicRemote() - Method in interface javax.websocket.Session
 
getBatchingAllowed() - Method in interface javax.websocket.RemoteEndpoint
Obtains the current batching status of the endpoint.
getBytes() - Method in exception javax.websocket.DecodeException
 
getCloseCode(int) - Static method in enum javax.websocket.CloseReason.CloseCodes
 
getCloseCode() - Method in class javax.websocket.CloseReason
 
getCode() - Method in interface javax.websocket.CloseReason.CloseCode
 
getCode() - Method in enum javax.websocket.CloseReason.CloseCodes
 
getConfigurator() - Method in interface javax.websocket.ClientEndpointConfig
 
getConfigurator() - Method in interface javax.websocket.server.ServerEndpointConfig
 
getContainer() - Method in class javax.websocket.ContainerProvider
 
getContainer() - Method in interface javax.websocket.Session
Returns the container that created this session.
getDecoders() - Method in interface javax.websocket.EndpointConfig
 
getDefaultAsyncSendTimeout() - Method in interface javax.websocket.WebSocketContainer
Obtain the default timeout (in milliseconds) for sending a message asynchronously.
getDefaultMaxBinaryMessageBufferSize() - Method in interface javax.websocket.WebSocketContainer
Get the default maximum buffer size (in bytes) for binary messages.
getDefaultMaxSessionIdleTimeout() - Method in interface javax.websocket.WebSocketContainer
Get the current default session idle timeout in milliseconds.
getDefaultMaxTextMessageBufferSize() - Method in interface javax.websocket.WebSocketContainer
Get the default maximum buffer size (in characters) for text messages.
getEncoders() - Method in interface javax.websocket.EndpointConfig
 
getEndpointClass() - Method in interface javax.websocket.server.ServerEndpointConfig
 
getEndpointConfigs(Set<Class<? extends Endpoint>>) - Method in interface javax.websocket.server.ServerApplicationConfig
Enables applications to filter the discovered implementations of ServerEndpointConfig.
getEndpointInstance(Class<T>) - Method in class javax.websocket.server.ServerEndpointConfig.Configurator
 
getException() - Method in class javax.websocket.SendResult
 
getExtensions() - Method in interface javax.websocket.ClientEndpointConfig
 
getExtensions() - Method in interface javax.websocket.server.ServerEndpointConfig
 
getHeaders() - Method in interface javax.websocket.HandshakeResponse
 
getHeaders() - Method in interface javax.websocket.server.HandshakeRequest
 
getHttpSession() - Method in interface javax.websocket.server.HandshakeRequest
Get the HTTP Session object associated with this request.
getId() - Method in interface javax.websocket.Session
Provides a unique identifier for the session.
getInstalledExtensions() - Method in interface javax.websocket.WebSocketContainer
Get the set of extensions that are supported by this WebSocket implementation.
getMaxBinaryMessageBufferSize() - Method in interface javax.websocket.Session
Get the current maximum buffer size (in bytes) for binary messages.
getMaxIdleTimeout() - Method in interface javax.websocket.Session
Get the idle timeout for this session in milliseconds.
getMaxTextMessageBufferSize() - Method in interface javax.websocket.Session
Get the current maximum buffer size (in characters) for text messages.
getMessageHandlers() - Method in interface javax.websocket.Session
 
getName() - Method in interface javax.websocket.Extension
 
getName() - Method in interface javax.websocket.Extension.Parameter
 
getNegotiatedExtensions(List<Extension>, List<Extension>) - Method in class javax.websocket.server.ServerEndpointConfig.Configurator
 
getNegotiatedExtensions() - Method in interface javax.websocket.Session
 
getNegotiatedSubprotocol(List<String>, List<String>) - Method in class javax.websocket.server.ServerEndpointConfig.Configurator
 
getNegotiatedSubprotocol() - Method in interface javax.websocket.Session
 
getObject() - Method in exception javax.websocket.EncodeException
 
getOpenSessions() - Method in interface javax.websocket.Session
Obtain the set of currently open sessions for the local endpoint that this session is associated with.
getParameterMap() - Method in interface javax.websocket.server.HandshakeRequest
 
getParameters() - Method in interface javax.websocket.Extension
 
getPath() - Method in interface javax.websocket.server.ServerEndpointConfig
Returns the path at which this WebSocket server endpoint has been registered.
getPathParameters() - Method in interface javax.websocket.Session
 
getPreferredSubprotocols() - Method in interface javax.websocket.ClientEndpointConfig
 
getProtocolVersion() - Method in interface javax.websocket.Session
 
getQueryString() - Method in interface javax.websocket.server.HandshakeRequest
 
getQueryString() - Method in interface javax.websocket.Session
 
getReasonPhrase() - Method in class javax.websocket.CloseReason
 
getRequestParameterMap() - Method in interface javax.websocket.Session
 
getRequestURI() - Method in interface javax.websocket.server.HandshakeRequest
 
getRequestURI() - Method in interface javax.websocket.Session
 
getSendStream() - Method in interface javax.websocket.RemoteEndpoint.Basic
 
getSendTimeout() - Method in interface javax.websocket.RemoteEndpoint.Async
Obtain the timeout (in milliseconds) for sending a message asynchronously.
getSendWriter() - Method in interface javax.websocket.RemoteEndpoint.Basic
 
getSession() - Method in exception javax.websocket.SessionException
 
getSubprotocols() - Method in interface javax.websocket.server.ServerEndpointConfig
 
getText() - Method in exception javax.websocket.DecodeException
 
getUserPrincipal() - Method in interface javax.websocket.server.HandshakeRequest
 
getUserPrincipal() - Method in interface javax.websocket.Session
 
getUserProperties() - Method in interface javax.websocket.EndpointConfig
 
getUserProperties() - Method in interface javax.websocket.Session
 
getValue() - Method in interface javax.websocket.Extension.Parameter
 
getWebSocketContainer() - Static method in class javax.websocket.ContainerProvider
Create a new container used to create outgoing WebSocket connections.

H

HandshakeRequest - Interface in javax.websocket.server
Represents the HTTP request that asked to be upgraded to WebSocket.
HandshakeResponse - Interface in javax.websocket
 

I

init(EndpointConfig) - Method in interface javax.websocket.Decoder
 
init(EndpointConfig) - Method in interface javax.websocket.Encoder
 
isOK() - Method in class javax.websocket.SendResult
 
isOpen() - Method in interface javax.websocket.Session
 
isSecure() - Method in interface javax.websocket.Session
 
isUserInRole(String) - Method in interface javax.websocket.server.HandshakeRequest
 

J

javax.websocket - package javax.websocket
 
javax.websocket.server - package javax.websocket.server
 

M

MessageHandler - Interface in javax.websocket
 
MessageHandler.Partial<T> - Interface in javax.websocket
 
MessageHandler.Whole<T> - Interface in javax.websocket
 
modifyHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse) - Method in class javax.websocket.server.ServerEndpointConfig.Configurator
 

O

onClose(Session, CloseReason) - Method in class javax.websocket.Endpoint
Event that is triggered when a session has closed.
OnClose - Annotation Type in javax.websocket
 
onError(Session, Throwable) - Method in class javax.websocket.Endpoint
Event that is triggered when a protocol error occurs.
OnError - Annotation Type in javax.websocket
 
onMessage(T, boolean) - Method in interface javax.websocket.MessageHandler.Partial
Called when part of a message is available to be processed.
onMessage(T) - Method in interface javax.websocket.MessageHandler.Whole
Called when a whole message is available to be processed.
OnMessage - Annotation Type in javax.websocket
 
onOpen(Session, EndpointConfig) - Method in class javax.websocket.Endpoint
Event that is triggered when a new session starts.
OnOpen - Annotation Type in javax.websocket
 
onResult(SendResult) - Method in interface javax.websocket.SendHandler
 

P

PathParam - Annotation Type in javax.websocket.server
Used to annotate method parameters on POJO endpoints the the ServerEndpoint has been defined with a ServerEndpoint.value() that uses a URI template.
PongMessage - Interface in javax.websocket
Represents a WebSocket Pong message and used by message handlers to enable applications to process the response to any Pings they send.
preferredSubprotocols(List<String>) - Method in class javax.websocket.ClientEndpointConfig.Builder
 

R

RemoteEndpoint - Interface in javax.websocket
 
RemoteEndpoint.Async - Interface in javax.websocket
 
RemoteEndpoint.Basic - Interface in javax.websocket
 
removeMessageHandler(MessageHandler) - Method in interface javax.websocket.Session
 

S

SEC_WEBSOCKET_ACCEPT - Static variable in interface javax.websocket.HandshakeResponse
Name of the WebSocket accept HTTP header.
SEC_WEBSOCKET_EXTENSIONS - Static variable in interface javax.websocket.server.HandshakeRequest
 
SEC_WEBSOCKET_KEY - Static variable in interface javax.websocket.server.HandshakeRequest
 
SEC_WEBSOCKET_PROTOCOL - Static variable in interface javax.websocket.server.HandshakeRequest
 
SEC_WEBSOCKET_VERSION - Static variable in interface javax.websocket.server.HandshakeRequest
 
sendBinary(ByteBuffer) - Method in interface javax.websocket.RemoteEndpoint.Async
Send the message asynchronously, using the Future to signal to the client when the message has been sent.
sendBinary(ByteBuffer, SendHandler) - Method in interface javax.websocket.RemoteEndpoint.Async
Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.
sendBinary(ByteBuffer) - Method in interface javax.websocket.RemoteEndpoint.Basic
Send the message, blocking until the message is sent.
sendBinary(ByteBuffer, boolean) - Method in interface javax.websocket.RemoteEndpoint.Basic
Sends part of a binary message to the remote endpoint.
SendHandler - Interface in javax.websocket
 
sendObject(Object) - Method in interface javax.websocket.RemoteEndpoint.Async
 
sendObject(Object, SendHandler) - Method in interface javax.websocket.RemoteEndpoint.Async
 
sendObject(Object) - Method in interface javax.websocket.RemoteEndpoint.Basic
 
sendPing(ByteBuffer) - Method in interface javax.websocket.RemoteEndpoint
Send a ping message blocking until the message has been sent.
sendPong(ByteBuffer) - Method in interface javax.websocket.RemoteEndpoint
Send a pong message blocking until the message has been sent.
SendResult - Class in javax.websocket
 
SendResult(Throwable) - Constructor for class javax.websocket.SendResult
 
SendResult() - Constructor for class javax.websocket.SendResult
 
sendText(String, SendHandler) - Method in interface javax.websocket.RemoteEndpoint.Async
Send the message asynchronously, using the SendHandler to signal to the client when the message has been sent.
sendText(String) - Method in interface javax.websocket.RemoteEndpoint.Async
Send the message asynchronously, using the Future to signal to the client when the message has been sent.
sendText(String) - Method in interface javax.websocket.RemoteEndpoint.Basic
Send the message, blocking until the message is sent.
sendText(String, boolean) - Method in interface javax.websocket.RemoteEndpoint.Basic
Sends part of a text message to the remote endpoint.
ServerApplicationConfig - Interface in javax.websocket.server
Applications may provide an implementation of this interface to filter the discovered WebSocket endpoints that are deployed.
ServerContainer - Interface in javax.websocket.server
Provides the ability to deploy endpoints programmatically.
ServerEndpoint - Annotation Type in javax.websocket.server
 
ServerEndpointConfig - Interface in javax.websocket.server
Provides configuration information for WebSocket endpoints published to a server.
ServerEndpointConfig.Builder - Class in javax.websocket.server
 
ServerEndpointConfig.Configurator - Class in javax.websocket.server
 
ServerEndpointConfig.Configurator() - Constructor for class javax.websocket.server.ServerEndpointConfig.Configurator
 
Session - Interface in javax.websocket
 
SessionException - Exception in javax.websocket
 
SessionException(String, Throwable, Session) - Constructor for exception javax.websocket.SessionException
 
setAsyncSendTimeout(long) - Method in interface javax.websocket.WebSocketContainer
Set the default timeout (in milliseconds) for sending a message asynchronously.
setBatchingAllowed(boolean) - Method in interface javax.websocket.RemoteEndpoint
Enable or disable the batching of outgoing messages for this endpoint.
setDefaultMaxBinaryMessageBufferSize(int) - Method in interface javax.websocket.WebSocketContainer
Set the default maximum buffer size (in bytes) for binary messages.
setDefaultMaxSessionIdleTimeout(long) - Method in interface javax.websocket.WebSocketContainer
Set the current default session idle timeout in milliseconds.
setDefaultMaxTextMessageBufferSize(int) - Method in interface javax.websocket.WebSocketContainer
Set the default maximum buffer size (in characters) for text messages.
setMaxBinaryMessageBufferSize(int) - Method in interface javax.websocket.Session
Set the current maximum buffer size (in bytes) for binary messages.
setMaxIdleTimeout(long) - Method in interface javax.websocket.Session
Set the idle timeout for this session in milliseconds.
setMaxTextMessageBufferSize(int) - Method in interface javax.websocket.Session
Set the current maximum buffer size (in characters) for text messages.
setSendTimeout(long) - Method in interface javax.websocket.RemoteEndpoint.Async
Set the timeout (in milliseconds) for sending a message asynchronously.
subprotocols(List<String>) - Method in class javax.websocket.server.ServerEndpointConfig.Builder
 

T

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

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
 
willDecode(ByteBuffer) - Method in interface javax.websocket.Decoder.Binary
 
willDecode(String) - Method in interface javax.websocket.Decoder.Text
 
A B C D E F G H I J M O P R S T V W 
WebSocket 1.0 - Apache Tomcat 7.0.55

Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.