A C F G H I L O P R S U V W

A

AUTHORIZATION - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest

HTTP "Authorization" header name.

C

cancelled() - Method in class org.glassfish.tyrus.spi.CompletionHandler

The operation was cancelled.

ClientContainer - Interface in org.glassfish.tyrus.spi

Entry point for client implementation.

ClientEngine - Interface in org.glassfish.tyrus.spi

Facade for handling client operations from containers.

ClientEngine.ClientUpgradeInfo - Interface in org.glassfish.tyrus.spi

Upgrade process result.

ClientEngine.ClientUpgradeStatus - Enum in org.glassfish.tyrus.spi

Status of upgrade process.

ClientEngine.TimeoutHandler - Interface in org.glassfish.tyrus.spi

Indicates to container that handshake timeout was reached.

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.

CLUSTER_CONNECTION_ID_HEADER - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest

Tyrus cluster connection ID header name.

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

HTTP "Connection" header name.

Connection.CloseListener - Interface in org.glassfish.tyrus.spi

Transport close listener that receives connection close notifications from Tyrus.

createConnection() - Method in interface org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeInfo

Create new Connection when ClientEngine.ClientUpgradeInfo.getUpgradeStatus() returns ClientEngine.ClientUpgradeStatus.SUCCESS.

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

createUpgradeRequest(ClientEngine.TimeoutHandler) - Method in interface org.glassfish.tyrus.spi.ClientEngine

Create upgrade request and register ClientEngine.TimeoutHandler.

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

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.

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.

getStatus() - Method in class org.glassfish.tyrus.spi.UpgradeResponse

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

getUpgradeStatus() - Method in interface org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeInfo

Get ClientEngine.ClientUpgradeStatus.

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.

handleTimeout() - Method in interface org.glassfish.tyrus.spi.ClientEngine.TimeoutHandler

Invoked when timeout is reached.

HOST - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest

HTTP "Host" header name.

I

INCOMING_BUFFER_SIZE - Static variable in interface org.glassfish.tyrus.spi.ClientContainer

Deprecated.

please use org.glassfish.tyrus.client.ClientProperties#INCOMING_BUFFER_SIZE.

isSecure() - Method in class org.glassfish.tyrus.spi.UpgradeRequest

Indicates whether this request was made using a secure channel (such as HTTPS).

L

LOCATION - Static variable in class org.glassfish.tyrus.spi.UpgradeResponse

Header containing a new URI when UpgradeResponse.getStatus() .

O

openClientSocket(ClientEndpointConfig, Map<String, Object>, ClientEngine) - 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

Tyrus SPI.

ORIGIN_HEADER - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest

HTTP "Origin" header name.

P

processError(Throwable) - Method in interface org.glassfish.tyrus.spi.ClientEngine

Process error.

processResponse(UpgradeResponse, Writer, Connection.CloseListener) - Method in interface org.glassfish.tyrus.spi.ClientEngine

Process handshake and return ClientEngine.ClientUpgradeInfo with handshake status (ClientEngine.ClientUpgradeStatus).

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

RESPONSE_CODE_MESSAGE - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest

HTTP reason phrase for successful handshake response.

S

SEC_WS_ORIGIN_HEADER - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest

WebSocket origin header name from previous versions.

SERVER_KEY_HASH - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest

Server key hash used to compute "Sec-WebSocket-Accept" header value.

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

setReasonPhrase(String) - Method in class org.glassfish.tyrus.spi.UpgradeResponse

Get HTTP reason phrase.

setStatus(int) - Method in class org.glassfish.tyrus.spi.UpgradeResponse

Set HTTP status code for this response.

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

HTTP "Upgrade" header name and "Connection" header expected value.

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

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

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

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

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

Expected value in HTTP handshake "Upgrade" header.

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

WLS_INCOMING_BUFFER_SIZE - Static variable in interface org.glassfish.tyrus.spi.ClientContainer

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

WWW_AUTHENTICATE - Static variable in class org.glassfish.tyrus.spi.UpgradeResponse

Header containing challenge with authentication scheme and parameters.

A C F G H I L O P R S U V W