A B C E F G H I L N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ANOTHER_UPGRADE_REQUEST_REQUIRED - org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeStatus
-
Client engine needs to send another request.
- ASYNC - org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
RemoteEndpoint.Async
- AUTHORIZATION - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
HTTP "Authorization" header name.
B
- BASIC - org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
RemoteEndpoint.Basic
- BINARY - org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Binary type.
- BINARY_CONTINUATION - org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Continuation binary type.
- BROADCAST - org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
Broadcast
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.
- CLOSE - org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Close type.
- 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
ConnectionwhenClientEngine.ClientUpgradeInfo.getUpgradeStatus()returnsClientEngine.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
-
Create container delegate method.
- createServerContainer() - Static method in class org.glassfish.tyrus.spi.ServerContainerFactory
-
Create new
ServerContainerwith default configuration. - createServerContainer(Map<String, Object>) - Static method in class org.glassfish.tyrus.spi.ServerContainerFactory
-
Create new
ServerContainerwith configuration. - createUpgradeRequest(ClientEngine.TimeoutHandler) - Method in interface org.glassfish.tyrus.spi.ClientEngine
-
Create upgrade request and register
ClientEngine.TimeoutHandler.
E
- ENABLE_TRACING_HEADER - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
If this header is present in the handshake request and the tracing type is configured to "ON_DEMAND", tracing headers will be sent in the handshake response.
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.
- getMessageType() - Method in class org.glassfish.tyrus.spi.WriterInfo
- getReadHandler() - Method in interface org.glassfish.tyrus.spi.Connection
-
Returns a read handler.
- getRemoteEndpointType() - Method in class org.glassfish.tyrus.spi.WriterInfo
- 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
- getWebSocketEngine() - Method in interface org.glassfish.tyrus.spi.ServerContainer
-
Return 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.
- HANDSHAKE_FAILED - org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus
-
Upgrade failed due to version, extensions, origin check etc.
- 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().
N
- NOT_APPLICABLE - org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus
-
Not a WebSocketRequest or no mapping in the application.
O
- OBJECT - org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Object type.
- openClientSocket(ClientEndpointConfig, Map<String, Object>, ClientEngine) - Method in interface org.glassfish.tyrus.spi.ClientContainer
-
Open client socket - connect to endpoint specified with
urlparameter. - 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
- PING - org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Ping type.
- PONG - org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Pong type.
- 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.ClientUpgradeInfowith 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(ServerEndpointConfig, String) - Method in interface org.glassfish.tyrus.spi.WebSocketEngine
-
Register
ServerEndpointConfig. - register(Class<?>, String) - Method in interface org.glassfish.tyrus.spi.WebSocketEngine
-
Register endpoint class.
- RESPONSE_CODE_MESSAGE - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
HTTP reason phrase for successful handshake response.
- RETRY_AFTER - Static variable in class org.glassfish.tyrus.spi.UpgradeResponse
-
Header containing delay or date in which client can try to reconnect to the server.
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
-
Start the server.
- stop() - Method in interface org.glassfish.tyrus.spi.ServerContainer
-
Stop the server.
- SUCCESS - org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeStatus
-
Upgrade process was successful.
- SUCCESS - org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus
-
Upgrade is successful.
- SUPER - org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
RemoteEndpoint
T
- TEXT - org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Text type.
- TEXT_CONTINUATION - org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Continuation text type.
- TRACING_HEADER_PREFIX - Static variable in class org.glassfish.tyrus.spi.UpgradeResponse
-
Prefix of headers used for including tracing information into handshake response.
- TRACING_THRESHOLD - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
This header allows temporarily changing tracing threshold.
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(UpgradeRequest, UpgradeResponse) - Method in interface org.glassfish.tyrus.spi.WebSocketEngine
-
A transport calls this method to upgrade a HTTP request.
- UPGRADE - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
HTTP "Upgrade" header name and "Connection" header expected value.
- UPGRADE_REQUEST_FAILED - org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeStatus
-
Upgrade process failed.
- 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.
- valueOf(String) - Static method in enum org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
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.
- values() - Static method in enum org.glassfish.tyrus.spi.WriterInfo.MessageType
-
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.WriterInfo.RemoteEndpointType
-
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
-
WLS version of
ClientContainer.INCOMING_BUFFER_SIZE. - write(ByteBuffer, CompletionHandler<ByteBuffer>) - Method in class org.glassfish.tyrus.spi.Writer
-
A backward compatible method called from
Writer.write(ByteBuffer, CompletionHandler, WriterInfo)to handover the data for a connection to the transport. - write(ByteBuffer, CompletionHandler<ByteBuffer>, WriterInfo) - 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
- WriterInfo - Class in org.glassfish.tyrus.spi
-
Additional data for the transport.
- WriterInfo(WriterInfo.MessageType, WriterInfo.RemoteEndpointType) - Constructor for class org.glassfish.tyrus.spi.WriterInfo
-
Create new
WriterDatainstance - WriterInfo.MessageType - Enum in org.glassfish.tyrus.spi
-
Possible WebSocket Message Types.
- WriterInfo.RemoteEndpointType - Enum in org.glassfish.tyrus.spi
- WWW_AUTHENTICATE - Static variable in class org.glassfish.tyrus.spi.UpgradeResponse
-
Header containing challenge with authentication scheme and parameters.
All Classes All Packages