Index (Tyrus Container SPI 1.3 API)

C E F G H I O R S U V W

C

cancelled() - Method in class org.glassfish.tyrus.spi.CompletionHandler: The operation was cancelled.
checkHandshake(UpgradeRequest) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: This method must be called by the provider during its check for a successful websocket handshake.
ClientContainer - Interface in org.glassfish.tyrus.spi: Entry point for client implementation.
ClientContainer.ClientHandshakeListener - Interface in org.glassfish.tyrus.spi: Called when response is received from the server.
ClientSocket - Interface in org.glassfish.tyrus.spi: Client socket representation.
close(CloseReason) - Method in interface org.glassfish.tyrus.spi.Connection: Notifies tyrus that underlying transport is closing the connection.
close(CloseReason) - Method in interface org.glassfish.tyrus.spi.Connection.CloseListener: Tyrus notifies that logical connection is closed.
close(CloseReason) - Method in class org.glassfish.tyrus.spi.RemoteEndpoint: Send a Close message.
completed(E) - Method in class org.glassfish.tyrus.spi.CompletionHandler: The operation was completed.
CompletionHandler<E> - Class in org.glassfish.tyrus.spi: A callback to notify about asynchronous I/O operations status updates.
CompletionHandler() - Constructor for class org.glassfish.tyrus.spi.CompletionHandler
Connection - Interface in org.glassfish.tyrus.spi: A logical websocket connection.
CONNECTION - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
Connection.CloseListener - Interface in org.glassfish.tyrus.spi: Transport close listener that receives connection close notifications from Tyrus.
createConnection(Writer, Connection.CloseListener) - Method in interface org.glassfish.tyrus.spi.WebSocketEngine.UpgradeInfo: Creates a connection if the upgrade is successful.
createContainer(Map<String, Object>) - Method in class org.glassfish.tyrus.spi.ServerContainerFactory
createServerContainer() - Static method in class org.glassfish.tyrus.spi.ServerContainerFactory
createServerContainer(Map<String, Object>) - Static method in class org.glassfish.tyrus.spi.ServerContainerFactory
createSessionForRemoteEndpoint(RemoteEndpoint, String, List<Extension>) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Creates a Session based on the RemoteEndpoint, subprotocols and extensions.

E

EndpointWrapper - Class in org.glassfish.tyrus.spi: The WebSocket SDK implements EndpointWrapper with its representation of a websocket endpoint mapped to a base URI that wishes to handle incoming messages.
EndpointWrapper() - Constructor for class org.glassfish.tyrus.spi.EndpointWrapper

F

failed(Throwable) - Method in class org.glassfish.tyrus.spi.CompletionHandler: The operation was failed.

G

getCloseListener() - Method in interface org.glassfish.tyrus.spi.Connection: Returns the same close listener that is passed for creating connection in WebSocketEngine.UpgradeInfo#createConnection(Writer, CloseListener).
getEndpointConfig() - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Get Endpoint configuration.
getEndpointPath() - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Get Endpoint absolute path.
getFirstHeaderValue(String) - Method in class org.glassfish.tyrus.spi.UpgradeResponse: Gets the value of the response header with the given name.
getHeader(String) - Method in class org.glassfish.tyrus.spi.UpgradeRequest: Returns the value of the specified request header name.
getNegotiatedExtensions(List<Extension>) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Get the negotiated extensions' names based on the extensions supported by client.
getNegotiatedProtocol(List<String>) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Compute the sub - protocol which will be used.
getOpenSessions() - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Get the endpoint's open Sessions.
getReadHandler() - Method in interface org.glassfish.tyrus.spi.Connection: Returns a read handler.
getRequestUri() - Method in class org.glassfish.tyrus.spi.UpgradeRequest: Get the undecoded request uri (up to the query string) of underlying HTTP handshake request.
getSession() - Method in interface org.glassfish.tyrus.spi.ClientSocket: Session representing the connection with server.
getStatus() - Method in class org.glassfish.tyrus.spi.UpgradeResponse: Gets the current HTTP status code of this response.
getStatus() - Method in interface org.glassfish.tyrus.spi.WebSocketEngine.UpgradeInfo: Returns the status of HTTP request upgrade.
getWebSocketContainer() - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Get WebSocketContainer.
getWebSocketEngine() - Method in interface org.glassfish.tyrus.spi.ServerContainer: Returns WebSocketEngine to upgrade requests and setting up the connection
getWriter() - Method in interface org.glassfish.tyrus.spi.Connection: Returns the same writer that is passed for creating connection in WebSocketEngine.UpgradeInfo#createConnection(Writer, CloseListener) The transport writer that actually writes websocket data to underlying connection.

H

handle(ByteBuffer) - Method in interface org.glassfish.tyrus.spi.ReadHandler: A transport reads websocket data and invokes this method to handover websocket data for a connection to tyrus runtime.
HOST - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest

I

isSecure() - Method in class org.glassfish.tyrus.spi.UpgradeRequest: Indicates whether this request was made using a secure channel (such as HTTPS).

O

onClose(RemoteEndpoint, CloseReason) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Called by the provider when the web socket connection to the given remote endpoint has just closed.
onConnect(RemoteEndpoint, String, List<Extension>) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Called by the provider when the web socket connection is established.
onError(Throwable) - Method in interface org.glassfish.tyrus.spi.ClientContainer.ClientHandshakeListener: Called when an error is found in handshake response.
onHandshakeResponse(UpgradeResponse) - Method in interface org.glassfish.tyrus.spi.ClientContainer.ClientHandshakeListener: Called when correct handshake response is received.
onMessage(RemoteEndpoint, String) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Called by the provider when the web socket connection has an incoming text message from the given remote endpoint.
onMessage(RemoteEndpoint, ByteBuffer) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Called by the provider when the web socket connection has an incoming binary message from the given remote endpoint.
onPartialMessage(RemoteEndpoint, String, boolean) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Called by the provider when the web socket connection has an incoming partial text message from the given remote endpoint.
onPartialMessage(RemoteEndpoint, ByteBuffer, boolean) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Called by the provider when the web socket connection has an incoming partial binary message from the given remote endpoint.
onPing(RemoteEndpoint, ByteBuffer) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Called by the provider when the web socket connection has an incoming ping message from the given remote endpoint.
onPong(RemoteEndpoint, ByteBuffer) - Method in class org.glassfish.tyrus.spi.EndpointWrapper: Called by the provider when the web socket connection has an incoming pong message from the given remote endpoint.
openClientSocket(String, ClientEndpointConfig, EndpointWrapper, ClientContainer.ClientHandshakeListener, Map<String, Object>) - Method in interface org.glassfish.tyrus.spi.ClientContainer: Open client socket - connect to endpoint specified with url parameter.
org.glassfish.tyrus.spi - package org.glassfish.tyrus.spi
ORIGIN_HEADER - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest

R

ReadHandler - Interface in org.glassfish.tyrus.spi: Read handler provides a way for a transport to pass websocket connection data to tyrus runtime.
register(Class<?>, String) - Method in interface org.glassfish.tyrus.spi.WebSocketEngine
register(ServerEndpointConfig, String) - Method in interface org.glassfish.tyrus.spi.WebSocketEngine
RemoteEndpoint - Class in org.glassfish.tyrus.spi: Subset of RemoteEndpoint interface which should be implemented by container implementations.
RemoteEndpoint() - Constructor for class org.glassfish.tyrus.spi.RemoteEndpoint
RESPONSE_CODE_MESSAGE - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest

S

SEC_WS_ORIGIN_HEADER - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
sendBinary(ByteBuffer) - Method in class org.glassfish.tyrus.spi.RemoteEndpoint: Send binary message.
sendBinary(ByteBuffer, SendHandler) - Method in class org.glassfish.tyrus.spi.RemoteEndpoint: Send binary message.
sendBinary(ByteBuffer, boolean) - Method in class org.glassfish.tyrus.spi.RemoteEndpoint: Send a binary message in pieces, blocking until all of the message has been transmitted.
sendPing(ByteBuffer) - Method in class org.glassfish.tyrus.spi.RemoteEndpoint: Send a Ping message containing the given application data to the remote endpoint.
sendPong(ByteBuffer) - Method in class org.glassfish.tyrus.spi.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.
sendText(String) - Method in class org.glassfish.tyrus.spi.RemoteEndpoint: Send text message.
sendText(String, SendHandler) - Method in class org.glassfish.tyrus.spi.RemoteEndpoint: Send text message.
sendText(String, boolean) - Method in class org.glassfish.tyrus.spi.RemoteEndpoint: Send text message in pieces, blocking until all of the message has been transmitted.
SERVER_KEY_HASH - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
ServerContainer - Interface in org.glassfish.tyrus.spi: HTTP server abstraction.
ServerContainerFactory - Class in org.glassfish.tyrus.spi: Factory used to get instances of ServerContainer.
ServerContainerFactory() - Constructor for class org.glassfish.tyrus.spi.ServerContainerFactory
setHeader(String, String) - Method in class org.glassfish.tyrus.spi.UpgradeResponse: Sets a response header with the given name and value.
setReasonPhrase(String) - Method in class org.glassfish.tyrus.spi.UpgradeResponse: Get HTTP reason phrase.
setStatus(int) - Method in class org.glassfish.tyrus.spi.UpgradeResponse: Sets HTTP status code for this response.
setWriteTimeout(long) - Method in class org.glassfish.tyrus.spi.RemoteEndpoint: Sets the timeout for the writing operation.
start(String, int) - Method in interface org.glassfish.tyrus.spi.ServerContainer: Starts the server.
stop() - Method in interface org.glassfish.tyrus.spi.ServerContainer: Stops the server.

U

updated(E) - Method in class org.glassfish.tyrus.spi.CompletionHandler: The callback method may be called, when there is some progress in operation execution, but it is still not completed.
UPGRADE - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
upgrade(UpgradeRequest, UpgradeResponse) - Method in interface org.glassfish.tyrus.spi.WebSocketEngine: A transport calls this method to upgrade a HTTP request.
UpgradeRequest - Class in org.glassfish.tyrus.spi: Abstraction for a HTTP upgrade request.
UpgradeRequest() - Constructor for class org.glassfish.tyrus.spi.UpgradeRequest
UpgradeResponse - Class in org.glassfish.tyrus.spi: Abstraction for a HTTP upgrade response.
UpgradeResponse() - Constructor for class org.glassfish.tyrus.spi.UpgradeResponse

V

valueOf(String) - Static method in enum org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus: Returns an array containing the constants of this enum type, in the order they are declared.

W

WEBSOCKET - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
WebSocketEngine - Interface in org.glassfish.tyrus.spi: WebSocket engine is used for upgrading HTTP requests into websocket connections.
WebSocketEngine.UpgradeInfo - Interface in org.glassfish.tyrus.spi: Upgrade info that includes status for HTTP request upgrading and connection creation details.
WebSocketEngine.UpgradeStatus - Enum in org.glassfish.tyrus.spi: Upgrade Status for HTTP request upgrading
write(ByteBuffer, CompletionHandler<ByteBuffer>) - Method in class org.glassfish.tyrus.spi.Writer: Tyrus runtime calls this method to handover the data for a connection to the transport.
Writer - Class in org.glassfish.tyrus.spi: Writer class that is used by tyrus runtime to pass outbound websocket data for a connection to a transport.
Writer() - Constructor for class org.glassfish.tyrus.spi.Writer

C E F G H I O R S U V W