Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractMultivaluedMap<K,
V> - Class in org.glassfish.tyrus.core.uri.internal -
Abstract skeleton implementation of a
MultivaluedMap
that is backed by a [key, multi-value] store represented as aMap<K, List<V>>
. - AbstractMultivaluedMap(Map<K, List<V>>) - Constructor for class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
-
Initialize the backing store in the abstract parent multivalued map implementation.
- add(K, V) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
-
Add a value to the current list of values for the supplied key.
- add(K, V) - Method in interface org.glassfish.tyrus.core.uri.internal.MultivaluedMap
-
Add a value to the current list of values for the supplied key.
- addAll(K, List<V>) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
-
Add all the values from the supplied value list to the current list of values for the supplied key.
- addAll(K, List<V>) - Method in interface org.glassfish.tyrus.core.uri.internal.MultivaluedMap
-
Add all the values from the supplied value list to the current list of values for the supplied key.
- addAll(K, V...) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
-
Add multiple values to the current list of values for the supplied key.
- addAll(K, V...) - Method in interface org.glassfish.tyrus.core.uri.internal.MultivaluedMap
-
Add multiple values to the current list of values for the supplied key.
- addEndpoint(ServerEndpointConfig) - Method in interface jakarta.websocket.server.ServerContainer
-
Deploys the given endpoint described by the provided configuration into this ServerContainer.
- addEndpoint(ServerEndpointConfig) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- addEndpoint(Class<?>) - Method in interface jakarta.websocket.server.ServerContainer
-
Deploys the given annotated endpoint into this ServerContainer.
- addEndpoint(Class<?>) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- addException(Exception) - Method in class org.glassfish.tyrus.core.ErrorCollector
-
Add
Exception
to the collector. - addFirst(K, V) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
-
Add a value to the first position in the current list of values for the supplied key.
- addFirst(K, V) - Method in interface org.glassfish.tyrus.core.uri.internal.MultivaluedMap
-
Add a value to the first position in the current list of values for the supplied key.
- addFirstNull(List<String>) - Method in class org.glassfish.tyrus.core.uri.internal.MultivaluedStringMap
- addFirstNull(List<V>) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
-
Define the behavior for adding a
null
values to the first position in the value list. - addMessageHandler(MessageHandler) - Method in interface jakarta.websocket.Session
-
Register to handle to incoming messages in this conversation.
- addMessageHandler(MessageHandler) - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - addMessageHandler(MessageHandler) - Method in class org.glassfish.tyrus.core.MessageHandlerManager
-
Add
MessageHandler
to the manager. - addMessageHandler(MessageHandler) - Method in class org.glassfish.tyrus.core.TyrusSession
-
Deprecated.
- addMessageHandler(Class<T>, MessageHandler.Partial<T>) - Method in interface jakarta.websocket.Session
-
Register to handle to incoming messages in this conversation.
- addMessageHandler(Class<T>, MessageHandler.Partial<T>) - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - addMessageHandler(Class<T>, MessageHandler.Partial<T>) - Method in class org.glassfish.tyrus.core.MessageHandlerManager
-
Add
MessageHandler.Partial
to the manager. - addMessageHandler(Class<T>, MessageHandler.Partial<T>) - Method in class org.glassfish.tyrus.core.TyrusSession
-
Register to handle to incoming messages in this conversation.
- addMessageHandler(Class<T>, MessageHandler.Whole<T>) - Method in interface jakarta.websocket.Session
-
Register to handle to incoming messages in this conversation.
- addMessageHandler(Class<T>, MessageHandler.Whole<T>) - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - addMessageHandler(Class<T>, MessageHandler.Whole<T>) - Method in class org.glassfish.tyrus.core.MessageHandlerManager
-
Add
MessageHandler.Whole
to the manager. - addMessageHandler(Class<T>, MessageHandler.Whole<T>) - Method in class org.glassfish.tyrus.core.TyrusSession
-
Register to handle to incoming messages in this conversation.
- addNull(List<String>) - Method in class org.glassfish.tyrus.core.uri.internal.MultivaluedStringMap
- addNull(List<V>) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
-
Define the behavior for adding a
null
values to the value list. - afterResponse(HandshakeResponse) - Method in class jakarta.websocket.ClientEndpointConfig.Configurator
-
This method is called by the implementation after it has received a handshake response from the server as a result of a handshake interaction it initiated.
- ALL - Enum constant in enum class org.glassfish.tyrus.core.DebugContext.TracingType
-
Tracing headers will be present in all handshake responses.
- ALL - Static variable in class org.glassfish.tyrus.core.coder.PrimitiveDecoders
- ALL_INSTANCES - Static variable in class org.glassfish.tyrus.core.coder.PrimitiveDecoders
- AnnotatedEndpoint - Class in org.glassfish.tyrus.core
-
Endpoint
descendant which represents deployed annotated endpoint. - ANOTHER_UPGRADE_REQUEST_REQUIRED - Enum constant in enum class org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeStatus
-
Client engine needs to send another request.
- any - Variable in class org.glassfish.tyrus.core.wsadl.model.Application
- appendBuffers(ByteBuffer, ByteBuffer, int, int) - Static method in class org.glassfish.tyrus.core.Utils
-
Concatenates two buffers into one.
- appendLogMessage(Logger, Level, DebugContext.Type, Object...) - Method in class org.glassfish.tyrus.core.DebugContext
-
Append a message to the log, the logging will be postponed until the message can be provided with a session ID.
- appendLogMessageWithThrowable(Logger, Level, DebugContext.Type, Throwable, Object...) - Method in class org.glassfish.tyrus.core.DebugContext
-
Append a message to the log, the logging will be postponed until the message can be provided with a session ID.
- appendStandardOutputMessage(DebugContext.Type, String) - Method in class org.glassfish.tyrus.core.DebugContext
-
Write a message to the standard output, the logging will be postponed until the message can be provided with a session ID.
- appendTraceMessage(Logger, Level, DebugContext.Type, Object...) - Method in class org.glassfish.tyrus.core.DebugContext
-
Append a message to the log and to the list of trace messages that are sent in handshake response.
- appendTraceMessageWithThrowable(Logger, Level, DebugContext.Type, Throwable, Object...) - Method in class org.glassfish.tyrus.core.DebugContext
-
Append a message to the log and to the list of trace messages that are sent in handshake response.
- Application - Class in org.glassfish.tyrus.core.wsadl.model
-
Java class for anonymous complex type
- Application() - Constructor for class org.glassfish.tyrus.core.wsadl.model.Application
- APPLICATION_DATA_TOO_LONG(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
{0} applicationData exceeded the maximum allowed payload of 125 bytes.
- APPLICATION_EVENT_LISTENER - Static variable in interface org.glassfish.tyrus.core.monitoring.ApplicationEventListener
-
A key used for registering a application event listener implementation.
- applicationEventListener(ApplicationEventListener) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
- ApplicationEventListener - Interface in org.glassfish.tyrus.core.monitoring
-
Listens to application-level events that are interesting for monitoring.
- ARGUMENT_NOT_NULL(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Argument ''{0}'' cannot be null.
- asClosed(PathPattern) - Static method in class org.glassfish.tyrus.core.uri.internal.PathPattern
-
Return a new path pattern with a same path template but a
closed
right hand path. - ASYNC - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
RemoteEndpoint.Async
- asyncConnectToServer(Endpoint, ClientEndpointConfig, URI) - Method in class org.glassfish.tyrus.client.ClientManager
- asyncConnectToServer(Endpoint, ClientEndpointConfig, URI) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- asyncConnectToServer(Class<?>, URI) - Method in class org.glassfish.tyrus.client.ClientManager
-
Non-blocking version of
WebSocketContainer.connectToServer(Class, java.net.URI)
. - asyncConnectToServer(Class<?>, URI) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
-
Non-blocking version of
WebSocketContainer.connectToServer(Class, java.net.URI)
. - asyncConnectToServer(Class<? extends Endpoint>, ClientEndpointConfig, URI) - Method in class org.glassfish.tyrus.client.ClientManager
-
Non-blocking version of
WebSocketContainer.connectToServer(Class, jakarta.websocket.ClientEndpointConfig, java.net.URI)
. - asyncConnectToServer(Class<? extends Endpoint>, ClientEndpointConfig, URI) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
-
Non-blocking version of
WebSocketContainer.connectToServer(Class, jakarta.websocket.ClientEndpointConfig, java.net.URI)
. - asyncConnectToServer(Object, URI) - Method in class org.glassfish.tyrus.client.ClientManager
-
Non-blocking version of
WebSocketContainer.connectToServer(Object, java.net.URI)
. - asyncConnectToServer(Object, URI) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
-
Non-blocking version of
WebSocketContainer.connectToServer(Object, java.net.URI)
. - AUTH_CONFIG - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
Authentication configuration.
- AuthConfig - Class in org.glassfish.tyrus.client.auth
-
AuthConfig serves as a configuration of HTTP authentication.
- AuthConfig.Builder - Class in org.glassfish.tyrus.client.auth
-
The AuthConfig.Builder is a class used for creating an instance of
AuthConfig
for purpose of HTTP Authentication. - AUTHENTICATION_CREATE_AUTH_HEADER_FAILED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Could not add authorization header in http request.
- AUTHENTICATION_CREDENTIALS_MISSING() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Credentials are missing.
- AUTHENTICATION_DIGEST_NO_SUCH_ALG() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
No such algorithm to generate authorization digest http header.
- AUTHENTICATION_DIGEST_QOP_UNSUPPORTED(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
The 'qop' (quality of protection) = {0} extension requested by the server is not supported by Tyrus.
- AUTHENTICATION_FAILED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Authentication failed.
- AuthenticationException - Exception Class in org.glassfish.tyrus.client.auth
-
This exception is set as a cause of
DeploymentException
thrown whenWebSocketContainer
.connectToServer(...) - AuthenticationException(String) - Constructor for exception class org.glassfish.tyrus.client.auth.AuthenticationException
-
Constructor.
- Authenticator - Class in org.glassfish.tyrus.client.auth
-
Authenticator provides a way how to plug-in custom authentication provider.
- Authenticator() - Constructor for class org.glassfish.tyrus.client.auth.Authenticator
- AUTHORITY - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI authority component type.
- AUTHORIZATION - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
HTTP "Authorization" header name.
B
- BaseContainer - Class in org.glassfish.tyrus.core
-
Base WebSocket container.
- BaseContainer() - Constructor for class org.glassfish.tyrus.core.BaseContainer
- BaseContainer.ShutDownCondition - Interface in org.glassfish.tyrus.core
- BASIC - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
RemoteEndpoint.Basic
- beforeRequest(Map<String, List<String>>) - Method in class jakarta.websocket.ClientEndpointConfig.Configurator
-
This method is called by the implementation after it has formulated the handshake request that will be used to initiate the connection to the server, but before it has sent any part of the request.
- beforeRequest(UpgradeRequest) - Method in class org.glassfish.tyrus.spi.TyrusClientEndpointConfigurator
-
This method is called by the implementation after it has formulated the handshake request that will be used to initiate the connection to the server, but before
ClientEndpointConfig.Configurator.beforeRequest(Map)
is invoked. - Beta - Annotation Interface in org.glassfish.tyrus.core
-
Marker of a public Tyrus API that is still in "beta" non-final version.
- BINARY - Enum constant in enum class org.glassfish.tyrus.core.frame.TyrusFrame.FrameType
-
Binary frame.
- BINARY - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Binary type.
- BINARY_CONTINUATION - Enum constant in enum class org.glassfish.tyrus.core.frame.TyrusFrame.FrameType
-
Continuation binary frame.
- BINARY_CONTINUATION - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Continuation binary type.
- BINARY_MESSAGE_HANDLER_NOT_FOUND(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Binary message handler not found.
- BINARY_MESSAGE_OUT_OF_ORDER(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Binary message received out of order.
- BinaryFrame - Class in org.glassfish.tyrus.core.frame
-
Binary frame representation.
- BinaryFrame(byte[], boolean, boolean) - Constructor for class org.glassfish.tyrus.core.frame.BinaryFrame
-
Constructor.
- BinaryFrame(Frame) - Constructor for class org.glassfish.tyrus.core.frame.BinaryFrame
-
Constructor.
- BinaryFrame(Frame, boolean) - Constructor for class org.glassfish.tyrus.core.frame.BinaryFrame
-
Constructor.
- BooleanDecoder() - Constructor for class org.glassfish.tyrus.core.coder.PrimitiveDecoders.BooleanDecoder
- broadcast(String) - Method in class org.glassfish.tyrus.core.TyrusSession
-
Broadcasts text message to all connected clients.
- broadcast(ByteBuffer) - Method in class org.glassfish.tyrus.core.TyrusSession
-
Broadcasts binary message to all connected clients, including remote sessions (if any).
- BROADCAST - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
Broadcast
- broadcastBinary(String, byte[]) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Broadcast binary message.
- BroadcastListener - Interface in org.glassfish.tyrus.core.cluster
-
Broadcast listener.
- broadcastText(String, String) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Broadcast text message.
- BUFFER_OVERFLOW() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Buffer overflow.
- build() - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Builds a configuration object using the attributes set on this builder.
- build() - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Builds the configuration object using the current attributes that have been set on this builder object.
- build() - Method in class org.glassfish.tyrus.client.auth.AuthConfig.Builder
-
Build an instance of
AuthConfig
. - build() - Method in class org.glassfish.tyrus.core.frame.Frame.Builder
-
Build new frame.
- build() - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Build
RequestContext
from given properties. - build() - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfig.Builder
-
Builds the configuration object using the current attributes that have been set on this builder object.
- build() - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
-
Create new
TyrusWebSocketEngine
instance with current set of parameters. - builder() - Static method in class org.glassfish.tyrus.client.auth.AuthConfig
-
Create new
AuthConfig.Builder
instance, which contains provided Basic and Digest authenticators. - builder() - Static method in class org.glassfish.tyrus.core.frame.Frame
-
Create new
Frame.Builder
. - builder(WebSocketContainer) - Static method in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Create
TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
instance based on passedWebSocketContainer
. - builder(Frame) - Static method in class org.glassfish.tyrus.core.frame.Frame
-
Create new
Frame.Builder
based on provided frame. - Builder() - Constructor for class org.glassfish.tyrus.core.frame.Frame.Builder
-
Constructor.
- Builder() - Constructor for class org.glassfish.tyrus.core.RequestContext.Builder
- Builder() - Constructor for class org.glassfish.tyrus.core.TyrusConfiguration.Builder
- Builder(Frame) - Constructor for class org.glassfish.tyrus.core.frame.Frame.Builder
-
Constructor.
- bundleChanged(BundleEvent) - Method in class org.glassfish.tyrus.core.OsgiRegistry
- ByteDecoder() - Constructor for class org.glassfish.tyrus.core.coder.PrimitiveDecoders.ByteDecoder
C
- c - Variable in class org.glassfish.tyrus.core.ReflectionHelper.ClassTypePair
-
The class.
- c - Variable in class org.glassfish.tyrus.core.ReflectionHelper.TypeClassPair
- cancelled() - Method in class org.glassfish.tyrus.spi.CompletionHandler
-
The operation was cancelled.
- CANNOT_ACCEPT - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).
- CANNOT_ACCEPT - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).
- capturingZeroOrMoreSegments - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.PathPattern.RightHandPath
-
A capturing group that matches zero or more path segments and keeps the matching path template open.
- capturingZeroSegments - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.PathPattern.RightHandPath
-
A capturing group that matches zero segments and effectively closes the matching path template.
- CdiComponentProvider - Class in org.glassfish.tyrus.gf.cdi
-
Provides the instance for CDI class.
- CdiComponentProvider() - Constructor for class org.glassfish.tyrus.gf.cdi.CdiComponentProvider
-
Constructor.
- CharacterDecoder() - Constructor for class org.glassfish.tyrus.core.coder.PrimitiveDecoders.CharacterDecoder
- checkNotNull(T, String) - Static method in class org.glassfish.tyrus.core.Utils
-
Check for null.
- checkOrigin(String) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Check the value of the Origin header (See Origin Header) the client passed during the opening handshake.
- checkOrigin(String) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfigurator
- CLASS_CHECKER_ADD_MESSAGE_HANDLER_ERROR(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Class {0}. {1}.
- CLASS_CHECKER_FORBIDDEN_RETURN_TYPE(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Method: {0}.{1}: has got unsupported return type.
- CLASS_CHECKER_FORBIDDEN_WEB_SOCKET_CLOSE_PARAM(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Method: {0}.{1}: @OnClose has got different params than Session or CloseReason.
- CLASS_CHECKER_FORBIDDEN_WEB_SOCKET_ERROR_PARAM(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Method: {0}.{1}: {2} is not allowed as parameter type for method annotated with @OnError.
- CLASS_CHECKER_FORBIDDEN_WEB_SOCKET_OPEN_PARAM(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Method: {0}.{1}: {2} has got multiple parameters of identical type.
- CLASS_CHECKER_MANDATORY_PARAM_MISSING(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Method: {0}.{1}: does not have mandatory Throwable param.
- CLASS_CHECKER_MULTIPLE_IDENTICAL_PARAMS(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Method: {0}.{1}: has got multiple parameters of identical type.
- CLASS_NOT_ELIGIBLE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
{0} is not eligible for proxying (must not be non-static inner class or abstract) and it will not be proxied for modifyHandshake.
- CLASS_NOT_INSTANTIATED(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Class {0} couldn''t be instantiated.
- CLASS_NOT_PROXIABLE(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
{0} is not eligible for proxying and it will not be proxied for modifyHandshake: ${1}.
- classForName(String) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get the Class from the class name.
- classForName(String, ClassLoader) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get the Class from the class name.
- classForNameWithException(String) - Method in class org.glassfish.tyrus.core.OsgiRegistry
-
Get the Class from the class name.
- classForNameWithException(String) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get the Class from the class name.
- classForNameWithException(String, ClassLoader) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get the Class from the class name.
- classForNameWithExceptionPEA(String) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get privileged exception action to obtain Class from given class name.
- classForNameWithExceptionPEA(String, ClassLoader) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get privileged exception action to obtain Class from given class name.
- ClassTypePair(Class) - Constructor for class org.glassfish.tyrus.core.ReflectionHelper.ClassTypePair
- ClassTypePair(Class, Type) - Constructor for class org.glassfish.tyrus.core.ReflectionHelper.ClassTypePair
- clear() - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- CLIENT_CANNOT_CONNECT(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Client cannot connect to "{0}".
- ClientContainer - Interface in org.glassfish.tyrus.spi
-
Entry point for client implementation.
- ClientEndpoint - Annotation Interface in jakarta.websocket
-
The ClientEndpoint annotation a class level annotation is used to denote that a POJO is a web socket client and can be deployed as such.
- ClientEndpointConfig - Interface in jakarta.websocket
-
The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints.
- ClientEndpointConfig.Builder - Class in jakarta.websocket
-
The ClientEndpointConfig.Builder is a class used for creating
ClientEndpointConfig
objects for the purposes of deploying a client endpoint. - ClientEndpointConfig.Configurator - Class in jakarta.websocket
-
The Configurator class may be extended by developers who want to provide custom configuration algorithms, such as intercepting the opening handshake, or providing arbitrary methods and algorithms that can be accessed from each endpoint instance configured with this configurator.
- 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 Class 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.
- ClientManager - Class in org.glassfish.tyrus.client
-
ClientManager implementation.
- ClientManager() - Constructor for class org.glassfish.tyrus.client.ClientManager
-
Create new
ClientManager
instance. - ClientManager.ReconnectHandler - Class in org.glassfish.tyrus.client
-
Reconnect handler.
- clientMode - Variable in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Client mode when handshaking.
- ClientProperties - Class in org.glassfish.tyrus.client
-
Tyrus client configuration properties.
- ClientProperties() - Constructor for class org.glassfish.tyrus.client.ClientProperties
- close() - Method in interface jakarta.websocket.Session
-
Close the current conversation with a normal status code and no reason phrase.
- close() - Method in class org.glassfish.tyrus.container.grizzly.client.GrizzlyWriter
- close() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Close the current conversation with a normal status code and no reason phrase.
- close() - Method in class org.glassfish.tyrus.core.TyrusSession
- close() - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Closes this
TyrusWebSocket
. - close(int, String) - Method in class org.glassfish.tyrus.core.ProtocolHandler
- close(int, String) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Closes this
TyrusWebSocket
using the specified status code and reason. - close(CloseReason) - Method in interface jakarta.websocket.Session
-
Close the current conversation, giving a reason for the closure.
- close(CloseReason) - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Close the current conversation, giving a reason for the closure.
- close(CloseReason) - Method in class org.glassfish.tyrus.core.TyrusRemoteEndpoint
- close(CloseReason) - Method in class org.glassfish.tyrus.core.TyrusSession
- close(CloseReason) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Closes this
TyrusWebSocket
using theCloseReason
. - 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(String) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Close remote session.
- close(String, CloseReason) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Close remote session with custom
CloseReason
. - CLOSE - Enum constant in enum class org.glassfish.tyrus.core.frame.TyrusFrame.FrameType
-
Close frame.
- CLOSE - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Close type.
- CLOSED_ABNORMALLY - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- CLOSED_ABNORMALLY - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- CloseFrame - Class in org.glassfish.tyrus.core.frame
-
Close frame representation.
- CloseFrame(CloseReason) - Constructor for class org.glassfish.tyrus.core.frame.CloseFrame
-
Constructor.
- CloseFrame(Frame) - Constructor for class org.glassfish.tyrus.core.frame.CloseFrame
-
Constructor.
- CloseReason - Class in jakarta.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 jakarta.websocket.CloseReason
-
Creates a reason for closing a web socket connection with the given code and reason phrase.
- CloseReason.CloseCode - Interface in jakarta.websocket
-
A marker interface for the close codes.
- CloseReason.CloseCodes - Enum Class in jakarta.websocket
-
An Enumeration of status codes for a web socket close that are defined in the specification.
- CloseReasons - Enum Class in org.glassfish.tyrus.core
-
Enum containing standard CloseReasons defined in RFC 6455, see chapter 7.4.1 Defined Status Codes.
- CLUSTER_CONNECTION_ID_HEADER - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
Tyrus cluster connection ID header name.
- CLUSTER_CONTEXT - Static variable in class org.glassfish.tyrus.core.cluster.ClusterContext
-
ClusterContext registration property.
- clusterContext(ClusterContext) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
-
Set
ClusterContext
. - ClusterContext - Class in org.glassfish.tyrus.core.cluster
-
Cluster related context.
- ClusterContext() - Constructor for class org.glassfish.tyrus.core.cluster.ClusterContext
- CoderAdapter - Class in org.glassfish.tyrus.core.coder
- CoderAdapter() - Constructor for class org.glassfish.tyrus.core.coder.CoderAdapter
- CoderWrapper<T> - Class in org.glassfish.tyrus.core.coder
-
Wrapper of coders storing the coder coder class (and optionally coder instance), return type of the encode / decode method and coder class.
- CoderWrapper(Class<? extends T>, Class<?>) - Constructor for class org.glassfish.tyrus.core.coder.CoderWrapper
-
Construct new coder wrapper.
- CoderWrapper(T, Class<?>) - Constructor for class org.glassfish.tyrus.core.coder.CoderWrapper
-
Construct new coder wrapper.
- COMPARATOR - Static variable in class org.glassfish.tyrus.core.uri.internal.PathPattern
-
Path pattern comparator that defers to
comparing the templates
associated with the patterns. - COMPARATOR - Static variable in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Order the templates according to JAX-RS specification.
- 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
- COMPONENT_PROVIDER_NOT_FOUND(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Component provider for class {0} not found.
- COMPONENT_PROVIDER_THREW_EXCEPTION(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Component provider threw exception when providing instance of class {0}.
- ComponentProvider - Class in org.glassfish.tyrus.core
-
Provides an instance.
- ComponentProvider() - Constructor for class org.glassfish.tyrus.core.ComponentProvider
- ComponentProviderService - Class in org.glassfish.tyrus.core
-
Provides an instance of component.
- ComponentProviderService(ComponentProviderService) - Constructor for class org.glassfish.tyrus.core.ComponentProviderService
-
Copy constructor.
- composeComprehensiveException() - Method in class org.glassfish.tyrus.core.ErrorCollector
-
Create
DeploymentException
with message concatenated from collected exceptions. - concreteClass - Variable in class org.glassfish.tyrus.core.ReflectionHelper.DeclaringClassInterfacePair
- configurator() - Element in annotation interface jakarta.websocket.ClientEndpoint
-
An optional custom configurator class that the developer would like to use to provide custom configuration of new instances of this endpoint.
- configurator() - Element in annotation interface jakarta.websocket.server.ServerEndpoint
-
The optional custom configurator class that the developer would like to use to further configure new instances of this endpoint.
- configurator(ClientEndpointConfig.Configurator) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Sets the configurator object for the configuration this builder will build.
- configurator(ServerEndpointConfig.Configurator) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the custom configurator to use on the configuration object built by this builder.
- configurator(ServerEndpointConfig.Configurator) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfig.Builder
-
Sets the custom configurator to use on the configuration object built by this builder.
- Configurator() - Constructor for class jakarta.websocket.ClientEndpointConfig.Configurator
- Configurator() - Constructor for class jakarta.websocket.server.ServerEndpointConfig.Configurator
- configure(SSLEngine) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Configure passed
SSLEngine
, using current configurator settings, excluding Hostname Verification. - connect() - Method in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientSocket
-
Performs connect to server endpoint.
- 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_HAS_BEEN_CLOSED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
The connection has been closed.
- CONNECTION_ID - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Cluster connection Id.
- CONNECTION_NULL() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Connection is null.
- Connection.CloseListener - Interface in org.glassfish.tyrus.spi
-
Transport close listener that receives connection close notifications from Tyrus.
- connectToServer(Endpoint, ClientEndpointConfig, URI) - Method in interface jakarta.websocket.WebSocketContainer
-
Connect the supplied programmatic client endpoint instance to its server with the given configuration.
- connectToServer(Endpoint, ClientEndpointConfig, URI) - Method in class org.glassfish.tyrus.client.ClientManager
- connectToServer(Endpoint, ClientEndpointConfig, URI) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- connectToServer(Class<?>, URI) - Method in interface jakarta.websocket.WebSocketContainer
-
Connect the supplied annotated endpoint to its server.
- connectToServer(Class<? extends Endpoint>, ClientEndpointConfig, URI) - Method in interface jakarta.websocket.WebSocketContainer
-
Connect the supplied programmatic endpoint to its server with the given configuration.
- connectToServer(Class<? extends Endpoint>, ClientEndpointConfig, URI) - Method in class org.glassfish.tyrus.client.ClientManager
- connectToServer(Class<? extends Endpoint>, ClientEndpointConfig, URI) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- connectToServer(Class, URI) - Method in class org.glassfish.tyrus.client.ClientManager
- connectToServer(Class, URI) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- connectToServer(Object, URI) - Method in interface jakarta.websocket.WebSocketContainer
-
Connect the supplied annotated endpoint instance to its server.
- connectToServer(Object, URI) - Method in class org.glassfish.tyrus.client.ClientManager
- connectToServer(Object, URI) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- ContainerProvider - Class in jakarta.websocket
-
Provider class that allows the developer to get a reference to the implementation of the WebSocketContainer.
- ContainerProvider() - Constructor for class jakarta.websocket.ContainerProvider
- contains(Charset) - Method in class org.glassfish.tyrus.core.StrictUtf8
- containsKey(Object) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- containsValue(Object) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- contextualEncode(String, UriComponent.Type) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Contextually encodes the characters of string that are either non-ASCII characters or are ASCII characters that must be percent-encoded using the UTF-8 encoding.
- contextualEncode(String, UriComponent.Type, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Contextually encodes the characters of string that are either non-ASCII characters or are ASCII characters that must be percent-encoded using the UTF-8 encoding.
- CONTROL_FRAME_FRAGMENTED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Fragmented control frame.
- CONTROL_FRAME_LENGTH() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Control frame payloads must be no greater than 125 bytes.
- copy() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
- copy() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Return a copy of this thread pool config.
- create() - Static method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Creates a new builder object with no subprotocols, extensions, encoders, decoders and a
null
configurator. - create() - Static method in class org.glassfish.tyrus.client.auth.AuthConfig.Builder
-
Create new
AuthConfig.Builder
instance, which contains provided Basic and Digest authenticators. - create() - Static method in class org.glassfish.tyrus.core.ComponentProviderService
-
Create new instance of
ComponentProviderService
. - create() - Static method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Create empty builder.
- create(CloseReason.CloseCode, String) - Static method in enum class org.glassfish.tyrus.core.CloseReasons
- create(Class<?>, String) - Static method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Creates the builder with the mandatory information of the endpoint class (programmatic or annotated), the relative URI or URI-template to use, and with no subprotocols, extensions, encoders, decoders or custom configurator.
- create(Class<?>, String) - Static method in class org.glassfish.tyrus.core.TyrusServerEndpointConfig.Builder
-
Creates the builder with the mandatory information of the endpoint class (programmatic or annotated), the relative URI or URI-template to use, and with no subprotocols, extensions, encoders, decoders or custom configurator.
- create(Class<T>) - Method in class org.glassfish.tyrus.core.ComponentProvider
-
Create new instance.
- create(Class<T>) - Method in class org.glassfish.tyrus.core.DefaultComponentProvider
- create(Class<T>) - Method in class org.glassfish.tyrus.gf.cdi.CdiComponentProvider
- create(Class<T>) - Method in class org.glassfish.tyrus.gf.ejb.EjbComponentProvider
- create(RequestContext) - Static method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Create builder instance based on provided
RequestContext
. - createApplication() - Method in class org.glassfish.tyrus.core.wsadl.model.ObjectFactory
-
Create an instance of
Application
- createClassIterator(Class<T>, String, ClassLoader, boolean) - Method in class org.glassfish.tyrus.core.ServiceFinder.DefaultServiceIteratorProvider
- createClassIterator(Class<T>, String, ClassLoader, boolean) - Method in class org.glassfish.tyrus.core.ServiceFinder.ServiceIteratorProvider
-
Iterate over provider classes of a service.
- createClient() - Static method in class org.glassfish.tyrus.client.ClientManager
-
Create new
ClientManager
instance. - createClient() - Static method in class org.glassfish.tyrus.core.ComponentProviderService
-
Create new instance of
ComponentProviderService
. - createClient(WebSocketContainer) - Static method in class org.glassfish.tyrus.client.ClientManager
-
Create new ClientManager instance on top of provided
WebSocketContainer
instance. - createClient(String) - Static method in class org.glassfish.tyrus.client.ClientManager
-
Create new ClientManager instance.
- createClient(String, WebSocketContainer) - Static method in class org.glassfish.tyrus.client.ClientManager
-
Create new ClientManager instance on top of provided
WebSocketContainer
instance. - createClientHandshake(RequestContext) - Static method in class org.glassfish.tyrus.core.Handshake
-
Client-side handshake.
- createConnection() - Method in interface org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeInfo
-
Create new
Connection
whenClientEngine.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.
- createConnectionId() - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Create connection id.
- createContainer(Map<String, Object>) - Method in class org.glassfish.tyrus.container.grizzly.server.GrizzlyServerContainer
- createContainer(Map<String, Object>) - Method in class org.glassfish.tyrus.spi.ServerContainerFactory
-
Create container delegate method.
- createEndpoint() - Method in class org.glassfish.tyrus.core.wsadl.model.ObjectFactory
-
Create an instance of
Endpoint
- createHandler(boolean, MaskingKeyGenerator) - Method in enum class org.glassfish.tyrus.core.Version
- createIterator(Class<T>, String, ClassLoader, boolean) - Method in class org.glassfish.tyrus.core.ServiceFinder.DefaultServiceIteratorProvider
- createIterator(Class<T>, String, ClassLoader, boolean) - Method in class org.glassfish.tyrus.core.ServiceFinder.ServiceIteratorProvider
-
Iterate over provider instances of a service.
- createServerContainer() - Static method in class org.glassfish.tyrus.spi.ServerContainerFactory
-
Create new
ServerContainer
with default configuration. - createServerContainer(Map<String, Object>) - Static method in class org.glassfish.tyrus.spi.ServerContainerFactory
-
Create new
ServerContainer
with configuration. - createSessionForRemoteEndpoint(TyrusWebSocket, String, List<Extension>, DebugContext) - Method in class org.glassfish.tyrus.core.TyrusEndpointWrapper
-
Creates a Session based on the
TyrusWebSocket
, subprotocols and extensions. - createSessionId() - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Create session id.
- createSSLContext() - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Create
SSLContext
from current configuration. - createSSLEngine(String) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Create and configure
SSLEngine
, based on current settings. - createUpgradeRequest(ClientEngine.TimeoutHandler) - Method in class org.glassfish.tyrus.client.TyrusClientEngine
- createUpgradeRequest(ClientEngine.TimeoutHandler) - Method in interface org.glassfish.tyrus.spi.ClientEngine
-
Create upgrade request and register
ClientEngine.TimeoutHandler
. - createURI(String...) - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Create a URI by substituting any template variables for corresponding template values.
- createURI(String[], int, int) - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Create a URI by substituting any template variables for corresponding template values.
- createURI(String, String, String, String, String, String, String, String, Object[], boolean, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Construct a URI from the component parts each of which may contain template variables.
- createURI(String, String, String, String, String, String, String, String, Map<String, ?>, boolean, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Construct a URI from the component parts each of which may contain template variables.
- createURI(Map<String, String>) - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Create a URI by substituting any template variables for corresponding template values.
- createURIWithStringValues(String, String, String, String, String, String, String, String, String[], boolean, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Construct a URI from the component parts each of which may contain template variables.
- createURIWithStringValues(String, String, String, String, String, String, String, String, Map<String, ?>, boolean, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Construct a URI from the component parts each of which may contain template variables.
- Credentials - Class in org.glassfish.tyrus.client.auth
-
Credentials can be used when configuring authentication properties used during client handshake.
- Credentials(String, byte[]) - Constructor for class org.glassfish.tyrus.client.auth.Credentials
-
Create new credentials.
- Credentials(String, String) - Constructor for class org.glassfish.tyrus.client.auth.Credentials
-
Create new credentials.
- CREDENTIALS - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
Authentication credentials.
D
- DATA_UNEXPECTED_LENGTH(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Data read ({0}) is not the expected size ({1}).
- DebugContext - Class in org.glassfish.tyrus.core
-
A
Logger
wrapper that gives logging records a common formatting and temporarily stores log records and postpones their logging until they can be provided with a session ID. - DebugContext() - Constructor for class org.glassfish.tyrus.core.DebugContext
-
Constructor that configures tracing to be OFF.
- DebugContext(DebugContext.TracingThreshold) - Constructor for class org.glassfish.tyrus.core.DebugContext
-
Constructor that configures tracing to be ON and accepts tracing threshold as a parameter.
- DebugContext.TracingThreshold - Enum Class in org.glassfish.tyrus.core
-
Tracing threshold - used for configuration granularity of information that will be sent in tracing headers.
- DebugContext.TracingType - Enum Class in org.glassfish.tyrus.core
-
Type of tracing - used for tracing configuration.
- DebugContext.Type - Enum Class in org.glassfish.tyrus.core
-
Type of the record - used to graphically distinguish these message types in the log.
- declaringClass - Variable in class org.glassfish.tyrus.core.ReflectionHelper.DeclaringClassInterfacePair
- decode(InputStream) - Method in interface jakarta.websocket.Decoder.BinaryStream
-
Decode the given bytes read from the input stream into an object of type T.
- decode(Reader) - Method in interface jakarta.websocket.Decoder.TextStream
-
Reads the websocket message from the implementation provided Reader and decodes it into an instance of the supplied object type.
- decode(String) - Method in interface jakarta.websocket.Decoder.Text
-
Decode the given String into an object of type T.
- decode(String) - Method in class org.glassfish.tyrus.core.coder.NoOpTextCoder
- decode(String) - Method in class org.glassfish.tyrus.core.coder.PrimitiveDecoders.BooleanDecoder
- decode(String) - Method in class org.glassfish.tyrus.core.coder.PrimitiveDecoders.ByteDecoder
- decode(String) - Method in class org.glassfish.tyrus.core.coder.PrimitiveDecoders.CharacterDecoder
- decode(String) - Method in class org.glassfish.tyrus.core.coder.PrimitiveDecoders.DoubleDecoder
- decode(String) - Method in class org.glassfish.tyrus.core.coder.PrimitiveDecoders.FloatDecoder
- decode(String) - Method in class org.glassfish.tyrus.core.coder.PrimitiveDecoders.IntegerDecoder
- decode(String) - Method in class org.glassfish.tyrus.core.coder.PrimitiveDecoders.LongDecoder
- decode(String) - Method in class org.glassfish.tyrus.core.coder.PrimitiveDecoders.ShortDecoder
- decode(String) - Method in class org.glassfish.tyrus.core.coder.ReaderDecoder
- decode(String, UriComponent.Type) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Decodes characters of a string that are percent-encoded octets using UTF-8 decoding (if needed).
- decode(ByteBuffer) - Method in interface jakarta.websocket.Decoder.Binary
-
Decode the given bytes into an object of type T.
- decode(ByteBuffer) - Method in class org.glassfish.tyrus.core.coder.InputStreamDecoder
- decode(ByteBuffer) - Method in class org.glassfish.tyrus.core.coder.NoOpByteArrayCoder
- decode(ByteBuffer) - Method in class org.glassfish.tyrus.core.coder.NoOpByteBufferCoder
- DecodeException - Exception Class in jakarta.websocket
-
A general exception that occurs when trying to decode a custom object from a text or binary message.
- DecodeException(String, String) - Constructor for exception class jakarta.websocket.DecodeException
-
Constructs a DecodedException with the given encoded string that cannot be decoded, and reason why.
- DecodeException(String, String, Throwable) - Constructor for exception class jakarta.websocket.DecodeException
-
Constructor with the text data that could not be decoded, and the reason why it failed to be, and the cause.
- DecodeException(ByteBuffer, String) - Constructor for exception class jakarta.websocket.DecodeException
-
Constructs a DecodedException with the given ByteBuffer that cannot be decoded, and reason why.
- DecodeException(ByteBuffer, String, Throwable) - Constructor for exception class jakarta.websocket.DecodeException
-
Constructor with the binary data that could not be decoded, and the reason why it failed to be, and the cause.
- decodeMatrix(String, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Decode the matrix component of a URI path segment.
- decodePath(String, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Decode the path component of a URI as path segments.
- decodePath(URI, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Decode the path component of a URI as path segments.
- decodePathSegment(List<PathSegment>, String, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Decode the path segment and add it to the list of path segments.
- decodeQuery(String, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Decode the query component of a URI.
- decodeQuery(String, boolean, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Decode the query component of a URI.
- decodeQuery(URI, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Decode the query component of a URI.
- Decoder - Interface in jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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.
- decoders() - Element in annotation interface jakarta.websocket.ClientEndpoint
-
The array of Java classes that are to act as Decoders for messages coming into the client.
- decoders() - Element in annotation interface jakarta.websocket.server.ServerEndpoint
-
The ordered array of decoder classes this endpoint will use.
- decoders(List<Class<? extends Decoder>>) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Assign the list of decoder implementation classes the client will use.
- decoders(List<Class<? extends Decoder>>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the decoder implementation classes to use in the configuration.
- decoders(List<Class<? extends Decoder>>) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfig.Builder
-
Sets the decoder implementation classes to use in the configuration.
- DEFAULT_CONFIG - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Default SSL configuration.
- DEFAULT_INCOMING_BUFFER_SIZE - Static variable in class org.glassfish.tyrus.client.TyrusClientEngine
-
Default incoming buffer size for client container.
- DefaultComponentProvider - Class in org.glassfish.tyrus.core
-
Provides instances using reflection.
- DefaultComponentProvider() - Constructor for class org.glassfish.tyrus.core.DefaultComponentProvider
- defaultConfig() - Static method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Create new client thread pool configuration instance.
- DefaultServiceIteratorProvider() - Constructor for class org.glassfish.tyrus.core.ServiceFinder.DefaultServiceIteratorProvider
- DEPENDENT_CLASS_OF_PROVIDER_FORMAT_ERROR(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
{0}.
- DEPENDENT_CLASS_OF_PROVIDER_NOT_FOUND(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
A dependent class, {0}, of the class {1} implementing the provider {2} is not found.
- deploymentException(String, Throwable) - Static method in class org.glassfish.tyrus.client.exception.Exceptions
-
Get the Deployment Exception, or return the exception if of the type.
- DeploymentException - Exception Class in jakarta.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 class jakarta.websocket.DeploymentException
-
Creates a deployment exception with the given reason for the deployment failure.
- DeploymentException(String, Throwable) - Constructor for exception class jakarta.websocket.DeploymentException
-
Creates a deployment exception with the given reason for the deployment failure and wrapped cause of the failure.
- DeploymentHandshakeException - Exception Class in org.glassfish.tyrus.client.exception
-
The
DeploymentException
wrapping theHandshakeException
and makes the HTTP status code accessible directly. - DeploymentHandshakeException(String) - Constructor for exception class org.glassfish.tyrus.client.exception.DeploymentHandshakeException
- DeploymentHandshakeException(String, HandshakeException) - Constructor for exception class org.glassfish.tyrus.client.exception.DeploymentHandshakeException
- destroy() - Method in interface jakarta.websocket.Decoder
-
This method is called when the decoder is about to be removed from service in order that any resources the decoder used may be closed gracefully.
- destroy() - Method in interface jakarta.websocket.Encoder
-
This method is called when the encoder is about to be removed from service in order that any resources the encoder used may be closed gracefully.
- destroy() - Method in class org.glassfish.tyrus.core.coder.CoderAdapter
-
This method does nothing.
- destroy() - Method in class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
- destroy(Object) - Method in class org.glassfish.tyrus.core.ComponentProvider
-
Destroys the given managed instance.
- destroy(Object) - Method in class org.glassfish.tyrus.core.DefaultComponentProvider
- destroy(Object) - Method in class org.glassfish.tyrus.gf.cdi.CdiComponentProvider
- destroy(Object) - Method in class org.glassfish.tyrus.gf.ejb.EjbComponentProvider
- destroy(ExtendedExtension.ExtensionContext) - Method in interface org.glassfish.tyrus.core.extension.ExtendedExtension
-
Context lifecycle method.
- destroyDistributedUserProperties(String) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Destroy map which holds distributed user properties.
- disableProvidedBasicAuth() - Method in class org.glassfish.tyrus.client.auth.AuthConfig.Builder
-
Disable provided Basic
Authenticator
. - disableProvidedDigestAuth() - Method in class org.glassfish.tyrus.client.auth.AuthConfig.Builder
-
Disable provided Digest
Authenticator
. - DistributedSession - Interface in org.glassfish.tyrus.core.cluster
-
Extended
Session
which adds distributed properties. - doEncode(Session, Object) - Method in class org.glassfish.tyrus.core.TyrusEndpointWrapper
- doneDeployment() - Method in class org.glassfish.tyrus.server.TyrusServerContainer
-
Container is no longer required to accept
TyrusServerContainer.addEndpoint(jakarta.websocket.server.ServerEndpointConfig)
andTyrusServerContainer.addEndpoint(Class)
calls. - DoubleDecoder() - Constructor for class org.glassfish.tyrus.core.coder.PrimitiveDecoders.DoubleDecoder
- DRAFT17 - Enum constant in enum class org.glassfish.tyrus.core.Version
E
- eager(Value<T>) - Static method in class org.glassfish.tyrus.core.collection.Values
-
Get a new eagerly initialized
value provider
. - EjbComponentProvider - Class in org.glassfish.tyrus.gf.ejb
-
Provides the instance for the supported EJB classes.
- EjbComponentProvider() - Constructor for class org.glassfish.tyrus.gf.ejb.EjbComponentProvider
- empty() - Static method in class org.glassfish.tyrus.core.collection.Values
- EMPTY - Static variable in class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
The empty pattern that matches the null or empty string.
- EMPTY - Static variable in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
The empty URI template that matches the
null
or empty URI path. - EMPTY_CONFIGURATION - Static variable in interface org.glassfish.tyrus.core.TyrusConfiguration
- EMPTY_PATTERN - Static variable in class org.glassfish.tyrus.core.uri.internal.PathPattern
-
Empty path pattern matching only empty string.
- 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.
- enabledCipherSuites - Variable in class org.glassfish.tyrus.client.SslEngineConfigurator
-
The list of cipher suites.
- enabledProtocols - Variable in class org.glassfish.tyrus.client.SslEngineConfigurator
-
The list of protocols.
- encode(byte[]) - Method in class org.glassfish.tyrus.core.coder.NoOpByteArrayCoder
- encode(Object) - Method in class org.glassfish.tyrus.core.coder.ToStringEncoder
- encode(String) - Method in class org.glassfish.tyrus.core.coder.NoOpTextCoder
- encode(String, UriComponent.Type) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Encodes the characters of string that are either non-ASCII characters or are ASCII characters that must be percent-encoded using the UTF-8 encoding.
- encode(String, UriComponent.Type, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Encodes the characters of string that are either non-ASCII characters or are ASCII characters that must be percent-encoded using the UTF-8 encoding.
- encode(ByteBuffer) - Method in class org.glassfish.tyrus.core.coder.NoOpByteBufferCoder
- encode(T) - Method in interface jakarta.websocket.Encoder.Binary
-
Encode the given object into a byte array.
- encode(T) - Method in interface jakarta.websocket.Encoder.Text
-
Encode the given object into a String.
- encode(T, OutputStream) - Method in interface jakarta.websocket.Encoder.BinaryStream
-
Encode the given object into a binary stream written to the implementation provided OutputStream.
- encode(T, Writer) - Method in interface jakarta.websocket.Encoder.TextStream
-
Encode the given object to a character stream writing it to the supplied Writer.
- EncodeException - Exception Class in jakarta.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 class jakarta.websocket.EncodeException
-
Constructor with the object being encoded, and the reason why it failed to be.
- EncodeException(Object, String, Throwable) - Constructor for exception class jakarta.websocket.EncodeException
-
Constructor with the object being encoded, and the reason why it failed to be, and the cause.
- encodeLiteralCharacters(String) - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Encode literal characters of a template.
- Encoder - Interface in jakarta.websocket
-
The Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages.
- Encoder.Binary<T> - Interface in jakarta.websocket
-
This interface defines how to provide a way to convert a custom object into a binary message.
- Encoder.BinaryStream<T> - Interface in jakarta.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 jakarta.websocket
-
This interface defines how to provide a way to convert a custom object into a text message.
- Encoder.TextStream<T> - Interface in jakarta.websocket
-
This interface may be implemented by encoding algorithms that want to write the encoded object to a character stream.
- encoders() - Element in annotation interface jakarta.websocket.ClientEndpoint
-
The array of Java classes that are to act as Encoders for messages sent by the client.
- encoders() - Element in annotation interface jakarta.websocket.server.ServerEndpoint
-
The ordered array of encoder classes this endpoint will use.
- encoders(List<Class<? extends Encoder>>) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Assign the list of encoder implementation classes the client will use.
- encoders(List<Class<? extends Encoder>>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the list of encoder implementation classes for this builder.
- encoders(List<Class<? extends Encoder>>) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfig.Builder
-
Sets the list of encoder implementation classes for this builder.
- encodeTemplateNames(String) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Encodes a string with template parameters names present, specifically the characters '{' and '}' will be percent-encoded.
- ENCODING_FAILED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Encoding failed.
- END_OF_PATH_PATTERN - Static variable in class org.glassfish.tyrus.core.uri.internal.PathPattern
-
Path pattern matching the end of a URI path.
- endpoint - Variable in class org.glassfish.tyrus.core.wsadl.model.Application
- Endpoint - Class in jakarta.websocket
-
The Web Socket Endpoint represents an object that can handle websocket conversations.
- Endpoint - Class in org.glassfish.tyrus.core.wsadl.model
-
Java class for anonymous complex type
- Endpoint() - Constructor for class jakarta.websocket.Endpoint
- Endpoint() - Constructor for class org.glassfish.tyrus.core.wsadl.model.Endpoint
- ENDPOINT_ANNOTATION_NOT_FOUND(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
{0} annotation not found on class {1}.
- ENDPOINT_EXCEPTION_FROM_ON_ERROR(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Exception thrown from onError method {0}.
- ENDPOINT_MAX_MESSAGE_SIZE_TOO_LONG(Object, Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
MaxMessageSize {0} on method {1} in endpoint {2} is larger than the container incoming buffer size {3}.
- ENDPOINT_MULTIPLE_METHODS(Object, Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Multiple methods using {0} annotation in class {1}: {2} and {3}.
- ENDPOINT_MULTIPLE_SESSION_PARAM(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Method {0} has got two or more Session parameters.
- ENDPOINT_UNHANDLED_EXCEPTION(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Unhandled exception in endpoint {0}.
- ENDPOINT_UNKNOWN_PARAMS(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Unknown parameter(s) for {0}.{1} method annotated with @OnError annotation: {2}.
- ENDPOINT_WRONG_PARAMS(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Method: {0}.{1}: has got wrong number of params.
- ENDPOINT_WRONG_PATH_PARAM(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Method: {0}: {1} is not allowed type for @PathParameter.
- EndpointConfig - Interface in jakarta.websocket
-
The endpoint configuration contains all the information needed during the handshake process for this end point.
- EndpointEventListener - Interface in org.glassfish.tyrus.core.monitoring
-
Listens to endpoint-level events that are interesting for monitoring.
- endsWithSlash() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Check if the URI template ends in a slash (
'/'
). - entrySet() - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- equals(Object) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
- equals(Object) - Method in class org.glassfish.tyrus.container.grizzly.client.GrizzlyWriter
- equals(Object) - Method in class org.glassfish.tyrus.core.TyrusExtension
- equals(Object) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- equals(Object) - Method in class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
- equals(Object) - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Equality is calculated from the String of the regular expression generated from the templates.
- equalsIgnoreValueOrder(MultivaluedMap<K, V>) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- equalsIgnoreValueOrder(MultivaluedMap<K, V>) - Method in interface org.glassfish.tyrus.core.uri.internal.MultivaluedMap
-
Compare the specified map with this map for equality modulo the order of values for each key.
- EQUIVALENT_PATHS(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Found equivalent paths.
- error() - Method in class org.glassfish.tyrus.core.StrictUtf8.Parser
-
If the previous parse operation detected an error, return the object describing that error.
- ERROR_CAUGHT_WHILE_LOADING_SPI_PROVIDERS() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Error caught while loading SPI providers.
- ErrorCollector - Class in org.glassfish.tyrus.core
-
Used to collect deployment errors to present these to the user together.
- ErrorCollector() - Constructor for class org.glassfish.tyrus.core.ErrorCollector
- evaluate() - Method in interface org.glassfish.tyrus.core.BaseContainer.ShutDownCondition
- EXCEPTION_CAUGHT_WHILE_LOADING_SPI_PROVIDERS() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Exception caught while loading SPI providers.
- EXCEPTION_CLOSE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Exception thrown when closing connection with message: {0}
- Exceptions - Class in org.glassfish.tyrus.client.exception
-
Converts the exceptions into more specific ones.
- Exceptions() - Constructor for class org.glassfish.tyrus.client.exception.Exceptions
- execute() - Method in class org.glassfish.tyrus.container.grizzly.client.TaskProcessor.Task
-
To be overridden.
- ExecutorServiceProvider - Class in org.glassfish.tyrus.core
- ExecutorServiceProvider() - Constructor for class org.glassfish.tyrus.core.ExecutorServiceProvider
- ExtendedExtension - Interface in org.glassfish.tyrus.core.extension
-
WebSocket
Extension
. - ExtendedExtension.ExtensionContext - Interface in org.glassfish.tyrus.core.extension
-
Context present as a parameter in all
ExtendedExtension
methods. - Extension - Interface in jakarta.websocket
-
A simple representation of a websocket extension as a name and map of extension parameters.
- EXTENSION_EXCEPTION(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Extension ''{0}'' threw an exception during processOutgoing method invocation: "{1}".
- Extension.Parameter - Interface in jakarta.websocket
-
This member interface defines a single websocket extension parameter.
- extensions(List<Extension>) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Set the extensions for the configuration this builder will build.
- extensions(List<Extension>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the extensions to use in the configuration.
- extensions(List<Extension>) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfig.Builder
-
Sets the extensions to use in the configuration.
F
- failed(Throwable) - Method in class org.glassfish.tyrus.spi.CompletionHandler
-
The operation was failed.
- fin(boolean) - Method in class org.glassfish.tyrus.core.frame.Frame.Builder
-
Set FIN flag.
- find(Class<T>) - Static method in class org.glassfish.tyrus.core.ServiceFinder
-
Locates and incrementally instantiates the available providers of a given service using the context class loader.
- find(Class<T>, boolean) - Static method in class org.glassfish.tyrus.core.ServiceFinder
-
Locates and incrementally instantiates the available providers of a given service using the context class loader.
- find(Class<T>, ClassLoader) - Static method in class org.glassfish.tyrus.core.ServiceFinder
-
Locates and incrementally instantiates the available providers of a given service using the given class loader.
- find(Class<T>, ClassLoader, boolean) - Static method in class org.glassfish.tyrus.core.ServiceFinder
-
Locates and incrementally instantiates the available providers of a given service using the given class loader.
- find(String) - Static method in class org.glassfish.tyrus.core.ServiceFinder
-
Locates and incrementally instantiates the available classes of a given service file using the context class loader.
- findMethodOnClass(Class, Method) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Find a method on a class given an existing method.
- FloatDecoder() - Constructor for class org.glassfish.tyrus.core.coder.PrimitiveDecoders.FloatDecoder
- flush() - Method in class org.glassfish.tyrus.core.DebugContext
-
Write pending messages to the log.
- flushBatch() - Method in interface jakarta.websocket.RemoteEndpoint
-
This method is only used when batching is allowed for this RemoteEndpint.
- flushBatch() - Method in class org.glassfish.tyrus.core.TyrusRemoteEndpoint
- FRAGMENT - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI fragment component type.
- FRAGMENT_INVALID_OPCODE() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Fragment sent but opcode was not 0.
- Frame - Class in org.glassfish.tyrus.core.frame
-
WebSocket frame representation.
- Frame(Frame) - Constructor for class org.glassfish.tyrus.core.frame.Frame
-
Copy constructor.
- FRAME_BUFFER_SIZE - Static variable in class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
-
The size to precede OutOfMemory Exception and potentially DDoS attacks when buffering incoming WebSocket frames.
- FRAME_WRITE_CANCELLED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Frame writing was canceled.
- Frame.Builder - Class in org.glassfish.tyrus.core.frame
-
Frame builder.
- fromClass(Class<?>, ComponentProviderService, boolean, int, ErrorCollector, EndpointEventListener) - Static method in class org.glassfish.tyrus.core.AnnotatedEndpoint
-
Create
AnnotatedEndpoint
from class. - fromClass(Class<?>, ComponentProviderService, boolean, int, ErrorCollector, EndpointEventListener, Set<Extension>) - Static method in class org.glassfish.tyrus.core.AnnotatedEndpoint
-
Create
AnnotatedEndpoint
from class. - fromDecoderClasses(List<Class<? extends Decoder>>) - Static method in class org.glassfish.tyrus.core.MessageHandlerManager
-
Construct manager.
- fromHeaders(List<String>) - Static method in class org.glassfish.tyrus.core.TyrusExtension
- fromInstance(Object, ComponentProviderService, boolean, int, ErrorCollector) - Static method in class org.glassfish.tyrus.core.AnnotatedEndpoint
-
Create
AnnotatedEndpoint
from instance. - fromInstance(Object, ComponentProviderService, boolean, int, ErrorCollector, Set<Extension>) - Static method in class org.glassfish.tyrus.core.AnnotatedEndpoint
-
Create
AnnotatedEndpoint
from instance. - fromString(List<String>) - Static method in class org.glassfish.tyrus.core.TyrusExtension
-
Parsing of one
Extension
. - fullRelativeUri(URI) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Return the
Request-Uri
representation as defined by HTTP spec.
G
- generateAuthorizationHeader(URI, String, Credentials) - Method in class org.glassfish.tyrus.client.auth.Authenticator
-
Generate value used as ""Authorization"" header value for next request.
- genericInterface - Variable in class org.glassfish.tyrus.core.ReflectionHelper.DeclaringClassInterfacePair
- get() - Method in interface org.glassfish.tyrus.core.collection.SupplierWithEx
- get() - Method in interface org.glassfish.tyrus.core.collection.Value
-
Get the stored value.
- get(Object) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- getAllMatches(String, Set<TyrusEndpointWrapper>, DebugContext) - Static method in class org.glassfish.tyrus.core.uri.Match
-
Return a list of all endpoints with path matching the request path.
- getAllSessions() - Method in class org.glassfish.tyrus.core.TyrusSession
-
Get set of all sessions opened to the same endpoint.
- getAnnotatedEndpointClasses(Set<Class<?>>) - Method in interface jakarta.websocket.server.ServerApplicationConfig
-
Return a set of annotated endpoint classes that the server container must deploy.
- getAnnotatedEndpointClasses(Set<Class<?>>) - Method in class org.glassfish.tyrus.server.TyrusServerConfiguration
-
Gets all the classes annotated with
ServerEndpoint
annotation which should be deployed. - getAny() - Method in class org.glassfish.tyrus.core.wsadl.model.Application
-
Gets the value of the any property.
- getApplicationData() - Method in interface jakarta.websocket.PongMessage
-
The application data inside the pong message from the peer.
- getApplicationEventListener() - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Get
ApplicationEventListener
related to currentTyrusWebSocketEngine
instance. - getArguments() - Method in interface org.glassfish.tyrus.core.l10n.Localizable
-
Returns the arguments for message formatting.
- getArguments() - Method in class org.glassfish.tyrus.core.l10n.LocalizableMessage
- getArrayClass(Class) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get Array class of component class.
- getAsyncRemote() - Method in interface jakarta.websocket.Session
-
Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send messages asynchronously to the peer.
- getAsyncRemote() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get a reference a
RemoteEndpoint.Async
object representing the peer of this conversation that is able to send messages asynchronously to the peer. - getAsyncRemote() - Method in class org.glassfish.tyrus.core.TyrusSession
- getAuthenticators() - Method in class org.glassfish.tyrus.client.auth.AuthConfig
-
Get an unmodifiable map of authenticators, where case insensitive authentication scheme to
Authenticator
. - getBasicRemote() - Method in interface jakarta.websocket.Session
-
Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send messages synchronously to the peer.
- getBasicRemote() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get a reference a
RemoteEndpoint.Basic
object representing the peer of this conversation that is able to send messages synchronously to the peer. - getBasicRemote() - Method in class org.glassfish.tyrus.core.TyrusSession
- getBatchingAllowed() - Method in interface jakarta.websocket.RemoteEndpoint
-
Return whether the implementation is allowed to batch outgoing messages before sending.
- getBatchingAllowed() - Method in class org.glassfish.tyrus.core.TyrusRemoteEndpoint
- getBytes() - Method in exception class jakarta.websocket.DecodeException
-
Return the ByteBuffer containing either the whole message, or the partial message, that could not be decoded, or
null
if this exception arose from a failure to decode a text message. - getClass(Class, Class) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Find the declaring class that implements or extends an interface.
- getClassType(Class<?>, Class<?>) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Find a type of the class given it's Superclass.
- getClientManager() - Method in class org.glassfish.tyrus.server.TyrusServerContainer
-
Can be overridden to provide own
ClientManager
implementation or instance. - getCloseCode() - Method in class jakarta.websocket.CloseReason
-
The Close code associated with this CloseReason.
- getCloseCode(int) - Static method in enum class jakarta.websocket.CloseReason.CloseCodes
-
Creates a CloseCode from the given int code number.
- 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)
. - getCloseReason() - Method in enum class org.glassfish.tyrus.core.CloseReasons
-
Get close reason.
- getCloseReason() - Method in class org.glassfish.tyrus.core.frame.CloseFrame
-
Get close reason.
- getCloseReason() - Method in exception class org.glassfish.tyrus.core.ProtocolException
- getCloseReason() - Method in exception class org.glassfish.tyrus.core.Utf8DecodingException
- getCloseReason() - Method in exception class org.glassfish.tyrus.core.WebSocketException
-
Get close reason.
- getCode() - Method in interface jakarta.websocket.CloseReason.CloseCode
-
Returns the code number, for example the integer '1000' for normal closure.
- getCode() - Method in enum class jakarta.websocket.CloseReason.CloseCodes
-
Return the code number of this status code.
- getCoder() - Method in class org.glassfish.tyrus.core.coder.CoderWrapper
-
Get coder instance.
- getCoderClass() - Method in class org.glassfish.tyrus.core.coder.CoderWrapper
-
Get coder class.
- getCoderInstance(Class<T>, Session, EndpointConfig, ErrorCollector) - Method in class org.glassfish.tyrus.core.ComponentProviderService
- getConfigurator() - Method in interface jakarta.websocket.ClientEndpointConfig
-
Return the custom configurator for this configuration.
- getConfigurator() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the
ServerEndpointConfig.Configurator
this configuration is using. - getConfigurator() - Method in class org.glassfish.tyrus.core.ServerEndpointConfigWrapper
- getContainer() - Method in class jakarta.websocket.ContainerProvider
-
Create a new instance of the the WebSocket container implementation.
- getContainer() - Method in interface jakarta.websocket.Session
-
Return the container that this session is part of.
- getContainer() - Method in class org.glassfish.tyrus.container.grizzly.client.GrizzlyContainerProvider
- getContainer() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - getContainer() - Method in class org.glassfish.tyrus.core.TyrusSession
- getContainerDefaultConfigurator() - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Return the platform default configurator.
- getContextClassLoaderPA() - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get privileged action to obtain context class loader.
- getCorePoolSize() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Get the core thread pool size - the size of the thread pool will never bee smaller than this.
- getDeclaringClass(AccessibleObject) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get declaring class of provided field, method or constructor.
- getDecoders() - Method in interface jakarta.websocket.EndpointConfig
-
Return the Decoder implementation classes configured.
- getDecoders() - Method in class org.glassfish.tyrus.core.ServerEndpointConfigWrapper
- getDefaultAsyncSendTimeout() - Method in interface jakarta.websocket.WebSocketContainer
-
Return the number of milliseconds the implementation will timeout attempting to send a websocket message for all RemoteEndpoints associated with this container.
- getDefaultAsyncSendTimeout() - Method in class org.glassfish.tyrus.client.ClientManager
- getDefaultAsyncSendTimeout() - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- getDefaultMaxBinaryMessageBufferSize() - Method in interface jakarta.websocket.WebSocketContainer
-
Returns the default maximum size of incoming binary message that this container will buffer.
- getDefaultMaxBinaryMessageBufferSize() - Method in class org.glassfish.tyrus.client.ClientManager
- getDefaultMaxBinaryMessageBufferSize() - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- getDefaultMaxSessionIdleTimeout() - Method in interface jakarta.websocket.WebSocketContainer
-
Return the default time in milliseconds after which any web socket sessions in this container will be closed if it has been inactive.
- getDefaultMaxSessionIdleTimeout() - Method in class org.glassfish.tyrus.client.ClientManager
- getDefaultMaxSessionIdleTimeout() - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- getDefaultMaxTextMessageBufferSize() - Method in interface jakarta.websocket.WebSocketContainer
-
Returns the default maximum size of incoming text message that this container will buffer.
- getDefaultMaxTextMessageBufferSize() - Method in class org.glassfish.tyrus.client.ClientManager
- getDefaultMaxTextMessageBufferSize() - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- getDelay() - Method in class org.glassfish.tyrus.client.ClientManager.ReconnectHandler
-
Get reconnect delay.
- getDelay() - Method in exception class org.glassfish.tyrus.client.RetryAfterException
-
Get a delay specified in "Retry-After" response header in seconds.
- getDistributedProperties() - Method in interface org.glassfish.tyrus.core.cluster.DistributedSession
-
Get distributed properties.
- getDistributedProperties() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
- getDistributedProperties() - Method in class org.glassfish.tyrus.core.TyrusSession
- getDistributedSessionProperties(String) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Get the map containing session properties to be shared among nodes.
- getDistributedUserProperties(String) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Get the map containing session user properties to be shared among nodes.
- getEnabledCipherSuites() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Get enabled cipher suites.
- getEnabledProtocols() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Get enabled protocols.
- getEncoders() - Method in interface jakarta.websocket.EndpointConfig
-
Return the Encoder implementation classes configured.
- getEncoders() - Method in class org.glassfish.tyrus.core.ServerEndpointConfigWrapper
- getEndpoint() - Method in class org.glassfish.tyrus.core.wsadl.model.Application
-
Gets the value of the endpoint property.
- getEndpointClass() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Returns the Class of the endpoint this configuration is configuring.
- getEndpointClass() - Method in class org.glassfish.tyrus.core.ServerEndpointConfigWrapper
- getEndpointConfig() - Method in class org.glassfish.tyrus.core.AnnotatedEndpoint
- getEndpointConfig() - Method in class org.glassfish.tyrus.core.TyrusEndpointWrapper
-
Get Endpoint configuration.
- getEndpointConfigs(Set<Class<? extends Endpoint>>) - Method in interface jakarta.websocket.server.ServerApplicationConfig
-
Return a set of ServerEndpointConfig instances that the server container will use to deploy the programmatic endpoints.
- getEndpointConfigs(Set<Class<? extends Endpoint>>) - Method in class org.glassfish.tyrus.server.TyrusServerConfiguration
-
Gets all the
ServerEndpointConfig
classes which should be deployed. - getEndpointInstance(Class<T>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
This method is called by the container each time a new client connects to the logical endpoint this configurator configures.
- getEndpointInstance(Class<T>) - Method in class org.glassfish.tyrus.core.ComponentProviderService
-
This method is called by the container each time a new client connects to the logical endpoint this configurator configures.
- getEndpointInstance(Class<T>) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfigurator
- getEndpointPath() - Method in class org.glassfish.tyrus.core.TyrusEndpointWrapper
-
Server-side; Get Endpoint absolute path.
- getEndpointWrapper() - Method in class org.glassfish.tyrus.core.uri.Match
-
Get endpoint wrapper.
- getException() - Method in class jakarta.websocket.SendResult
-
The problem sending the message.
- getExecutorService() - Method in class org.glassfish.tyrus.core.BaseContainer
-
Returns a container-managed
ExecutorService
registered underjava:comp/DefaultManagedExecutorService
or if the lookup has failed, it returns aExecutorService
created and managed by this instance ofBaseContainer
. - getExecutorService() - Method in class org.glassfish.tyrus.core.ExecutorServiceProvider
-
Get the
ExecutorService
. - getExtensions() - Method in interface jakarta.websocket.ClientEndpointConfig
-
Return the extensions, in order of preference, favorite first, that this client would like to use for its sessions.
- getExtensions() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the websocket extensions configured.
- getExtensions() - Method in class org.glassfish.tyrus.core.ServerEndpointConfigWrapper
- getFirst(String, A) - Method in class org.glassfish.tyrus.core.uri.internal.MultivaluedStringMap
- getFirst(String, Class<A>) - Method in class org.glassfish.tyrus.core.uri.internal.MultivaluedStringMap
- getFirst(K) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- getFirst(K) - Method in interface org.glassfish.tyrus.core.uri.internal.MultivaluedMap
-
A shortcut to get the first value of the supplied key.
- getFirstHeaderValue(String) - Method in class org.glassfish.tyrus.spi.UpgradeResponse
-
Gets the value of the response header with the given name.
- getFrameType() - Method in class org.glassfish.tyrus.core.frame.TyrusFrame
-
Returns the type of the frame.
- getFromStringStringMethod(Class) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get the static fromString(String ) method.
- getGenericClass(Type) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get the class that is the type argument of a parameterized type.
- getGroupCounts() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Get the capturing group counts for each template variable.
- getGroupIndexes() - Method in class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
Get the group indexes to capturing groups.
- getGroupIndexes() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Get the group indexes to capturing groups.
- getHeader(String) - Method in class org.glassfish.tyrus.core.RequestContext
-
Returns the header value corresponding to the name.
- getHeader(String) - Method in class org.glassfish.tyrus.spi.UpgradeRequest
-
Returns the value of the specified request header name.
- getHeaderFromList(List<T>) - Static method in class org.glassfish.tyrus.core.Utils
-
Creates single
String
value from provided List by callingObject.toString()
on each item and separating existing ones with", "
. - getHeaderFromList(List<T>, Utils.Stringifier<T>) - Static method in class org.glassfish.tyrus.core.Utils
-
Convert list of values to singe
String
usable as HTTP header value. - getHeaders() - Method in interface jakarta.websocket.HandshakeResponse
-
Return the map of HTTP headers to header values sent by the WebSocket server.
- getHeaders() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the read only map of HTTP headers to header values that came with the handshake request.
- getHeaders() - Method in class org.glassfish.tyrus.core.RequestContext
-
Get headers.
- getHeaders() - Method in class org.glassfish.tyrus.core.TyrusUpgradeResponse
-
Get HTTP headers.
- getHeartbeatInterval() - Method in class org.glassfish.tyrus.core.TyrusSession
-
Return an interval in milliseconds between scheduled periodic Pong messages.
- getHostnameVerifier() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Get custom hostname verifier.
- getHttpSession() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return a reference to the HttpSession that the web socket handshake that started this conversation was part of, if the implementation is part of a Java EE web container.
- getHttpSession() - Method in class org.glassfish.tyrus.core.RequestContext
- getHttpStatusCode() - Method in exception class org.glassfish.tyrus.client.exception.DeploymentHandshakeException
-
Get the error code.
- getHttpStatusCode() - Method in exception class org.glassfish.tyrus.core.HandshakeException
-
Get the error code.
- getId() - Method in interface jakarta.websocket.Session
-
Returns a string containing the unique identifier assigned to this session.
- getId() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get a string containing the unique identifier assigned to this session.
- getId() - Method in class org.glassfish.tyrus.core.TyrusSession
- getId() - Method in class org.glassfish.tyrus.core.wsadl.model.Endpoint
-
Gets the value of the id property.
- getInitialClassLoader() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Get the class loader (if any) to be initially exposed by threads from this pool.
- getInstalledExtensions() - Method in interface jakarta.websocket.WebSocketContainer
-
Return the set of Extensions installed in the container.
- getInstalledExtensions() - Method in class org.glassfish.tyrus.client.ClientManager
- getInstalledExtensions() - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- getInstance() - Static method in class org.glassfish.tyrus.core.OsgiRegistry
-
Returns an
OsgiRegistry
instance. - getInstance(Class<T>) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Creates an instance of
Class
c usingClass.newInstance()
. - getInstance(Class<T>, Session, ErrorCollector) - Method in class org.glassfish.tyrus.core.ComponentProviderService
-
Provide an instance of class which is coupled to
Session
. - getInstance(Class<T>, ErrorCollector) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Creates an instance of
Class
c usingClass.newInstance()
. - getInvocableMethod(Method) - Method in class org.glassfish.tyrus.core.ComponentProvider
-
Get the method which should be invoked instead provided one.
- getInvocableMethod(Method) - Method in class org.glassfish.tyrus.core.ComponentProviderService
- getInvocableMethod(Method) - Method in class org.glassfish.tyrus.core.DefaultComponentProvider
- getInvocableMethod(Method) - Method in class org.glassfish.tyrus.gf.ejb.EjbComponentProvider
- getKeepAliveTime(TimeUnit) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Get the max period of time a thread will wait for a new task to process.
- getKey() - Method in interface org.glassfish.tyrus.core.l10n.Localizable
-
Gets the key in the resource bundle.
- getKey() - Method in class org.glassfish.tyrus.core.l10n.LocalizableMessage
- getLocale() - Method in class org.glassfish.tyrus.core.l10n.Localizer
- getMaskingKey() - Method in class org.glassfish.tyrus.core.frame.Frame
-
Get masking key.
- getMatrixParameters() - Method in interface org.glassfish.tyrus.core.uri.internal.PathSegment
-
Get a map of the matrix parameters associated with the path segment.
- getMaxBinaryMessageBufferSize() - Method in interface jakarta.websocket.Session
-
The maximum length of incoming binary messages that this Session can buffer.
- getMaxBinaryMessageBufferSize() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the maximum length of incoming binary messages that this Session can buffer.
- getMaxBinaryMessageBufferSize() - Method in class org.glassfish.tyrus.core.TyrusSession
- getMaxIdleTimeout() - Method in interface jakarta.websocket.Session
-
Return the number of milliseconds before this session will be closed by the container if it is inactive, i.e. no messages are either sent or received in that time.
- getMaxIdleTimeout() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e. no messages are either sent or received in that time.
- getMaxIdleTimeout() - Method in class org.glassfish.tyrus.core.TyrusSession
- getMaxPoolSize() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Get max thread pool size.
- getMaxSessions() - Method in interface org.glassfish.tyrus.core.TyrusServerEndpointConfig
-
Returns configured maximal number of open sessions.
- getMaxTextMessageBufferSize() - Method in interface jakarta.websocket.Session
-
The maximum length of incoming text messages that this Session can buffer.
- getMaxTextMessageBufferSize() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the maximum length of incoming text messages that this Session can buffer.
- getMaxTextMessageBufferSize() - Method in class org.glassfish.tyrus.core.TyrusSession
- getMessage(String, Object...) - Method in class org.glassfish.tyrus.core.l10n.LocalizableMessageFactory
- getMessageHandlers() - Method in interface jakarta.websocket.Session
-
Return an unmodifiable copy of the set of MessageHandlers for this Session.
- getMessageHandlers() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - getMessageHandlers() - Method in class org.glassfish.tyrus.core.MessageHandlerManager
-
Get all successfully registered
MessageHandler
s. - getMessageHandlers() - Method in class org.glassfish.tyrus.core.TyrusSession
- getMessageType() - Method in class org.glassfish.tyrus.spi.WriterInfo
- getName() - Method in interface jakarta.websocket.Extension
-
The name of the extension.
- getName() - Method in interface jakarta.websocket.Extension.Parameter
-
Return the name of the extension parameter.
- getName() - Method in class org.glassfish.tyrus.core.TyrusExtension
- getName() - Method in class org.glassfish.tyrus.core.TyrusExtension.TyrusParameter
- getNames() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Get the list of template names.
- getNameToPattern() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Get the map of template names to patterns.
- getNegotiatedExtensions() - Method in interface jakarta.websocket.Session
-
Return the list of extensions currently in use for this conversation.
- getNegotiatedExtensions() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the list of extensions currently in use for this conversation.
- getNegotiatedExtensions() - Method in class org.glassfish.tyrus.core.TyrusSession
- getNegotiatedExtensions(List<Extension>, List<Extension>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Return the ordered list of extensions that t server endpoint will support given the requested extension list passed in, the empty list if none.
- getNegotiatedExtensions(List<Extension>, List<Extension>) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfigurator
- getNegotiatedSubprotocol() - Method in interface jakarta.websocket.Session
-
Return the sub protocol agreed during the websocket handshake for this conversation.
- getNegotiatedSubprotocol() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the sub protocol agreed during the websocket handshake for this conversation.
- getNegotiatedSubprotocol() - Method in class org.glassfish.tyrus.core.TyrusSession
- getNegotiatedSubprotocol(List<String>, List<String>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Return the subprotocol the 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(List<String>, List<String>) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfigurator
- getNormalizedTemplate() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Get the normalized template.
- getNumberOfExplicitCharacters() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Get the number of characters in the regular expression not resulting from conversion of template variables.
- getNumberOfExplicitRegexes() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Get the number of explicit regular expressions declared in the template variables.
- getNumberOfExplicitRegexes() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Get the number of explicit regular expressions.
- getNumberOfLiteralCharacters() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Get the number of literal characters.
- getNumberOfRegexGroups() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Get the number of regular expression groups
- getNumberOfRegexGroups() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Get the number of regular expression groups
- getNumberOfTemplateVariables() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Get the number of template variables.
- getObject() - Method in exception class jakarta.websocket.EncodeException
-
Return the Object that could not be encoded.
- getOpcode() - Method in class org.glassfish.tyrus.core.frame.Frame
-
Get opcode.
- getOpenSessions() - Method in interface jakarta.websocket.Session
-
Return a copy of the Set of all the open web socket sessions that represent connections to the same endpoint to which this session represents a connection.
- getOpenSessions() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - getOpenSessions() - Method in class org.glassfish.tyrus.core.TyrusSession
- getOrderedWholeMessageHandlers() - Method in class org.glassfish.tyrus.core.MessageHandlerManager
- getOsgiRegistryInstance() - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Returns an
OsgiRegistry
instance. - getOtherAttributes() - Method in class org.glassfish.tyrus.core.wsadl.model.Endpoint
-
Gets a map that contains attributes that aren't bound to any typed property on this class.
- getPackageResources(String, ClassLoader) - Method in class org.glassfish.tyrus.core.OsgiRegistry
- getParameterizedClassArguments(ReflectionHelper.DeclaringClassInterfacePair) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get the parameterized class arguments for a declaring class that declares a generic interface type.
- getParameterizedTypeArguments(ReflectionHelper.DeclaringClassInterfacePair) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get the parameterized type arguments for a declaring class that declares a generic interface type.
- getParameterMap() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the request parameters associated with the request.
- getParameterMap() - Method in class org.glassfish.tyrus.core.RequestContext
- getParameters() - Method in interface jakarta.websocket.Extension
-
The extension parameters for this extension in the order they appear in the http headers.
- getParameters() - Method in class org.glassfish.tyrus.core.TyrusExtension
- getParameters() - Method in class org.glassfish.tyrus.core.uri.Match
-
Get map of parameter names-value pairs.
- getPassword() - Method in class org.glassfish.tyrus.client.auth.Credentials
-
Get the password as byte array.
- getPath() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the path for this endpoint configuration.
- getPath() - Method in class org.glassfish.tyrus.core.ServerEndpointConfigWrapper
- getPath() - Method in interface org.glassfish.tyrus.core.uri.internal.PathSegment
-
Get the path segment.
- getPath() - Method in class org.glassfish.tyrus.core.wsadl.model.Endpoint
-
Gets the value of the path property.
- getPathParameters() - Method in interface jakarta.websocket.Session
-
Return a map of the path parameter names and values used associated with the request this session was opened under.
- getPathParameters() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get a map of the path parameter names and values used associated with the request this session was opened under.
- getPathParameters() - Method in class org.glassfish.tyrus.core.TyrusSession
- getPattern() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Get the URI pattern.
- getPattern() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Get the pattern.
- getPayloadData() - Method in class org.glassfish.tyrus.core.frame.Frame
-
Get payload data.
- getPayloadLength() - Method in class org.glassfish.tyrus.core.frame.Frame
-
Get payload length.
- getPoolName() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Return thread pool name.
- getPort() - Method in class org.glassfish.tyrus.server.Server
-
Get the port which was used to start the container.
- getPort() - Method in class org.glassfish.tyrus.server.TyrusServerContainer
-
Get port of the started container.
- getPreferredSubprotocols() - Method in interface jakarta.websocket.ClientEndpointConfig
-
Return the ordered list of sub protocols a client endpoint would like to use, in order of preference, favorite first that this client would like to use for its sessions.
- getPriority() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Get priority of the threads in thread pool.
- getProperties() - Method in class org.glassfish.tyrus.client.ClientManager
-
Container properties.
- getProperties() - Method in interface org.glassfish.tyrus.core.extension.ExtendedExtension.ExtensionContext
-
Mutable, not synchronised property map.
- getProperty(Map<String, Object>, String, Class<T>) - Static method in class org.glassfish.tyrus.core.Utils
-
Get typed property from generic property map.
- getProperty(Map<String, Object>, String, Class<T>, T) - Static method in class org.glassfish.tyrus.core.Utils
-
Get typed property from generic property map.
- getProtocolVersion() - Method in interface jakarta.websocket.Session
-
Returns the version of the websocket protocol currently being used.
- getProtocolVersion() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the version of the websocket protocol currently being used.
- getProtocolVersion() - Method in class org.glassfish.tyrus.core.TyrusSession
- getQueryString() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the query string associated with the request.
- getQueryString() - Method in interface jakarta.websocket.Session
-
Return the query string associated with the request this session was opened under.
- getQueryString() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the query string associated with the request this session was opened under.
- getQueryString() - Method in class org.glassfish.tyrus.core.RequestContext
- getQueryString() - Method in class org.glassfish.tyrus.core.TyrusSession
- getQueue() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Return a queue that will be used to temporarily store tasks when all threads in the thread pool are busy.
- getQueueLimit() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Get the limit of the queue, where tasks are temporarily stored when all threads are busy.
- getReadHandler() - Method in interface org.glassfish.tyrus.spi.Connection
-
Returns a read handler.
- getReasonPhrase() - Method in class jakarta.websocket.CloseReason
-
The reason phrase associated with this CloseReason.
- getReasonPhrase() - Method in class org.glassfish.tyrus.core.TyrusUpgradeResponse
-
Get HTTP reason phrase.
- getReasonPhrase() - Method in class org.glassfish.tyrus.spi.UpgradeResponse
-
Get HTTP reason phrase.
- getRegex() - Method in class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
Get the regular expression.
- getRemainder() - Method in class org.glassfish.tyrus.core.frame.TextFrame
-
Remainder after UTF-8 decoding.
- getRemainingArray(ByteBuffer) - Static method in class org.glassfish.tyrus.core.Utils
-
Creates the array of bytes containing the bytes from the position to the limit of the
ByteBuffer
. - getRemoteAddr() - Method in class org.glassfish.tyrus.core.RequestContext
-
Get the Internet Protocol (IP) address of the client or last proxy that sent the request.
- getRemoteAddr() - Method in class org.glassfish.tyrus.core.TyrusSession
-
Get the Internet Protocol (IP) address of the client or last proxy that sent the request.
- getRemoteEndpointType() - Method in class org.glassfish.tyrus.spi.WriterInfo
- getRemoteSessionIds(String) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Get set containing session ids of all remote sessions registered to given endpoint path.
- getRemoteSessions() - Method in class org.glassfish.tyrus.core.TyrusSession
-
Get set of remote sessions.
- getRequest() - Method in class org.glassfish.tyrus.core.Handshake
-
Client side only - get the
UpgradeRequest
. - getRequestParameterMap() - Method in interface jakarta.websocket.Session
-
Return the request parameters associated with the request this session was opened under.
- getRequestParameterMap() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the request parameters associated with the request this session was opened under.
- getRequestParameterMap() - Method in class org.glassfish.tyrus.core.TyrusSession
- getRequestUri() - Method in class org.glassfish.tyrus.core.RequestContext
- getRequestUri() - Method in class org.glassfish.tyrus.spi.UpgradeRequest
-
Get the undecoded request uri (up to the query string) of underlying HTTP handshake request.
- getRequestURI() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the request URI of the handshake request.
- getRequestURI() - Method in interface jakarta.websocket.Session
-
Return the complete URI under which this session was opened, from protocol to query string (if present).
- getRequestURI() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the
URI
under which this session was opened, including the query string if there is one. - getRequestURI() - Method in class org.glassfish.tyrus.core.RequestContext
- getRequestURI() - Method in class org.glassfish.tyrus.core.TyrusSession
- getResourceBundle(String) - Method in class org.glassfish.tyrus.core.OsgiRegistry
-
Tries to load resource bundle via OSGi means.
- getResourceBundleName() - Method in interface org.glassfish.tyrus.core.l10n.Localizable
-
Get the name of the localization messages resource bundle.
- getResourceBundleName() - Method in class org.glassfish.tyrus.core.l10n.LocalizableMessage
- getScheduledExecutorService() - Method in class org.glassfish.tyrus.core.BaseContainer
-
Returns a container-managed
ScheduledExecutorService
registered underjava:comp/DefaultManagedScheduledExecutorService
or if the lookup has failed it returns aScheduledExecutorService
created and managed by this instance ofBaseContainer
. - getScheduledExecutorService() - Method in class org.glassfish.tyrus.core.ExecutorServiceProvider
-
Get the
ScheduledExecutorService
. - getSendStream() - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Opens an output stream on which a binary message may be sent.
- getSendTimeout() - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Return the number of milliseconds the implementation will timeout attempting to send a websocket message.
- getSendWriter() - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Opens a character stream on which a text message may be sent.
- getServerAddr() - Method in class org.glassfish.tyrus.core.RequestContext
-
Returns the host name of the server to which the request was sent.
- getServerPort() - Method in class org.glassfish.tyrus.core.RequestContext
-
Get the port of the last client or proxy that sent the request.
- getSession() - Method in class jakarta.websocket.SendResult
-
The WebSocket session in which the session was sent.
- getSession() - Method in exception class jakarta.websocket.SessionException
-
Return the Session on which the problem occurred.
- getSslContext() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Create
SSLContext
and store it for further invocation of this method. - getSSLContext() - Method in interface jakarta.websocket.ClientEndpointConfig
-
Return the SSLContext to be used to establish a WebSocket (wss) connection to the server.
- getStatus() - Method in class org.glassfish.tyrus.core.TyrusUpgradeResponse
-
Get HTTP status.
- 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.
- getStringConstructor(Class) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get the constructor that has a single parameter of String.
- getStringList(List<T>, Utils.Stringifier<T>) - Static method in class org.glassfish.tyrus.core.Utils
-
Get list of strings from List<T>.
- getSubprotocols() - Method in interface jakarta.websocket.server.ServerEndpointConfig
-
Return the websocket subprotocols configured.
- getSubprotocols() - Method in class org.glassfish.tyrus.core.ServerEndpointConfigWrapper
- getSupportedWireProtocolVersions() - Static method in enum class org.glassfish.tyrus.core.Version
- getTemplate() - Method in class org.glassfish.tyrus.core.uri.internal.PathPattern
- getTemplate() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Get the URI template as a String.
- getTemplate() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Get the template.
- getTemplateVariables() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Get the list of template variables for the template.
- getText() - Method in exception class jakarta.websocket.DecodeException
-
Return the encoded string that is either the whole message, or the partial message that could not be decoded, or
null
if this exception arose from a failure to decode a binary message.. - getTextPayload() - Method in class org.glassfish.tyrus.core.frame.TextFrame
-
Get text payload.
- getThreadFactory() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Return
ThreadFactory
that will be used to create thread pool threads. - getTimeoutHandler() - Method in class org.glassfish.tyrus.client.TyrusClientEngine
-
Get
ClientEngine.TimeoutHandler
associated with currentClientEngine
instance. - getTracingHeaders() - Method in class org.glassfish.tyrus.core.DebugContext
-
Get headers containing tracing messages.
- getType() - Method in class org.glassfish.tyrus.core.coder.CoderWrapper
-
Get the return type of the encode / decode method.
- getTypeArgumentAndClass(Type) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
- getUpgradeStatus() - Method in interface org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeInfo
- getUsername() - Method in class org.glassfish.tyrus.client.auth.Credentials
-
Get the username.
- getUserPrincipal() - Method in interface jakarta.websocket.server.HandshakeRequest
-
Return the authenticated user or
null
if no user is authenticated for this handshake. - getUserPrincipal() - Method in interface jakarta.websocket.Session
-
Return the authenticated user for this Session or
null
if no user is authenticated for this session. - getUserPrincipal() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the authenticated user for this session or
null
if no user is authenticated for this session. - getUserPrincipal() - Method in class org.glassfish.tyrus.core.RequestContext
- getUserPrincipal() - Method in class org.glassfish.tyrus.core.TyrusSession
- getUserProperties() - Method in interface jakarta.websocket.EndpointConfig
-
This method returns a modifiable Map that the developer may use to store application specific information relating to the endpoint that uses this configuration instance.
- getUserProperties() - Method in interface jakarta.websocket.Session
-
While the session is open, this method returns a Map that the developer may use to store application specific information relating to this session instance.
- getUserProperties() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - getUserProperties() - Method in class org.glassfish.tyrus.core.ServerEndpointConfigWrapper
- getUserProperties() - Method in class org.glassfish.tyrus.core.TyrusSession
- getValue() - Method in interface jakarta.websocket.Extension.Parameter
-
Return the value of the extension parameter.
- getValue() - Method in class org.glassfish.tyrus.core.TyrusExtension.TyrusParameter
- getValueOfStringMethod(Class) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Get the static valueOf(String ) method.
- getValues(K) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
-
Return a non-null list of values for a given key.
- getWebSocketContainer() - Static method in class jakarta.websocket.ContainerProvider
-
Obtain a new instance of a WebSocketContainer.
- getWebSocketEngine() - Method in interface org.glassfish.tyrus.spi.ServerContainer
-
Return WebSocketEngine to upgrade requests and setting up the connection.
- getWrapped() - Method in class org.glassfish.tyrus.core.ServerEndpointConfigWrapper
-
Get the wrapped
ServerEndpointConfig
. - 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. - getWsadlApplication() - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Get
Application
representing current set of deployed endpoints. - getWsPort(URI) - Static method in class org.glassfish.tyrus.core.Utils
-
Get port from provided
URI
. - getWsPort(URI, String) - Static method in class org.glassfish.tyrus.core.Utils
-
Get port from provided
URI
. - GOING_AWAY - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.
- GOING_AWAY - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.
- GrizzlyClientContainer - Class in org.glassfish.tyrus.container.grizzly.client
- GrizzlyClientContainer() - Constructor for class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientContainer
- GrizzlyClientProperties - Class in org.glassfish.tyrus.container.grizzly.client
-
Grizzly client properties.
- GrizzlyClientProperties() - Constructor for class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientProperties
- GrizzlyClientSocket - Class in org.glassfish.tyrus.container.grizzly.client
-
Implementation of the WebSocket interface.
- GrizzlyContainerProvider - Class in org.glassfish.tyrus.container.grizzly.client
- GrizzlyContainerProvider() - Constructor for class org.glassfish.tyrus.container.grizzly.client.GrizzlyContainerProvider
- GrizzlyServerContainer - Class in org.glassfish.tyrus.container.grizzly.server
-
Grizzly implementation of
ServerContainerFactory
andServerContainer
. - GrizzlyServerContainer() - Constructor for class org.glassfish.tyrus.container.grizzly.server.GrizzlyServerContainer
- GrizzlyWriter - Class in org.glassfish.tyrus.container.grizzly.client
- GrizzlyWriter(Connection) - Constructor for class org.glassfish.tyrus.container.grizzly.client.GrizzlyWriter
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(TyrusEndpointWrapper, UpgradeRequest, UpgradeResponse, ExtendedExtension.ExtensionContext) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Server side handshake processing.
- Handshake - Class in org.glassfish.tyrus.core
-
Class responsible for performing and validating handshake.
- HANDSHAKE_FAILED - Enum constant in enum class org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus
-
Upgrade failed due to version, extensions, origin check etc.
- HANDSHAKE_HTTP_REDIRECTION_INFINITE_LOOP() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Infinite HTTP Redirection loop detected.
- HANDSHAKE_HTTP_REDIRECTION_MAX_REDIRECTION(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Redirect attempts exceeded maximum allowed limit of ({0}) redirects.
- HANDSHAKE_HTTP_REDIRECTION_NEW_LOCATION_ERROR(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Invalid URI in Location header: "{0}".
- HANDSHAKE_HTTP_REDIRECTION_NEW_LOCATION_MISSING() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Missing or empty Location header in 3xx HTTP Redirect response.
- HANDSHAKE_HTTP_REDIRECTION_NOT_ENABLED(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Received HTTP response status code: {0} and redirect processing is not enabled.
- HANDSHAKE_HTTP_RETRY_AFTER_MESSAGE() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
HTTP Status code 503 - Service Unavailable.
- HANDSHAKE_TIMEOUT - Static variable in class org.glassfish.tyrus.client.ClientManager
-
Deprecated.please use
ClientProperties.HANDSHAKE_TIMEOUT
. - HANDSHAKE_TIMEOUT - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
Property usable in
ClientManager.getProperties()
. - HandshakeException - Exception Class in org.glassfish.tyrus.core
-
Exception
, which describes the error, occurred during the handshake phase. - HandshakeException(int, String) - Constructor for exception class org.glassfish.tyrus.core.HandshakeException
-
Constructor.
- HandshakeException(String) - Constructor for exception class org.glassfish.tyrus.core.HandshakeException
-
Construct a HandshakeException.
- HandshakeRequest - Interface in jakarta.websocket.server
-
The handshake request represents the WebSocket defined HTTP GET request for the opening handshake of a WebSocket session.
- HandshakeResponse - Interface in jakarta.websocket
-
The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake request.
- hasExtensions() - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Returns true when current connection has some negotiated extension.
- hashCode() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
- hashCode() - Method in class org.glassfish.tyrus.container.grizzly.client.GrizzlyWriter
- hashCode() - Method in class org.glassfish.tyrus.core.TyrusExtension
- hashCode() - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- hashCode() - Method in class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
- hashCode() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Hash code is calculated from String of the regular expression generated from the template.
- HEADERS_MISSING() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Missing headers required for WebSocket negotiation.
- hookUp() - Method in class org.glassfish.tyrus.core.OsgiRegistry
-
Will hook up this instance with the OSGi runtime.
- HOST - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI host component type.
- HOST - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
HTTP "Host" header name.
- httpSession(Object) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set http session.
I
- id - Variable in class org.glassfish.tyrus.core.wsadl.model.Endpoint
- ILLEGAL_CONFIG_SYNTAX() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Illegal configuration-file syntax.
- ILLEGAL_PROVIDER_CLASS_NAME(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Illegal provider-class name: {0}.
- ILLEGAL_UTF_8_SEQUENCE() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Illegal UTF-8 Sequence.
- INCOMING_BUFFER_SIZE - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
Property name for maximal incoming buffer size.
- INCOMING_BUFFER_SIZE - Static variable in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Maximum size of incoming buffer in bytes.
- INCOMING_BUFFER_SIZE - Static variable in interface org.glassfish.tyrus.spi.ClientContainer
-
Deprecated.please use
org.glassfish.tyrus.client.ClientProperties#INCOMING_BUFFER_SIZE
. - incomingBufferSize(Integer) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
-
Set incoming buffer size.
- init(WebConnection) - Method in class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
- init(EndpointConfig) - Method in interface jakarta.websocket.Decoder
-
This method is called with the endpoint configuration object of the endpoint this decoder is intended for when it is about to be brought into service.
- init(EndpointConfig) - Method in interface jakarta.websocket.Encoder
-
This method is called with the endpoint configuration object of the endpoint this encoder is intended for when it is about to be brought into service.
- init(EndpointConfig) - Method in class org.glassfish.tyrus.core.coder.CoderAdapter
-
This method does nothing.
- InputStreamDecoder - Class in org.glassfish.tyrus.core.coder
-
Built in
Decoder
forInputStream
. - InputStreamDecoder() - Constructor for class org.glassfish.tyrus.core.coder.InputStreamDecoder
- IntegerDecoder() - Constructor for class org.glassfish.tyrus.core.coder.PrimitiveDecoders.IntegerDecoder
- INVALID_HEADER(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Invalid {0} header value: "{1}".
- INVALID_RESPONSE_CODE(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Response code was not {0}: {1}.
- IOEXCEPTION_CLOSE() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
IOException thrown when closing connection.
- isApplicable(Class<?>) - Method in class org.glassfish.tyrus.core.ComponentProvider
-
Checks whether this component provider is able to provide an instance of given
Class
. - isApplicable(Class<?>) - Method in class org.glassfish.tyrus.core.DefaultComponentProvider
- isApplicable(Class<?>) - Method in class org.glassfish.tyrus.gf.cdi.CdiComponentProvider
- isApplicable(Class<?>) - Method in class org.glassfish.tyrus.gf.ejb.EjbComponentProvider
- isCipherConfigured() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
- isClientMode() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Will
SSLEngine
be configured to work in client mode. - isConnected() - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Convenience method to determine if this
TyrusWebSocket
instance is connected. - isControlFrame() - Method in class org.glassfish.tyrus.core.frame.Frame
-
Get information about frame type.
- isDaemon() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Return
true
if thread pool threads are daemons. - isEmpty() - Method in class org.glassfish.tyrus.core.ErrorCollector
-
Checks whether any exception has been logged.
- isEmpty() - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- isEquivalent(String, String) - Static method in class org.glassfish.tyrus.core.uri.Match
-
Check for equivalent paths.
- isFin() - Method in class org.glassfish.tyrus.core.frame.Frame
-
Get FIN value.
- isHexCharacter(char) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Checks whether the character
c
is hexadecimal character. - isHostVerificationEnabled() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Get the hostname verification state.
- isInitialized() - Method in interface org.glassfish.tyrus.core.collection.LazyValue
-
Check if the lazy value has been initialized already (i.e. its
Value.get()
method has already been called previously) or not. - isInputStreamHandlerPresent() - Method in class org.glassfish.tyrus.core.MessageHandlerManager
- isMask() - Method in class org.glassfish.tyrus.core.frame.Frame
-
Currently not used.
- isNeedClientAuth() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Get "need client auth" property.
- isOK() - Method in class jakarta.websocket.SendResult
-
Determines if this result is ok or not.
- isOpen() - Method in interface jakarta.websocket.Session
-
Return true if and only if the underlying socket is open.
- isOpen() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the information about session state.
- isOpen() - Method in class org.glassfish.tyrus.core.TyrusSession
- isProtocolConfigured() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
- isReaderHandlerPresent() - Method in class org.glassfish.tyrus.core.MessageHandlerManager
- isRsv1() - Method in class org.glassfish.tyrus.core.frame.Frame
-
GET RSV1 value.
- isRsv2() - Method in class org.glassfish.tyrus.core.frame.Frame
-
GET RSV2 value.
- isRsv3() - Method in class org.glassfish.tyrus.core.frame.Frame
-
GET RSV3 value.
- isSecure() - Method in interface jakarta.websocket.Session
-
Return true if and only if the underlying socket is using a secure transport.
- isSecure() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
Get the information about secure transport.
- isSecure() - Method in class org.glassfish.tyrus.core.RequestContext
- isSecure() - Method in class org.glassfish.tyrus.core.TyrusSession
- isSecure() - Method in class org.glassfish.tyrus.spi.UpgradeRequest
-
Indicates whether this request was made using a secure channel (such as HTTPS).
- isSessionOpen(String, String) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Get information about session state.
- isTemplateVariablePresent(String) - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Ascertain if a template variable is a member of this template.
- isUserInRole(String) - Method in interface jakarta.websocket.server.HandshakeRequest
-
Checks whether the current user is in the given role.
- isUserInRole(String) - Method in interface org.glassfish.tyrus.core.RequestContext.Builder.IsUserInRoleDelegate
-
Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
- isUserInRole(String) - Method in class org.glassfish.tyrus.core.RequestContext
- isUserInRoleDelegate(RequestContext.Builder.IsUserInRoleDelegate) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set delegate for
RequestContext.isUserInRole(String)
method. - isValid() - Method in interface org.glassfish.tyrus.container.grizzly.client.TaskProcessor.Condition
-
Check the condition.
- isWantClientAuth() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Get "want client auth" property.
- iterator() - Method in class org.glassfish.tyrus.core.ServiceFinder
-
Returns discovered objects incrementally.
J
- jakarta.websocket - package jakarta.websocket
-
This package contains all the Jakarta WebSocket APIs common to both the client and server side.
- jakarta.websocket.server - package jakarta.websocket.server
-
This package contains all the Jakarta WebSocket APIs used only by server side applications.
- JAVASSIST_NOT_FOUND() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Javassist not found and programatic ServerEndpointConfigs cannot be proxied for modifyHandshake.
K
- KEY_FACTORY_MANAGER_ALGORITHM - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Key manager factory algorithm name.
- KEY_STORE_FILE - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Key store file name.
- KEY_STORE_PASSWORD - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Key store file password - the password used to unlock the trust store file.
- KEY_STORE_PROVIDER - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Key store provider name.
- KEY_STORE_TYPE - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Key store type (see
KeyStore.getType()
for more info). - keySet() - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
L
- lazy(Value<T>) - Static method in class org.glassfish.tyrus.core.collection.Values
-
Get a new lazily initialized
value provider
. - LazyValue<T> - Interface in org.glassfish.tyrus.core.collection
-
Lazily initialized
value
. - Localizable - Interface in org.glassfish.tyrus.core.l10n
-
Localizable message.
- localizableAPPLICATION_DATA_TOO_LONG(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableARGUMENT_NOT_NULL(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableAUTHENTICATION_CREATE_AUTH_HEADER_FAILED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableAUTHENTICATION_CREDENTIALS_MISSING() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableAUTHENTICATION_DIGEST_NO_SUCH_ALG() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableAUTHENTICATION_DIGEST_QOP_UNSUPPORTED(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableAUTHENTICATION_FAILED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableBINARY_MESSAGE_HANDLER_NOT_FOUND(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableBINARY_MESSAGE_OUT_OF_ORDER(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableBUFFER_OVERFLOW() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLASS_CHECKER_ADD_MESSAGE_HANDLER_ERROR(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLASS_CHECKER_FORBIDDEN_RETURN_TYPE(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLASS_CHECKER_FORBIDDEN_WEB_SOCKET_CLOSE_PARAM(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLASS_CHECKER_FORBIDDEN_WEB_SOCKET_ERROR_PARAM(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLASS_CHECKER_FORBIDDEN_WEB_SOCKET_OPEN_PARAM(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLASS_CHECKER_MANDATORY_PARAM_MISSING(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLASS_CHECKER_MULTIPLE_IDENTICAL_PARAMS(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLASS_NOT_ELIGIBLE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLASS_NOT_INSTANTIATED(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLASS_NOT_PROXIABLE(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCLIENT_CANNOT_CONNECT(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCOMPONENT_PROVIDER_NOT_FOUND(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCOMPONENT_PROVIDER_THREW_EXCEPTION(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCONNECTION_HAS_BEEN_CLOSED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCONNECTION_NULL() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCONTROL_FRAME_FRAGMENTED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableCONTROL_FRAME_LENGTH() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableDATA_UNEXPECTED_LENGTH(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableDEPENDENT_CLASS_OF_PROVIDER_FORMAT_ERROR(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableDEPENDENT_CLASS_OF_PROVIDER_NOT_FOUND(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableENCODING_FAILED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableENDPOINT_ANNOTATION_NOT_FOUND(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableENDPOINT_EXCEPTION_FROM_ON_ERROR(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableENDPOINT_MAX_MESSAGE_SIZE_TOO_LONG(Object, Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableENDPOINT_MULTIPLE_METHODS(Object, Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableENDPOINT_MULTIPLE_SESSION_PARAM(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableENDPOINT_UNHANDLED_EXCEPTION(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableENDPOINT_UNKNOWN_PARAMS(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableENDPOINT_WRONG_PARAMS(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableENDPOINT_WRONG_PATH_PARAM(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableEQUIVALENT_PATHS(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableERROR_CAUGHT_WHILE_LOADING_SPI_PROVIDERS() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableEXCEPTION_CAUGHT_WHILE_LOADING_SPI_PROVIDERS() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableEXCEPTION_CLOSE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableEXTENSION_EXCEPTION(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableFRAGMENT_INVALID_OPCODE() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableFRAME_WRITE_CANCELLED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableHANDSHAKE_HTTP_REDIRECTION_INFINITE_LOOP() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableHANDSHAKE_HTTP_REDIRECTION_MAX_REDIRECTION(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableHANDSHAKE_HTTP_REDIRECTION_NEW_LOCATION_ERROR(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableHANDSHAKE_HTTP_REDIRECTION_NEW_LOCATION_MISSING() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableHANDSHAKE_HTTP_REDIRECTION_NOT_ENABLED(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableHANDSHAKE_HTTP_RETRY_AFTER_MESSAGE() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableHEADERS_MISSING() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableILLEGAL_CONFIG_SYNTAX() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableILLEGAL_PROVIDER_CLASS_NAME(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableILLEGAL_UTF_8_SEQUENCE() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableINVALID_HEADER(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableINVALID_RESPONSE_CODE(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableIOEXCEPTION_CLOSE() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableJAVASSIST_NOT_FOUND() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMAX_SESSIONS_PER_APP_EXCEEDED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMAX_SESSIONS_PER_ENDPOINT_EXCEEDED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMAX_SESSIONS_PER_REMOTEADDR_EXCEEDED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- LocalizableMessage - Class in org.glassfish.tyrus.core.l10n
- LocalizableMessage(String, String, Object...) - Constructor for class org.glassfish.tyrus.core.l10n.LocalizableMessage
- localizableMESSAGE_HANDLER_ALREADY_REGISTERED_BINARY() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMESSAGE_HANDLER_ALREADY_REGISTERED_PONG() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMESSAGE_HANDLER_ALREADY_REGISTERED_TEXT() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMESSAGE_HANDLER_ALREADY_REGISTERED_TYPE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMESSAGE_HANDLER_DECODER_NOT_REGISTERED(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMESSAGE_HANDLER_ILLEGAL_ARGUMENT(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMESSAGE_HANDLER_PARTIAL_INVALID_TYPE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMESSAGE_HANDLER_WHOLE_OR_PARTIAL() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableMESSAGE_TOO_LONG(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- LocalizableMessageFactory - Class in org.glassfish.tyrus.core.l10n
- LocalizableMessageFactory(String) - Constructor for class org.glassfish.tyrus.core.l10n.LocalizableMessageFactory
- localizableNO_DECODER_FOUND() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableORIGIN_NOT_VERIFIED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizablePARTIAL_BINARY_MESSAGE_OUT_OF_ORDER(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizablePARTIAL_MESSAGE_BUFFER_OVERFLOW() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizablePARTIAL_TEXT_MESSAGE_OUT_OF_ORDER(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizablePROVIDER_CLASS_COULD_NOT_BE_LOADED(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizablePROVIDER_COULD_NOT_BE_CREATED(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizablePROVIDER_NOT_FOUND(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableRSV_INCORRECTLY_SET() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableSEC_KEY_INVALID_LENGTH(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableSEC_KEY_INVALID_SERVER() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableSEC_KEY_NULL_NOT_ALLOWED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableSEND_MESSAGE_INFRAGMENT() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableSESSION_CLOSED_IDLE_TIMEOUT() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableSOCKET_NOT_CONNECTED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableTEXT_MESSAGE_HANDLER_NOT_FOUND(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableTEXT_MESSAGE_OUT_OF_ORDER(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableUNEXPECTED_END_FRAGMENT() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableUNEXPECTED_ERROR_CONNECTION_CLOSE() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableUNEXPECTED_STATE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableUNHANDLED_TEXT_MESSAGE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableURI_COMPONENT_ENCODED_OCTET_INVALID_DIGIT(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableURI_COMPONENT_ENCODED_OCTET_MALFORMED(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localizableURI_COMPONENT_INVALID_CHARACTER(Object, Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
- LocalizationMessages - Class in org.glassfish.tyrus.core.l10n
-
Defines string formatting method for each constant in the resource file
- LocalizationMessages() - Constructor for class org.glassfish.tyrus.core.l10n.LocalizationMessages
- localize(Localizable) - Method in class org.glassfish.tyrus.core.l10n.Localizer
- Localizer - Class in org.glassfish.tyrus.core.l10n
-
Localizes the
Localizable
into a message by using a configuredLocale
. - Localizer() - Constructor for class org.glassfish.tyrus.core.l10n.Localizer
- Localizer(Locale) - Constructor for class org.glassfish.tyrus.core.l10n.Localizer
- LOCATION - Static variable in class org.glassfish.tyrus.spi.UpgradeResponse
-
Header containing a new URI when
UpgradeResponse.getStatus()
. - lock() - Method in class org.glassfish.tyrus.core.RequestContext
-
Make headers and parameter map read-only.
- LOG_HTTP_UPGRADE - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
User property to configure logging of HTTP upgrade messages.
- LongDecoder() - Constructor for class org.glassfish.tyrus.core.coder.PrimitiveDecoders.LongDecoder
M
- main(String[]) - Static method in class org.glassfish.tyrus.server.Server
- mask(boolean) - Method in class org.glassfish.tyrus.core.frame.Frame.Builder
-
Currently not used.
- MASK_SIZE - Static variable in class org.glassfish.tyrus.core.ProtocolHandler
-
RFC 6455
- MASKING_KEY_GENERATOR - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
Property name for registering a custom masking key generator.
- maskingKey(Integer) - Method in class org.glassfish.tyrus.core.frame.Frame.Builder
-
Set masking key.
- MaskingKeyGenerator - Interface in org.glassfish.tyrus.core
-
Can be implemented to generate masking keys.
- match(CharSequence) - Method in class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
Match against the pattern.
- match(CharSequence, List<String>) - Method in class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
Match against the pattern.
- match(CharSequence, List<String>) - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Match a URI against the template.
- match(CharSequence, List<String>, Map<String, String>) - Method in class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
Match against the pattern.
- match(CharSequence, Map<String, String>) - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Match a URI against the template.
- Match - Class in org.glassfish.tyrus.core.uri
-
Defines a match on an endpoint.
- MATRIX_PARAM - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI path component type that is a matrix parameter.
- MAX_BINARY_MESSAGE_BUFFER_SIZE - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Max binary buffer size.
- MAX_IDLE_TIMEOUT - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Max idle timeout.
- MAX_SESSIONS_PER_APP - Static variable in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Maximum number of open sessions per server application.
- MAX_SESSIONS_PER_APP_EXCEEDED - Enum constant in enum class org.glassfish.tyrus.core.TyrusEndpointWrapper.SessionListener.OnOpenResult
-
Session cannot be opened - the maximal number of open session per application exceeded.
- MAX_SESSIONS_PER_APP_EXCEEDED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Maximal number of open sessions per application exceeded.
- MAX_SESSIONS_PER_ENDPOINT_EXCEEDED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Maximal number of open sessions per endpoint exceeded.
- MAX_SESSIONS_PER_REMOTE_ADDR - Static variable in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Maximum number of open sessions per unique remote address.
- MAX_SESSIONS_PER_REMOTE_ADDR_EXCEEDED - Enum constant in enum class org.glassfish.tyrus.core.TyrusEndpointWrapper.SessionListener.OnOpenResult
-
Session cannot be opened - the maximal number of open session per remote address exceeded.
- MAX_SESSIONS_PER_REMOTEADDR_EXCEEDED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Maximal number of open sessions per remote address exceeded.
- MAX_TEXT_MESSAGE_BUFFER_SIZE - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Max text buffer size.
- maxMessageSize() - Element in annotation interface jakarta.websocket.OnMessage
-
Specifies the maximum size of message in bytes that the method this annotates will be able to process, or -1 to indicate that no maximum has been configured.
- maxSessions(int) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfig.Builder
-
Sets maximal number of open sessions.
- MaxSessions - Annotation Interface in org.glassfish.tyrus.core
-
This annotation may be used to annotate server endpoints as a optional annotation to
ServerEndpoint
. - maxSessionsPerApp(Integer) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
-
Set maximal number of open sessions per server application.
- maxSessionsPerRemoteAddr(Integer) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
-
Set maximal number of open sessions from remote address.
- MESSAGE_HANDLER_ALREADY_REGISTERED_BINARY() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Binary MessageHandler already registered.
- MESSAGE_HANDLER_ALREADY_REGISTERED_PONG() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Pong MessageHandler already registered.
- MESSAGE_HANDLER_ALREADY_REGISTERED_TEXT() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Text MessageHandler already registered.
- MESSAGE_HANDLER_ALREADY_REGISTERED_TYPE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
MessageHandler for type: {0} already registered.
- MESSAGE_HANDLER_DECODER_NOT_REGISTERED(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Decoder for type: {0} has not been registered.
- MESSAGE_HANDLER_ILLEGAL_ARGUMENT(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Illegal MessageHandler argument value: {0}.
- MESSAGE_HANDLER_PARTIAL_INVALID_TYPE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Partial MessageHandler can''t be of type: {0}.
- MESSAGE_HANDLER_WHOLE_OR_PARTIAL() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
MessageHandler must implement MessageHandler.Whole or MessageHandler.Partial.
- MESSAGE_IN - Enum constant in enum class org.glassfish.tyrus.core.DebugContext.Type
- MESSAGE_OUT - Enum constant in enum class org.glassfish.tyrus.core.DebugContext.Type
- MESSAGE_TOO_LONG(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Message too long; allowed message size is {0} bytes.
- MessageEventListener - Interface in org.glassfish.tyrus.core.monitoring
-
Listens for message-level events that are interesting for monitoring.
- MessageHandler - Interface in jakarta.websocket
-
Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.
- MessageHandler.Partial<T> - Interface in jakarta.websocket
-
This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.
- MessageHandler.Whole<T> - Interface in jakarta.websocket
-
This kind of handler is notified by the container on arrival of a complete message.
- MessageHandlerManager - Class in org.glassfish.tyrus.core
-
Manages registered
MessageHandler
s and checks whether the new ones may be registered. - MessageHandlerManager() - Constructor for class org.glassfish.tyrus.core.MessageHandlerManager
-
Construct manager with no decoders.
- methodInstanceToString(Object, Method) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Create a string representation of a method and an instance whose class implements the method.
- modifyHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse) - Method in class jakarta.websocket.server.ServerEndpointConfig.Configurator
-
Called by the container after it has formulated a handshake response resulting from a well-formed handshake request.
- modifyHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfigurator
- MultivaluedHashMap<K,
V> - Class in org.glassfish.tyrus.core.uri.internal -
A hash table based implementation of
MultivaluedMap
interface. - MultivaluedHashMap() - Constructor for class org.glassfish.tyrus.core.uri.internal.MultivaluedHashMap
-
Constructs an empty multivalued hash map with the default initial capacity (
16
) and the default load factor (0.75
). - MultivaluedHashMap(int) - Constructor for class org.glassfish.tyrus.core.uri.internal.MultivaluedHashMap
-
Constructs an empty multivalued hash map with the specified initial capacity and the default load factor (
0.75
). - MultivaluedHashMap(int, float) - Constructor for class org.glassfish.tyrus.core.uri.internal.MultivaluedHashMap
-
Constructs an empty multivalued hash map with the specified initial capacity and load factor.
- MultivaluedHashMap(Map<? extends K, ? extends V>) - Constructor for class org.glassfish.tyrus.core.uri.internal.MultivaluedHashMap
-
Constructs a new multivalued hash map with the same mappings as the specified single-valued
Map
. - MultivaluedHashMap(MultivaluedMap<? extends K, ? extends V>) - Constructor for class org.glassfish.tyrus.core.uri.internal.MultivaluedHashMap
-
Constructs a new multivalued hash map with the same mappings as the specified
MultivaluedMap
. - MultivaluedMap<K,
V> - Interface in org.glassfish.tyrus.core.uri.internal -
A map of key-values pairs.
- MultivaluedStringMap - Class in org.glassfish.tyrus.core.uri.internal
-
An implementation of
MultivaluedMap
where keys and values are instances of String. - MultivaluedStringMap() - Constructor for class org.glassfish.tyrus.core.uri.internal.MultivaluedStringMap
- MultivaluedStringMap(int) - Constructor for class org.glassfish.tyrus.core.uri.internal.MultivaluedStringMap
- MultivaluedStringMap(int, float) - Constructor for class org.glassfish.tyrus.core.uri.internal.MultivaluedStringMap
- MultivaluedStringMap(MultivaluedMap<? extends String, ? extends String>) - Constructor for class org.glassfish.tyrus.core.uri.internal.MultivaluedStringMap
N
- needClientAuth - Variable in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Require client Authentication.
- NEGOTIATED_EXTENSIONS - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Negotiated extensions.
- NEGOTIATED_SUBPROTOCOL - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Negotiated subprotocol.
- newDecoder() - Method in class org.glassfish.tyrus.core.StrictUtf8
- newEncoder() - Method in class org.glassfish.tyrus.core.StrictUtf8
- nextInt() - Method in interface org.glassfish.tyrus.core.MaskingKeyGenerator
-
Return next random int similarly to
Random.nextInt()
. - NO_DECODER_FOUND() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
No decoder found.
- NO_EXTENSION - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake.
- NO_EXTENSION - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake.
- NO_OP - Static variable in interface org.glassfish.tyrus.core.monitoring.ApplicationEventListener
-
An instance of @ApplicationEventListener that does not do anything.
- NO_OP - Static variable in interface org.glassfish.tyrus.core.monitoring.EndpointEventListener
-
An instance of @EndpointEventListener that does not do anything.
- NO_OP - Static variable in interface org.glassfish.tyrus.core.monitoring.MessageEventListener
-
An instance of @MessageEventListener that does not do anything.
- NO_STATUS_CODE - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- NO_STATUS_CODE - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- NoOpByteArrayCoder - Class in org.glassfish.tyrus.core.coder
- NoOpByteArrayCoder() - Constructor for class org.glassfish.tyrus.core.coder.NoOpByteArrayCoder
- NoOpByteBufferCoder - Class in org.glassfish.tyrus.core.coder
- NoOpByteBufferCoder() - Constructor for class org.glassfish.tyrus.core.coder.NoOpByteBufferCoder
- NoOpTextCoder - Class in org.glassfish.tyrus.core.coder
- NoOpTextCoder() - Constructor for class org.glassfish.tyrus.core.coder.NoOpTextCoder
- NORMAL_CLOSURE - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
- NORMAL_CLOSURE - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
- normalize(String) - Static method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Normalize the URI by resolve the dot & dot-dot path segments as described in RFC 3986.
- normalize(URI) - Static method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Normalize the URI by resolve the dot & dot-dot path segments as described in RFC 3986.
- NOT_APPLICABLE - Enum constant in enum class org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus
-
Not a WebSocketRequest or no mapping in the application.
- NOT_CONSISTENT - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 data within a text message).
- NOT_CONSISTENT - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 data within a text message).
- NOT_LOCALIZABLE - Static variable in interface org.glassfish.tyrus.core.l10n.Localizable
-
Special constant that represents a message that is not localizable.
O
- OBJECT - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Object type.
- ObjectFactory - Class in org.glassfish.tyrus.core.wsadl.model
-
This object contains factory methods for each Java content interface and Java element interface generated in the org.glassfish.tyrus.core.wsadl.model package.
- ObjectFactory() - Constructor for class org.glassfish.tyrus.core.wsadl.model.ObjectFactory
-
Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: org.glassfish.tyrus.core.wsadl.model
- objectToString(Object) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Create a string representation of an object.
- of(T) - Static method in class org.glassfish.tyrus.core.collection.Values
-
Get a new constant
value provider
whoseget()
method always returns the instance supplied to thevalue
parameter. - OFF - Enum constant in enum class org.glassfish.tyrus.core.DebugContext.TracingType
-
No tracing headers will be ever sent in handshake response.
- ON_DEMAND - Enum constant in enum class org.glassfish.tyrus.core.DebugContext.TracingType
-
Tracing headers will be sent in handshake response only if X-Tyrus-Tracing-Accept header is present in handshake request.
- onAllDataRead() - Method in class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
- onApplicationDestroyed() - Method in interface org.glassfish.tyrus.core.monitoring.ApplicationEventListener
-
Called when the application has been destroyed.
- onApplicationInitialized(String) - Method in interface org.glassfish.tyrus.core.monitoring.ApplicationEventListener
-
Called when the application has been initialized.
- onBroadcast(byte[]) - Method in interface org.glassfish.tyrus.core.cluster.BroadcastListener
-
Invoked when received request to broadcast binary data.
- onBroadcast(String) - Method in interface org.glassfish.tyrus.core.cluster.BroadcastListener
-
Invoked when received request to broadcast text message.
- onClose() - Method in class org.glassfish.tyrus.core.cluster.SessionEventListener
-
Invoked on session close event.
- onClose(CloseReason) - Method in class org.glassfish.tyrus.core.cluster.SessionEventListener
-
Invoked on session close event.
- onClose(Session, CloseReason) - Method in class jakarta.websocket.Endpoint
-
This method is called immediately prior to the session with the remote peer being closed.
- onClose(Session, CloseReason) - Method in class org.glassfish.tyrus.core.AnnotatedEndpoint
- onClose(CloseFrame) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
This callback will be invoked when the remote endpoint sent a closing frame.
- onClose(TyrusSession, CloseReason) - Method in class org.glassfish.tyrus.core.TyrusEndpointWrapper.SessionListener
-
Invoked after
OnClose
annotated method orEndpoint.onClose(jakarta.websocket.Session, jakarta.websocket.CloseReason)
execution. - OnClose - Annotation Interface in jakarta.websocket
-
This method level annotation can be used to decorate a Java method that wishes to be called when a web socket session is closing.
- onConnect(UpgradeRequest, String, List<Extension>, String, DebugContext) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
This callback will be invoked when the opening handshake between both endpoints has been completed.
- onConnectFailure(Exception) - Method in class org.glassfish.tyrus.client.ClientManager.ReconnectHandler
-
Called when there is a connection failure.
- onDataAvailable() - Method in class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
- onDisconnect(CloseReason) - Method in class org.glassfish.tyrus.client.ClientManager.ReconnectHandler
-
Called after
OnClose
annotated method (orEndpoint.onClose(jakarta.websocket.Session, jakarta.websocket.CloseReason)
is invoked. - onEndpointRegistered(String, Class<?>) - Method in interface org.glassfish.tyrus.core.monitoring.ApplicationEventListener
-
Called when an endpoint has been registered.
- onEndpointUnregistered(String) - Method in interface org.glassfish.tyrus.core.monitoring.ApplicationEventListener
-
Called when an endpoint has been unregistered.
- onError(Session, Throwable) - Method in class jakarta.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.
- onError(Session, Throwable) - Method in class org.glassfish.tyrus.core.AnnotatedEndpoint
- onError(String, Throwable) - Method in interface org.glassfish.tyrus.core.monitoring.EndpointEventListener
-
Called when an error has occurred.
- onError(Throwable) - Method in interface org.glassfish.tyrus.client.TyrusClientEngine.ClientHandshakeListener
-
Called when an error is found in handshake response.
- onError(Throwable) - Method in class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
- OnError - Annotation Interface in jakarta.websocket
-
This method level annotation can be used to decorate a Java method that wishes to be called in order to handle errors.
- onExtensionNegotiation(ExtendedExtension.ExtensionContext, List<Extension.Parameter>) - Method in interface org.glassfish.tyrus.core.extension.ExtendedExtension
-
Parameter negotiation.
- onFragment(BinaryFrame, boolean) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
This callback will be invoked when a fragmented binary message has been received.
- onFragment(TextFrame, boolean) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
This callback will be invoked when a fragmented textual message has been received.
- onFrameReceived(TyrusFrame.FrameType, long) - Method in interface org.glassfish.tyrus.core.monitoring.MessageEventListener
-
Called when a frame has been received.
- onFrameSent(TyrusFrame.FrameType, long) - Method in interface org.glassfish.tyrus.core.monitoring.MessageEventListener
-
Called when a frame has been sent.
- onHandshakeResponse(ExtendedExtension.ExtensionContext, List<Extension.Parameter>) - Method in interface org.glassfish.tyrus.core.extension.ExtendedExtension
-
Called only on the client side when handshake response arrives.
- onMessage(BinaryFrame) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
This callback will be invoked when a binary message has been received.
- onMessage(TextFrame) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
This callback will be invoked when a text message has been received.
- onMessage(T) - Method in interface jakarta.websocket.MessageHandler.Whole
-
Called when the message has been fully received.
- onMessage(T, boolean) - Method in interface jakarta.websocket.MessageHandler.Partial
-
Called when the next part of a message has been fully received.
- OnMessage - Annotation Interface in jakarta.websocket
-
This method level annotation can be used to make a Java method receive incoming web socket messages.
- onOpen(Session, EndpointConfig) - Method in class jakarta.websocket.Endpoint
-
Developers must implement this method to be notified when a new conversation has just begun.
- onOpen(Session, EndpointConfig) - Method in class org.glassfish.tyrus.core.AnnotatedEndpoint
- onOpen(TyrusSession) - Method in class org.glassfish.tyrus.core.TyrusEndpointWrapper.SessionListener
-
Invoked before
OnOpen
annotated method orEndpoint.onOpen(jakarta.websocket.Session, jakarta.websocket.EndpointConfig)
is invoked. - OnOpen - Annotation Interface in jakarta.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.
- onPing(PingFrame) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
This callback will be invoked when the remote endpoint has sent a ping frame.
- onPong(PongFrame) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
This callback will be invoked when the remote endpoint has sent a pong frame.
- onResult(SendResult) - Method in interface jakarta.websocket.SendHandler
-
Called once the message has been transmitted.
- onSendBinary(byte[]) - Method in class org.glassfish.tyrus.core.cluster.SessionEventListener
-
Invoked on send binary message event.
- onSendBinary(byte[], boolean) - Method in class org.glassfish.tyrus.core.cluster.SessionEventListener
-
Invoked on send partial binary message event.
- onSendPing(byte[]) - Method in class org.glassfish.tyrus.core.cluster.SessionEventListener
-
Invoked on send ping frame event.
- onSendPong(byte[]) - Method in class org.glassfish.tyrus.core.cluster.SessionEventListener
-
Invoked on send pong frame event.
- onSendText(String) - Method in class org.glassfish.tyrus.core.cluster.SessionEventListener
-
Invoked on send text message event.
- onSendText(String, boolean) - Method in class org.glassfish.tyrus.core.cluster.SessionEventListener
-
Invoked on send partial text message event.
- onSessionClosed(String) - Method in interface org.glassfish.tyrus.core.cluster.SessionListener
-
Invoked when session is closed.
- onSessionClosed(String) - Method in interface org.glassfish.tyrus.core.monitoring.EndpointEventListener
-
Called when a session has been closed.
- onSessionCreated(Session) - Method in interface org.glassfish.tyrus.client.TyrusClientEngine.ClientHandshakeListener
-
Invoked when handshake is completed and provided
Session
is open and ready to be returned fromWebSocketContainer.connectToServer(Class, jakarta.websocket.ClientEndpointConfig, java.net.URI)
(and alternatives) call. - onSessionOpened(String) - Method in interface org.glassfish.tyrus.core.cluster.SessionListener
-
Invoked when session is opened.
- onSessionOpened(String) - Method in interface org.glassfish.tyrus.core.monitoring.EndpointEventListener
-
Called when a session has been opened.
- onStartup(Set<Class<?>>, ServletContext) - Method in class org.glassfish.tyrus.servlet.TyrusServletContainerInitializer
- opcode(byte) - Method in class org.glassfish.tyrus.core.frame.Frame.Builder
-
Set opcode.
- OPEN_ROOT_PATH_PATTERN - Static variable in class org.glassfish.tyrus.core.uri.internal.PathPattern
-
Path pattern matching the any URI path.
- openClientSocket(ClientEndpointConfig, Map<String, Object>, ClientEngine) - Method in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientContainer
- 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.client - package org.glassfish.tyrus.client
-
Common Client.
- org.glassfish.tyrus.client.auth - package org.glassfish.tyrus.client.auth
- org.glassfish.tyrus.client.exception - package org.glassfish.tyrus.client.exception
-
Common Client Exceptions
- org.glassfish.tyrus.container.grizzly.client - package org.glassfish.tyrus.container.grizzly.client
-
Grizzly Client container.
- org.glassfish.tyrus.container.grizzly.server - package org.glassfish.tyrus.container.grizzly.server
-
Grizzly Server container.
- org.glassfish.tyrus.core - package org.glassfish.tyrus.core
-
Core classes.
- org.glassfish.tyrus.core.cluster - package org.glassfish.tyrus.core.cluster
-
Cluster relates classes and interfaces.
- org.glassfish.tyrus.core.coder - package org.glassfish.tyrus.core.coder
-
Encoder and decoder adapters and built-in implementations.
- org.glassfish.tyrus.core.collection - package org.glassfish.tyrus.core.collection
- org.glassfish.tyrus.core.extension - package org.glassfish.tyrus.core.extension
-
WebSocket Extension support.
- org.glassfish.tyrus.core.frame - package org.glassfish.tyrus.core.frame
-
WebSocket frame representations.
- org.glassfish.tyrus.core.l10n - package org.glassfish.tyrus.core.l10n
-
Common internal localization utility classes.
- org.glassfish.tyrus.core.monitoring - package org.glassfish.tyrus.core.monitoring
-
Monitoring interfaces.
- org.glassfish.tyrus.core.uri - package org.glassfish.tyrus.core.uri
-
URI matching.
- org.glassfish.tyrus.core.uri.internal - package org.glassfish.tyrus.core.uri.internal
-
Common classes that provide support for URI templates, encoding/decoding of URI components and multivalued collections.
- org.glassfish.tyrus.core.wsadl.model - package org.glassfish.tyrus.core.wsadl.model
- org.glassfish.tyrus.gf.cdi - package org.glassfish.tyrus.gf.cdi
-
Tyrus CDI integration with Glassfish (and possibly other compatible containers).
- org.glassfish.tyrus.gf.ejb - package org.glassfish.tyrus.gf.ejb
-
Tyrus EJB integration with Glassfish (and possibly other compatible containers).
- org.glassfish.tyrus.server - package org.glassfish.tyrus.server
-
Server implementation.
- org.glassfish.tyrus.servlet - package org.glassfish.tyrus.servlet
-
Servlet 3.1 integration.
- 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.
- ORIGIN_NOT_VERIFIED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Origin not verified.
- OsgiRegistry - Class in org.glassfish.tyrus.core
-
Taken from Jersey 2.
- OTHER - Enum constant in enum class org.glassfish.tyrus.core.DebugContext.Type
P
- PARALLEL_BROADCAST_ENABLED - Static variable in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Parallel broadcast support.
- parallelBroadcastEnabled(Boolean) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
- parameterMap(Map<String, String[]>) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set parameter map.
- parse(char, char[], int, int) - Method in class org.glassfish.tyrus.core.StrictUtf8.Parser
-
Parses a UCS-4 character from the given source buffer, handling surrogates.
- parse(char, CharBuffer) - Method in class org.glassfish.tyrus.core.StrictUtf8.Parser
-
Parses a UCS-4 character from the given source buffer, handling surrogates.
- parseHeaderValue(String) - Static method in class org.glassfish.tyrus.core.Utils
-
Parse header value - splits multiple values (quoted, unquoted) separated by comma.
- parseHttpDate(String) - Static method in class org.glassfish.tyrus.core.Utils
-
Parse HTTP date.
- Parser() - Constructor for class org.glassfish.tyrus.core.StrictUtf8.Parser
- PARTIAL_BINARY_MESSAGE_OUT_OF_ORDER(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Partial binary message received out of order.
- PARTIAL_MESSAGE_BUFFER_OVERFLOW() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Partial message could not be delivered due to buffer overflow.
- PARTIAL_TEXT_MESSAGE_OUT_OF_ORDER(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Partial text message received out of order.
- path - Variable in class org.glassfish.tyrus.core.wsadl.model.Endpoint
- PATH - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI path component type.
- PATH_PARAMETERS - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Path parameters.
- PATH_SEGMENT - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI path component type that is a path segment.
- PathParam - Annotation Interface in jakarta.websocket.server
-
This annotation may be used to annotate method parameters on server endpoints where a URI-template has been used in the path-mapping of the
ServerEndpoint
annotation. - PathPattern - Class in org.glassfish.tyrus.core.uri.internal
-
A path pattern that is a regular expression generated from a URI path template.
- PathPattern(String) - Constructor for class org.glassfish.tyrus.core.uri.internal.PathPattern
-
Create a path pattern and post fix with
PathPattern.RightHandPath.capturingZeroOrMoreSegments
. - PathPattern(String, PathPattern.RightHandPath) - Constructor for class org.glassfish.tyrus.core.uri.internal.PathPattern
-
Create a path pattern and post fix with a right hand path pattern.
- PathPattern(PathTemplate) - Constructor for class org.glassfish.tyrus.core.uri.internal.PathPattern
-
Create a path pattern and post fix with
PathPattern.RightHandPath.capturingZeroOrMoreSegments
. - PathPattern(PathTemplate, PathPattern.RightHandPath) - Constructor for class org.glassfish.tyrus.core.uri.internal.PathPattern
-
Create a path pattern and post fix with a right hand path pattern.
- PathPattern.RightHandPath - Enum Class in org.glassfish.tyrus.core.uri.internal
-
The set of right hand path patterns that may be appended to a path pattern.
- PathSegment - Interface in org.glassfish.tyrus.core.uri.internal
-
Represents a URI path segment and any associated matrix parameters.
- PathTemplate - Class in org.glassfish.tyrus.core.uri.internal
-
A URI template for a URI path.
- PathTemplate(String) - Constructor for class org.glassfish.tyrus.core.uri.internal.PathTemplate
-
Create a URI path template and encode (percent escape) any characters of the template that are not valid URI characters.
- PatternWithGroups - Class in org.glassfish.tyrus.core.uri.internal
-
A pattern for matching a string against a regular expression and returning capturing group values for any capturing groups present in the expression.
- PatternWithGroups() - Constructor for class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
Construct an empty pattern.
- PatternWithGroups(String) - Constructor for class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
Construct a new pattern.
- PatternWithGroups(String, int[]) - Constructor for class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
Construct a new pattern.
- PatternWithGroups(Pattern) - Constructor for class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
Construct a new pattern.
- PatternWithGroups(Pattern, int[]) - Constructor for class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
-
Construct a new pattern.
- payloadData(byte[]) - Method in class org.glassfish.tyrus.core.frame.Frame.Builder
-
Set payload data.
- payloadLength(long) - Method in class org.glassfish.tyrus.core.frame.Frame.Builder
-
Set payload length.
- PING - Enum constant in enum class org.glassfish.tyrus.core.frame.TyrusFrame.FrameType
-
Ping frame.
- PING - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Ping type.
- PingFrame - Class in org.glassfish.tyrus.core.frame
-
Ping frame representation.
- PingFrame(byte[]) - Constructor for class org.glassfish.tyrus.core.frame.PingFrame
-
Constructor.
- PingFrame(Frame) - Constructor for class org.glassfish.tyrus.core.frame.PingFrame
-
Constructor.
- PONG - Enum constant in enum class org.glassfish.tyrus.core.frame.TyrusFrame.FrameType
-
Pong frame.
- PONG - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Pong type.
- PongFrame - Class in org.glassfish.tyrus.core.frame
-
Pong frame representation.
- PongFrame(byte[]) - Constructor for class org.glassfish.tyrus.core.frame.PongFrame
-
Constructor.
- PongFrame(Frame) - Constructor for class org.glassfish.tyrus.core.frame.PongFrame
-
Constructor.
- PongMessage - Interface in jakarta.websocket
-
The PongMessage interface represents a web socket pong.
- PORT - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI port component type.
- preferredSubprotocols(List<String>) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Set the preferred sub protocols for the configuration this builder will build.
- preInit(WebSocketEngine.UpgradeInfo, Writer, boolean) - Method in class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
-
Sets the required information before
TyrusHttpUpgradeHandler.init(WebConnection)
is invoked. - prepareRequest() - Method in class org.glassfish.tyrus.core.Handshake
-
Client side only - compose the
UpgradeRequest
and store it for further use. - PrimitiveDecoders<T> - Class in org.glassfish.tyrus.core.coder
-
Collection of decoders for all primitive types.
- PrimitiveDecoders() - Constructor for class org.glassfish.tyrus.core.coder.PrimitiveDecoders
- PrimitiveDecoders.BooleanDecoder - Class in org.glassfish.tyrus.core.coder
- PrimitiveDecoders.ByteDecoder - Class in org.glassfish.tyrus.core.coder
- PrimitiveDecoders.CharacterDecoder - Class in org.glassfish.tyrus.core.coder
- PrimitiveDecoders.DoubleDecoder - Class in org.glassfish.tyrus.core.coder
- PrimitiveDecoders.FloatDecoder - Class in org.glassfish.tyrus.core.coder
- PrimitiveDecoders.IntegerDecoder - Class in org.glassfish.tyrus.core.coder
- PrimitiveDecoders.LongDecoder - Class in org.glassfish.tyrus.core.coder
- PrimitiveDecoders.ShortDecoder - Class in org.glassfish.tyrus.core.coder
- process(Frame, TyrusWebSocket) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
TODO.
- processError(Throwable) - Method in class org.glassfish.tyrus.client.TyrusClientEngine
- processError(Throwable) - Method in interface org.glassfish.tyrus.spi.ClientEngine
-
Process error.
- processIncoming(ExtendedExtension.ExtensionContext, Frame) - Method in interface org.glassfish.tyrus.core.extension.ExtendedExtension
-
Process incoming frame.
- processOutgoing(ExtendedExtension.ExtensionContext, Frame) - Method in interface org.glassfish.tyrus.core.extension.ExtendedExtension
-
Process outgoing frame.
- processResponse(UpgradeResponse, Writer, Connection.CloseListener) - Method in class org.glassfish.tyrus.client.TyrusClientEngine
- processResponse(UpgradeResponse, Writer, Connection.CloseListener) - Method in interface org.glassfish.tyrus.spi.ClientEngine
-
Process handshake and return
ClientEngine.ClientUpgradeInfo
with handshake status (ClientEngine.ClientUpgradeStatus
). - processTask() - Method in class org.glassfish.tyrus.container.grizzly.client.TaskProcessor
-
Process as much tasks from task queue as possible.
- processTask(TaskProcessor.Task) - Method in class org.glassfish.tyrus.container.grizzly.client.TaskProcessor
-
Add a task to the task queue and process as much tasks from the task queue as possible.
- PROTOCOL_ERROR - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1002 indicates that an endpoint is terminating the connection due to a protocol error.
- PROTOCOL_ERROR - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1002 indicates that an endpoint is terminating the connection due to a protocol error.
- ProtocolException - Exception Class in org.glassfish.tyrus.core
-
Represents issue with parsing or producing websocket frame.
- ProtocolException(String) - Constructor for exception class org.glassfish.tyrus.core.ProtocolException
- ProtocolHandler - Class in org.glassfish.tyrus.core
-
Tyrus protocol handler.
- PROVIDER_CLASS_COULD_NOT_BE_LOADED(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
The class {0} implementing provider {1} could not be loaded: {2}
- PROVIDER_COULD_NOT_BE_CREATED(Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
The class {0} implementing provider {1} could not be instantiated: {2}
- PROVIDER_NOT_FOUND(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
The class {0} implementing the provider {1} is not found.
- PROXY_HEADERS - Static variable in class org.glassfish.tyrus.client.ClientManager
-
Deprecated.please use
ClientProperties.PROXY_HEADERS
. - PROXY_HEADERS - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
User property to set additional proxy headers.
- PROXY_HEADERS - Static variable in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientSocket
-
Deprecated.please use
ClientProperties.PROXY_HEADERS
- PROXY_URI - Static variable in class org.glassfish.tyrus.client.ClientManager
-
Deprecated.please use
ClientProperties.PROXY_URI
. - PROXY_URI - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
User property to set proxy URI.
- PROXY_URI - Static variable in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientSocket
-
Deprecated.please use
ClientProperties.PROXY_URI
. - put(K, List<V>) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- putAll(Map<? extends K, ? extends List<V>>) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- putSingle(K, V) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
-
Set the value for the key to be a one item list consisting of the supplied value.
- putSingle(K, V) - Method in interface org.glassfish.tyrus.core.uri.internal.MultivaluedMap
-
Set the key's value to be a one item list consisting of the supplied value.
Q
- QUERY - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI query component type.
- QUERY_PARAM - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI query component type that is a query parameter, space character is encoded as
+
. - QUERY_PARAM_SPACE_ENCODED - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI query component type that is a query parameter, space character is encoded as
%20
. - QUERY_STRING - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Query string.
- queryString(String) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set query string.
R
- ReaderDecoder - Class in org.glassfish.tyrus.core.coder
- ReaderDecoder() - Constructor for class org.glassfish.tyrus.core.coder.ReaderDecoder
- ReadHandler - Interface in org.glassfish.tyrus.spi
-
Read handler provides a way for a transport to pass websocket connection data to tyrus runtime.
- RECONNECT_HANDLER - Static variable in class org.glassfish.tyrus.client.ClientManager
-
Deprecated.please use
ClientProperties.RECONNECT_HANDLER
. - RECONNECT_HANDLER - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
Property usable in
ClientManager.getProperties()
. - ReconnectHandler() - Constructor for class org.glassfish.tyrus.client.ClientManager.ReconnectHandler
- REDIRECT_ENABLED - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
HTTP Redirect support.
- REDIRECT_THRESHOLD - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
The maximal number of redirects during single handshake.
- RedirectException - Exception Class in org.glassfish.tyrus.client
-
This exception is set as a cause of
DeploymentException
thrown fromWebSocketContainer
.connectToServer(...) - RedirectException(int, String) - Constructor for exception class org.glassfish.tyrus.client.RedirectException
-
Constructor.
- ReflectionHelper - Class in org.glassfish.tyrus.core
-
Utility methods for Java reflection.
- ReflectionHelper() - Constructor for class org.glassfish.tyrus.core.ReflectionHelper
- ReflectionHelper.ClassTypePair - Class in org.glassfish.tyrus.core
-
A tuple consisting of a class and type of the class.
- ReflectionHelper.DeclaringClassInterfacePair - Class in org.glassfish.tyrus.core
-
A tuple consisting of a concrete class, declaring class that declares a generic interface type.
- ReflectionHelper.TypeClassPair - Class in org.glassfish.tyrus.core
- register(ServerEndpointConfig) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- register(ServerEndpointConfig, String) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine
- register(ServerEndpointConfig, String) - Method in interface org.glassfish.tyrus.spi.WebSocketEngine
-
Register
ServerEndpointConfig
. - register(Class<?>) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- register(Class<?>, String) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine
- register(Class<?>, String) - Method in interface org.glassfish.tyrus.spi.WebSocketEngine
-
Register endpoint class.
- registerAuthProvider(String, Authenticator) - Method in class org.glassfish.tyrus.client.auth.AuthConfig.Builder
-
Register
Authenticator
for provided authentication scheme. - registerBroadcastListener(String, BroadcastListener) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Register broadcast listener.
- registerSession(String, String, SessionEventListener) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Register local session.
- registerSessionListener(String, SessionListener) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Register session listener.
- relativize(URI, URI) - Static method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Relativize URI with respect to a base URI.
- remoteAddr(String) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set remote address.
- RemoteEndpoint - Interface in jakarta.websocket
-
The RemoteEndpoint object is supplied by the container and represents the 'other end' or peer of the Web Socket conversation.
- RemoteEndpoint.Async - Interface in jakarta.websocket
-
This representation of the peer of a web socket conversation has the ability to send messages asynchronously.
- RemoteEndpoint.Basic - Interface in jakarta.websocket
-
This representation of the peer of a web socket conversation has the ability to send messages synchronously.
- RemoteSession - Class in org.glassfish.tyrus.core.cluster
-
Remote session represents session originating from another node.
- RemoteSession(String, ClusterContext, Map<RemoteSession.DistributedMapKey, Object>, TyrusEndpointWrapper, Session) - Constructor for class org.glassfish.tyrus.core.cluster.RemoteSession
-
Constructor.
- RemoteSession.DistributedMapKey - Enum Class in org.glassfish.tyrus.core.cluster
- remove(Object) - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- removeMessageHandler(MessageHandler) - Method in interface jakarta.websocket.Session
-
Remove the given MessageHandler from the set belonging to this session.
- removeMessageHandler(MessageHandler) - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - removeMessageHandler(MessageHandler) - Method in class org.glassfish.tyrus.core.MessageHandlerManager
-
Remove
MessageHandler
from the manager. - removeMessageHandler(MessageHandler) - Method in class org.glassfish.tyrus.core.TyrusSession
- removeSession(Session) - Method in class org.glassfish.tyrus.core.ComponentProviderService
-
Remove
Session
from cache. - removeSession(String, String) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Remove session from this Cluster context.
- REQUEST_PARAMETER_MAP - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Request Parameter map.
- REQUEST_URI - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Request URI.
- RequestContext - Class in org.glassfish.tyrus.core
-
Implementation of all possible request interfaces.
- RequestContext.Builder - Class in org.glassfish.tyrus.core
-
RequestContext
builder. - RequestContext.Builder.IsUserInRoleDelegate - Interface in org.glassfish.tyrus.core
-
Is user in role delegate.
- requestURI(URI) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set request URI.
- RESERVED - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
Reserved.
- RESERVED - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
Reserved.
- resolve(URI, String) - Static method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Resolve a relative URI reference against a base URI as defined in RFC 3986.
- resolve(URI, URI) - Static method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Resolve a relative URI reference against a base URI as defined in RFC 3986.
- resolveTemplateValues(UriComponent.Type, String, boolean, Map<String, ?>) - Static method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Resolves template variables in the given
template
from_mapValues
. - resolveTypeVariable(Class, Class, TypeVariable) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Given a type variable resolve the Java class of that variable.
- respond(TyrusWebSocket) - Method in class org.glassfish.tyrus.core.frame.BinaryFrame
- respond(TyrusWebSocket) - Method in class org.glassfish.tyrus.core.frame.CloseFrame
- respond(TyrusWebSocket) - Method in class org.glassfish.tyrus.core.frame.PingFrame
- respond(TyrusWebSocket) - Method in class org.glassfish.tyrus.core.frame.PongFrame
- respond(TyrusWebSocket) - Method in class org.glassfish.tyrus.core.frame.TextFrame
- respond(TyrusWebSocket) - Method in class org.glassfish.tyrus.core.frame.TyrusFrame
-
Execution part of frame processing.
- RESPONSE_CODE_MESSAGE - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
HTTP reason phrase for successful handshake response.
- retrieve(Properties) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Retrieve settings from (system) properties.
- 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.
- RETRY_AFTER_SERVICE_UNAVAILABLE - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
HTTP Service Unavailable - "Retry-After" reconnect support.
- RetryAfterException - Exception Class in org.glassfish.tyrus.client
-
This exception is set as a cause of
DeploymentException
thrown fromWebSocketContainer
.connectToServer(...) when HTTP response status code503 - Service Unavailable
is received. - RetryAfterException(String, Long) - Constructor for exception class org.glassfish.tyrus.client.RetryAfterException
-
Constructor.
- RSV_INCORRECTLY_SET() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
RSV bit(s) incorrectly set.
- rsv1(boolean) - Method in class org.glassfish.tyrus.core.frame.Frame.Builder
-
Set RSV1 flag.
- rsv2(boolean) - Method in class org.glassfish.tyrus.core.frame.Frame.Builder
-
Set RSV2 flag.
- rsv3(boolean) - Method in class org.glassfish.tyrus.core.frame.Frame.Builder
-
Set RSV3 flag.
S
- SCHEME - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI scheme component type.
- SEC_KEY_INVALID_LENGTH(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Invalid Sec-WebSocket-Key length.
- SEC_KEY_INVALID_SERVER() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Sec-WebSocket-Key returned from server does not match expected response.
- SEC_KEY_NULL_NOT_ALLOWED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Null Sec-WebSocket-Key is not allowed.
- SEC_WEBSOCKET_ACCEPT - Static variable in interface jakarta.websocket.HandshakeResponse
-
The Sec-WebSocket-Accept header name.
- SEC_WEBSOCKET_EXTENSIONS - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Extensions header name
- SEC_WEBSOCKET_KEY - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Key header name
- SEC_WEBSOCKET_PROTOCOL - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Protocol header name
- SEC_WEBSOCKET_VERSION - Static variable in interface jakarta.websocket.server.HandshakeRequest
-
The Sec-WebSocket-Version header name
- SEC_WS_ORIGIN_HEADER - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
WebSocket origin header name from previous versions.
- secure(boolean) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set secure state.
- SECURE - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Secure flag.
- SELECTOR_THREAD_POOL_CONFIG - Static variable in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientProperties
-
Client-side property to set custom selector
ThreadPoolConfig
. - SELECTOR_THREAD_POOL_CONFIG - Static variable in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientSocket
-
Deprecated.
- SELECTOR_THREAD_POOL_CONFIG - Static variable in class org.glassfish.tyrus.container.grizzly.server.GrizzlyServerContainer
-
Server-side property to set custom selector
ThreadPoolConfig
. - send(byte[]) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Deprecated.
- send(byte[], SendHandler) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Deprecated.
- send(byte[], SendHandler, WriterInfo) - Method in class org.glassfish.tyrus.core.ProtocolHandler
- send(byte[], WriterInfo) - Method in class org.glassfish.tyrus.core.ProtocolHandler
- send(String) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Deprecated.
- send(String, SendHandler) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Deprecated.
- send(String, SendHandler, WriterInfo) - Method in class org.glassfish.tyrus.core.ProtocolHandler
- send(String, WriterInfo) - Method in class org.glassfish.tyrus.core.ProtocolHandler
- SEND_MESSAGE_INFRAGMENT() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Attempting to send a message while sending fragments of another.
- sendBinary(byte[]) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Deprecated.
- sendBinary(byte[], boolean) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Deprecated.
- sendBinary(byte[], boolean, WriterInfo) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Sends a fragment of a complete message.
- sendBinary(byte[], int, int, boolean) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Deprecated.
- sendBinary(byte[], int, int, boolean, WriterInfo) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Sends a fragment of a complete message.
- sendBinary(byte[], SendHandler) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Deprecated.
- sendBinary(byte[], SendHandler, WriterInfo) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Send a binary frame to the remote endpoint.
- sendBinary(byte[], WriterInfo) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Send a binary frame to the remote endpoint.
- sendBinary(String, byte[]) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Send binary message.
- sendBinary(String, byte[], boolean) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Send partial binary message.
- sendBinary(String, byte[], SendHandler) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Send binary message with
SendHandler
. - sendBinary(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a binary message.
- sendBinary(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Send a binary message, returning when all of the message has been transmitted.
- sendBinary(ByteBuffer, boolean) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Send a binary message in parts, blocking until all of the message has been transmitted.
- sendBinary(ByteBuffer, SendHandler) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a binary message.
- SendHandler - Interface in jakarta.websocket
-
A simple callback object for asynchronous sending of web socket messages.
- sendObject(Object) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a custom developer object.
- sendObject(Object) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Sends a custom developer object, blocking until it has been transmitted.
- sendObject(Object, SendHandler) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a custom developer object.
- sendPing(byte[]) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Sends a
ping
frame with the specified payload (if any). - sendPing(String, byte[]) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Send ping message.
- sendPing(ByteBuffer) - Method in interface jakarta.websocket.RemoteEndpoint
-
Send a Ping message containing the given application data to the remote endpoint.
- sendPing(ByteBuffer) - Method in class org.glassfish.tyrus.core.TyrusRemoteEndpoint
- sendPong(byte[]) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Sends a
ping
frame with the specified payload (if any). - sendPong(String, byte[]) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Send pong message.
- sendPong(ByteBuffer) - Method in interface jakarta.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.
- sendPong(ByteBuffer) - Method in class org.glassfish.tyrus.core.TyrusRemoteEndpoint
- sendRawFrame(ByteBuffer) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Raw frame is always whole (not partial).
- sendRawFrame(ByteBuffer) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Send a frame to the remote endpoint.
- SendResult - Class in jakarta.websocket
-
The result of asynchronously sending a web socket message.
- SendResult() - Constructor for class jakarta.websocket.SendResult
-
Deprecated.Deprecated in WebSocket 2.2 and will be removed in a future version. Use
SendResult(Session, Throwable)
as a replacement. - SendResult(Session) - Constructor for class jakarta.websocket.SendResult
-
Construct a SendResult signifying a successful send carrying no exception.
- SendResult(Session, Throwable) - Constructor for class jakarta.websocket.SendResult
-
Construct a SendResult carrying an exception.
- SendResult(Throwable) - Constructor for class jakarta.websocket.SendResult
-
Deprecated.Deprecated in WebSocket 2.2 and will be removed in a future version. Use
SendResult(Session, Throwable)
as a replacement. - sendText(String) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a text message.
- sendText(String) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Send a text message, blocking until all of the message has been transmitted.
- sendText(String) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Deprecated.
- sendText(String, boolean) - Method in interface jakarta.websocket.RemoteEndpoint.Basic
-
Send a text message in parts, blocking until all of the message has been transmitted.
- sendText(String, boolean) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Deprecated.
- sendText(String, boolean, WriterInfo) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Sends a fragment of a complete message.
- sendText(String, SendHandler) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Initiates the asynchronous transmission of a text message.
- sendText(String, SendHandler) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Deprecated.
- sendText(String, SendHandler, WriterInfo) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Send a text frame to the remote endpoint.
- sendText(String, String) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Send text message.
- sendText(String, String, boolean) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Send partial text message.
- sendText(String, String, SendHandler) - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Send text message with
SendHandler
. - sendText(String, WriterInfo) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Send a text frame to the remote endpoint.
- Server - Class in org.glassfish.tyrus.server
-
Implementation of the WebSocket Server.
- Server(Class<?>...) - Constructor for class org.glassfish.tyrus.server.Server
-
Create new server instance.
- Server(String, int, String, Map<String, Object>, Class<?>...) - Constructor for class org.glassfish.tyrus.server.Server
-
Construct new server.
- Server(String, int, String, Map<String, Object>, Set<Class<?>>) - Constructor for class org.glassfish.tyrus.server.Server
-
Construct new server.
- Server(Map<String, Object>, Class<?>...) - Constructor for class org.glassfish.tyrus.server.Server
-
Create new server instance.
- SERVER_KEY_HASH - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
Server key hash used to compute "Sec-WebSocket-Accept" header value.
- serverAddr(String) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set server address or hostname.
- ServerApplicationConfig - Interface in jakarta.websocket.server
-
Developers include implementations of ServerApplicationConfig in an archive containing websocket endpoints (WAR file, or JAR file within the WAR file) in order to specify the websocket endpoints within the archive the implementation must deploy.
- ServerContainer - Interface in jakarta.websocket.server
-
The ServerContainer is the specialized view of the WebSocketContainer available in server-side deployments.
- 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
- ServerEndpoint - Annotation Interface in jakarta.websocket.server
-
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.
- ServerEndpointConfig - Interface in jakarta.websocket.server
-
The ServerEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to server endpoints.
- ServerEndpointConfig.Builder - Class in jakarta.websocket.server
-
The ServerEndpointConfig.Builder is a class used for creating
ServerEndpointConfig.Builder
objects for the purposes of deploying a server endpoint. - ServerEndpointConfig.Configurator - Class in jakarta.websocket.server
-
The ServerEndpointConfig.Configurator class may be extended by developers who want to provide custom configuration algorithms, such as intercepting the opening handshake, or providing arbitrary methods and algorithms that can be accessed from each endpoint instance configured with this configurator.
- ServerEndpointConfigWrapper - Class in org.glassfish.tyrus.core
-
A public class that holds a wrapped ServerEndpointConfig.
- serverPort(int) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set server port.
- SERVICE_RESTART - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1012 indicates that the service will be restarted.
- SERVICE_RESTART - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1012 indicates that the service will be restarted.
- ServiceConfigurationError - Exception Class in org.glassfish.tyrus.core
-
Taken from Jersey 2.
- ServiceConfigurationError(String) - Constructor for exception class org.glassfish.tyrus.core.ServiceConfigurationError
-
Constructs a new instance with the specified detail string.
- ServiceConfigurationError(Throwable) - Constructor for exception class org.glassfish.tyrus.core.ServiceConfigurationError
-
Constructs a new instance that wraps the specified throwable.
- ServiceFinder<T> - Class in org.glassfish.tyrus.core
-
A simple service-provider lookup mechanism.
- ServiceFinder.DefaultServiceIteratorProvider - Class in org.glassfish.tyrus.core
-
The default service iterator provider that looks up provider classes in META-INF/services files.
- ServiceFinder.ServiceIteratorProvider - Class in org.glassfish.tyrus.core
-
Supports iteration of provider instances or classes.
- ServiceIteratorProvider() - Constructor for class org.glassfish.tyrus.core.ServiceFinder.ServiceIteratorProvider
- Session - Interface in jakarta.websocket
-
A Web Socket session represents a conversation between two web socket endpoints.
- SESSION_ALLOWED - Enum constant in enum class org.glassfish.tyrus.core.TyrusEndpointWrapper.SessionListener.OnOpenResult
-
Session can be opened.
- SESSION_CLOSED_IDLE_TIMEOUT() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
"Session closed by the container because of the idle timeout."
- sessionDestroyed() - Method in class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
-
Called when related
HttpSession
is destroyed or invalidated. - SessionEventListener - Class in org.glassfish.tyrus.core.cluster
-
Session event listener.
- SessionEventListener(Session) - Constructor for class org.glassfish.tyrus.core.cluster.SessionEventListener
-
Constructor.
- SessionException - Exception Class in jakarta.websocket
-
A SessionException represents a general exception type reporting problems occurring on a websocket session.
- SessionException(String, Throwable, Session) - Constructor for exception class jakarta.websocket.SessionException
-
Creates a new instance of this exception with the given message, the wrapped cause of the exception and the session with which the problem is associated.
- SessionListener - Interface in org.glassfish.tyrus.core.cluster
-
Session listener.
- SessionListener() - Constructor for class org.glassfish.tyrus.core.TyrusEndpointWrapper.SessionListener
- setAccessibleMethod(Method) - Static method in class org.glassfish.tyrus.core.ReflectionHelper
-
Set a method to be accessible.
- setAsyncSendTimeout(long) - Method in interface jakarta.websocket.WebSocketContainer
-
Sets the number of milliseconds the implementation will timeout attempting to send a websocket message for all RemoteEndpoints associated with this container.
- setAsyncSendTimeout(long) - Method in class org.glassfish.tyrus.client.ClientManager
- setAsyncSendTimeout(long) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- setBatchingAllowed(boolean) - Method in interface jakarta.websocket.RemoteEndpoint
-
Indicate to the implementation that it is allowed to batch outgoing messages before sending.
- setBatchingAllowed(boolean) - Method in class org.glassfish.tyrus.core.TyrusRemoteEndpoint
- setCipherConfigured(boolean) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
- setClientMode(boolean) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Set
SSLEngine
to be configured to work in client mode. - setCorePoolSize(int) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Set the core thread pool size - the size of the thread pool will never bee smaller than this.
- setDaemon(boolean) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Set
true
if thread pool threads are daemons. - setDefaultMaxBinaryMessageBufferSize(int) - Method in interface jakarta.websocket.WebSocketContainer
-
Sets the default maximum size of incoming binary message that this container will buffer.
- setDefaultMaxBinaryMessageBufferSize(int) - Method in class org.glassfish.tyrus.client.ClientManager
- setDefaultMaxBinaryMessageBufferSize(int) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- setDefaultMaxSessionIdleTimeout(long) - Method in interface jakarta.websocket.WebSocketContainer
-
Sets the default time in milliseconds after which any web socket sessions in this container will be closed if it has been inactive.
- setDefaultMaxSessionIdleTimeout(long) - Method in class org.glassfish.tyrus.client.ClientManager
- setDefaultMaxSessionIdleTimeout(long) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- setDefaultMaxTextMessageBufferSize(int) - Method in interface jakarta.websocket.WebSocketContainer
-
Sets the maximum size of incoming text message that this container will buffer.
- setDefaultMaxTextMessageBufferSize(int) - Method in class org.glassfish.tyrus.client.ClientManager
- setDefaultMaxTextMessageBufferSize(int) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- setEnabledCipherSuites(String[]) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Set enabled cipher suites.
- setEnabledProtocols(String[]) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Set enabled protocols.
- setExtensionContext(ExtendedExtension.ExtensionContext) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Client side.
- setExtensions(List<Extension>) - Method in class org.glassfish.tyrus.core.Handshake
-
Client side only - set the list of supported extensions.
- setExtensions(List<Extension>) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Client side.
- setFailure(Throwable) - Method in class org.glassfish.tyrus.core.TyrusFuture
-
Sets the failure result of message writing process.
- setHeartbeatInterval(long) - Method in class org.glassfish.tyrus.core.TyrusSession
-
Set an interval in milliseconds between scheduled periodic Pong messages.
- setHostnameVerifier(HostnameVerifier) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Set custom hostname verifier.
- setHostVerificationEnabled(boolean) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Set hostname verification.
- setId(String) - Method in class org.glassfish.tyrus.core.wsadl.model.Endpoint
-
Sets the value of the id property.
- setIncomingBufferSize(int) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Deprecated.Please use
.TyrusWebSocketEngineBuilder#incomingBufferSize(Integer)
instead. - setIncomingBufferSize(int) - Method in class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
-
Override the default
TyrusHttpUpgradeHandler.FRAME_BUFFER_SIZE
. - setInitialClassLoader(ClassLoader) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Specifies the context class loader that will be used by threads in this pool.
- setIteratorProvider(ServiceFinder.ServiceIteratorProvider) - Static method in class org.glassfish.tyrus.core.ServiceFinder
-
Register the service iterator provider to iterate on provider instances or classes.
- setKeepAliveTime(long, TimeUnit) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
The max period of time a thread will wait for a new task to process.
- setKeyManagerFactoryAlgorithm(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Sets the key manager factory algorithm.
- setKeyPassword(char[]) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Password of the key in the key store.
- setKeyPassword(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Password of the key in the key store.
- setKeyStoreBytes(byte[]) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Sets key store payload as byte array.
- setKeyStoreFile(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Sets key store file name, also makes sure that if other key store configuration parameters are not set to set them to default values.
- setKeyStorePassword(char[]) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Password of key store.
- setKeyStorePassword(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Password of key store.
- setKeyStoreProvider(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Sets the key store provider name.
- setKeyStoreType(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Type of key store.
- setMaxBinaryMessageBufferSize(int) - Method in interface jakarta.websocket.Session
-
Sets the maximum length of incoming binary messages that this Session can buffer.
- setMaxBinaryMessageBufferSize(int) - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - setMaxBinaryMessageBufferSize(int) - Method in class org.glassfish.tyrus.core.TyrusSession
- setMaxIdleTimeout(long) - Method in interface jakarta.websocket.Session
-
Set the number of milliseconds before this session will be closed by the container if it is inactive, i.e. no messages are either sent or received in that time.
- setMaxIdleTimeout(long) - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - setMaxIdleTimeout(long) - Method in class org.glassfish.tyrus.core.TyrusSession
- setMaxPoolSize(int) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Set max thread pool size.
- setMaxTextMessageBufferSize(int) - Method in interface jakarta.websocket.Session
-
Sets the maximum length of incoming text messages that this Session can buffer.
- setMaxTextMessageBufferSize(int) - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
-
This method is not supported on
RemoteSession
. - setMaxTextMessageBufferSize(int) - Method in class org.glassfish.tyrus.core.TyrusSession
- setMessageEventListener(MessageEventListener) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Set message event listener.
- setNeedClientAuth(boolean) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Set "need client auth" property.
- setPath(String) - Method in class org.glassfish.tyrus.core.wsadl.model.Endpoint
-
Sets the value of the path property.
- setPoolName(String) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Set thread pool name.
- setPriority(int) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Set priority of the threads in thread pool.
- setProtocolConfigured(boolean) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
- setQueue(Queue<Runnable>) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Set a queue implementation that will be used to temporarily store tasks when all threads in the thread pool are busy.
- setQueueLimit(int) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Set the limit of the queue, where tasks are temporarily stored when all threads are busy.
- setReasonPhrase(String) - Method in class org.glassfish.tyrus.core.TyrusUpgradeResponse
-
Set HTTP reason phrase.
- setReasonPhrase(String) - Method in class org.glassfish.tyrus.spi.UpgradeResponse
-
Set HTTP reason phrase.
- setResult(T) - Method in class org.glassfish.tyrus.core.TyrusFuture
-
Sets the result of the message writing process.
- setSecurityProtocol(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Sets the SSLContext protocol.
- setSendTimeout(long) - Method in interface jakarta.websocket.RemoteEndpoint.Async
-
Sets the number of milliseconds the implementation will timeout attempting to send a websocket message.
- setSessionId(String) - Method in class org.glassfish.tyrus.core.DebugContext
-
Set a session ID that will be used as a common identifier for logged messages related to the same upgrade request.
- setStatus(int) - Method in class org.glassfish.tyrus.core.TyrusUpgradeResponse
-
Set HTTP status.
- setStatus(int) - Method in class org.glassfish.tyrus.spi.UpgradeResponse
-
Set HTTP status code for this response.
- setSubProtocols(List<String>) - Method in class org.glassfish.tyrus.core.Handshake
-
Client side only - set the list of supported subprotocols.
- setThreadFactory(ThreadFactory) - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
-
Set
ThreadFactory
that will be used to create thread pool threads. - setTrustManagerFactoryAlgorithm(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Sets the trust manager factory algorithm.
- setTrustStoreBytes(byte[]) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Sets trust store payload as byte array.
- setTrustStoreFile(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Sets trust store file name, also makes sure that if other trust store configuration parameters are not set to set them to default values.
- setTrustStorePassword(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Password of trust store.
- setTrustStoreProvider(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Sets the trust store provider name.
- setTrustStoreType(String) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Type of trust store.
- setup(NetworkListener, FilterChainBuilder) - Method in class org.glassfish.tyrus.container.grizzly.server.WebSocketAddOn
- setWantClientAuth(boolean) - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
-
Set "want client auth" property.
- setWebSocket(TyrusWebSocket) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Client side.
- setWriter(Writer) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Set
Writer
instance. - setWriteTimeout(long) - Method in class org.glassfish.tyrus.core.TyrusWebSocket
-
Sets the timeout for the writing operation.
- SHARED_CONTAINER - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
When set to
true
(boolean value), client runtime preserves used container and reuses it for outgoing connections. - SHARED_CONTAINER - Static variable in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientContainer
-
Deprecated.please use
ClientProperties.SHARED_CONTAINER
. - SHARED_CONTAINER_IDLE_TIMEOUT - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
Container idle timeout in seconds (
Integer
value). - SHARED_CONTAINER_IDLE_TIMEOUT - Static variable in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientContainer
-
Deprecated.please use
ClientProperties.SHARED_CONTAINER_IDLE_TIMEOUT
. - ShortDecoder() - Constructor for class org.glassfish.tyrus.core.coder.PrimitiveDecoders.ShortDecoder
- shutdown() - Method in class org.glassfish.tyrus.core.BaseContainer
-
Release executor services managed by this instance.
- shutdown() - Method in class org.glassfish.tyrus.core.cluster.ClusterContext
-
Shutdown this ClusterContext.
- shutdown(BaseContainer.ShutDownCondition) - Method in class org.glassfish.tyrus.core.BaseContainer
-
Release executor services managed by this instance if the condition passed in the parameter is fulfilled.
- size() - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- SOCKET_BINDING - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
Property name for defining local binding address for all socket created by the client.
- SOCKET_NOT_CONNECTED() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Socket is not connected.
- SSL_ENGINE_CONFIGURATOR - Static variable in class org.glassfish.tyrus.client.ClientManager
-
Deprecated.please use
ClientProperties.SSL_ENGINE_CONFIGURATOR
. - SSL_ENGINE_CONFIGURATOR - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
Property usable in
ClientManager.getProperties()
as a key for SSL configuration. - SSL_ENGINE_CONFIGURATOR - Static variable in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientContainer
-
Deprecated.please use
ClientProperties.SSL_ENGINE_CONFIGURATOR
. - sslContext - Variable in class org.glassfish.tyrus.client.SslEngineConfigurator
- sslContext(SSLContext) - Method in class jakarta.websocket.ClientEndpointConfig.Builder
-
Assign the SSLContext to be used when connection to the WebSocket server.
- sslContextConfiguration - Variable in class org.glassfish.tyrus.client.SslEngineConfigurator
- SslContextConfigurator - Class in org.glassfish.tyrus.client
-
Utility class, which helps to configure ssl context.
- SslContextConfigurator() - Constructor for class org.glassfish.tyrus.client.SslContextConfigurator
-
Default constructor.
- SslContextConfigurator(boolean) - Constructor for class org.glassfish.tyrus.client.SslContextConfigurator
-
Constructor that allows you creating empty configuration.
- SslEngineConfigurator - Class in org.glassfish.tyrus.client
-
SSLEngineConfigurator class from Grizzly project.
- SslEngineConfigurator() - Constructor for class org.glassfish.tyrus.client.SslEngineConfigurator
-
Default constructor.
- SslEngineConfigurator(SSLContext) - Constructor for class org.glassfish.tyrus.client.SslEngineConfigurator
-
Create SSL Engine configuration basing on passed
SSLContext
. - SslEngineConfigurator(SSLContext, boolean, boolean, boolean) - Constructor for class org.glassfish.tyrus.client.SslEngineConfigurator
-
Create SSL Engine configuration based on passed
SSLContext
, using passed client mode, need/want client auth parameters. - SslEngineConfigurator(SslContextConfigurator) - Constructor for class org.glassfish.tyrus.client.SslEngineConfigurator
-
Create SSL Engine configuration based on passed
SslContextConfigurator
. - SslEngineConfigurator(SslContextConfigurator, boolean, boolean, boolean) - Constructor for class org.glassfish.tyrus.client.SslEngineConfigurator
-
Create SSL Engine configuration basing on passed
SslContextConfigurator
. - SslEngineConfigurator(SslEngineConfigurator) - Constructor for class org.glassfish.tyrus.client.SslEngineConfigurator
-
Copy constructor.
- start() - Method in class org.glassfish.tyrus.server.Server
-
Start the server.
- start(String, int) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
-
Start the container.
- start(String, int) - Method in interface org.glassfish.tyrus.spi.ServerContainer
-
Start the server.
- STATIC_CONTENT_ROOT - Static variable in class org.glassfish.tyrus.server.Server
-
Path to static content to be served by created Server instance.
- stop() - Method in class org.glassfish.tyrus.server.Server
-
Stop the server.
- stop() - Method in class org.glassfish.tyrus.server.TyrusServerContainer
-
Undeploy all endpoints and stop underlying
ServerContainer
. - stop() - Method in interface org.glassfish.tyrus.spi.ServerContainer
-
Stop the server.
- store - Variable in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
-
Backing store for the [key, multi-value] pairs.
- stream(boolean, byte[], int, int) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Deprecated.
- stream(boolean, byte[], int, int, WriterInfo) - Method in class org.glassfish.tyrus.core.ProtocolHandler
- stream(boolean, String) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
Deprecated.
- stream(boolean, String, WriterInfo) - Method in class org.glassfish.tyrus.core.ProtocolHandler
- StrictUtf8 - Class in org.glassfish.tyrus.core
- StrictUtf8() - Constructor for class org.glassfish.tyrus.core.StrictUtf8
- StrictUtf8.Parser - Class in org.glassfish.tyrus.core
-
Surrogate parsing support.
- Stringifier() - Constructor for class org.glassfish.tyrus.core.Utils.Stringifier
- stringifyUpgradeRequest(UpgradeRequest) - Static method in class org.glassfish.tyrus.core.Utils
-
Converts upgrade request to a HTTP-formatted string.
- stringifyUpgradeResponse(UpgradeResponse) - Static method in class org.glassfish.tyrus.core.Utils
-
Converts upgrade response to a HTTP-formatted string.
- subprotocols() - Element in annotation interface jakarta.websocket.ClientEndpoint
-
The names of the subprotocols this client supports.
- subprotocols() - Element in annotation interface jakarta.websocket.server.ServerEndpoint
-
The ordered array of web socket protocols this endpoint supports.
- subprotocols(List<String>) - Method in class jakarta.websocket.server.ServerEndpointConfig.Builder
-
Sets the subprotocols to use in the configuration.
- subprotocols(List<String>) - Method in class org.glassfish.tyrus.core.TyrusServerEndpointConfig.Builder
-
Sets the subprotocols to use in the configuration.
- SUCCESS - Enum constant in enum class org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeStatus
-
Upgrade process was successful.
- SUCCESS - Enum constant in enum class org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus
-
Upgrade is successful.
- SUMMARY - Enum constant in enum class org.glassfish.tyrus.core.DebugContext.TracingThreshold
-
A less verbose tracing, an equivalent to
Level.FINER
logging level. - SUPER - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
RemoteEndpoint
- SupplierWithEx<T,
EX> - Interface in org.glassfish.tyrus.core.collection
T
- t - Variable in class org.glassfish.tyrus.core.ReflectionHelper.ClassTypePair
-
The type of the class.
- t - Variable in class org.glassfish.tyrus.core.ReflectionHelper.TypeClassPair
- Task() - Constructor for class org.glassfish.tyrus.container.grizzly.client.TaskProcessor.Task
- TaskProcessor - Class in org.glassfish.tyrus.container.grizzly.client
-
A class responsible for processing
TaskProcessor.Task
. - TaskProcessor() - Constructor for class org.glassfish.tyrus.container.grizzly.client.TaskProcessor
-
Constructor.
- TaskProcessor(TaskProcessor.Condition) - Constructor for class org.glassfish.tyrus.container.grizzly.client.TaskProcessor
-
Constructor.
- TaskProcessor.Condition - Interface in org.glassfish.tyrus.container.grizzly.client
- TaskProcessor.Task - Class in org.glassfish.tyrus.container.grizzly.client
-
Generic task representation.
- TEXT - Enum constant in enum class org.glassfish.tyrus.core.frame.TyrusFrame.FrameType
-
Text frame.
- TEXT - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Text type.
- TEXT_CONTINUATION - Enum constant in enum class org.glassfish.tyrus.core.frame.TyrusFrame.FrameType
-
Continuation text frame.
- TEXT_CONTINUATION - Enum constant in enum class org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Continuation text type.
- TEXT_MESSAGE_HANDLER_NOT_FOUND(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Text message handler not found.
- TEXT_MESSAGE_OUT_OF_ORDER(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Text message received out of order.
- TextFrame - Class in org.glassfish.tyrus.core.frame
-
Text frame representation.
- TextFrame(String, boolean, boolean) - Constructor for class org.glassfish.tyrus.core.frame.TextFrame
-
Constructor.
- TextFrame(Frame, ByteBuffer) - Constructor for class org.glassfish.tyrus.core.frame.TextFrame
-
Constructor.
- TextFrame(Frame, ByteBuffer, boolean) - Constructor for class org.glassfish.tyrus.core.frame.TextFrame
-
Constructor.
- ThreadPoolConfig - Class in org.glassfish.tyrus.client
-
Client thread pool configuration, which might be used to customize client thread pool.
- TLS_HANDSHAKE_FAILURE - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- TLS_HANDSHAKE_FAILURE - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
- toArray() - Method in class org.glassfish.tyrus.core.ServiceFinder
-
Returns discovered objects all at once.
- toArray(long) - Static method in class org.glassfish.tyrus.core.Utils
-
Convert
long
tobyte[]
. - toClassArray() - Method in class org.glassfish.tyrus.core.ServiceFinder
-
Returns discovered classes all at once.
- toLong(byte[], int, int) - Static method in class org.glassfish.tyrus.core.Utils
-
Convert
byte[]
tolong
. - TOO_BIG - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
- TOO_BIG - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
- toString() - Method in class jakarta.websocket.CloseReason
-
Converts the CloseReason to a debug-friendly string.
- toString() - Method in class org.glassfish.tyrus.client.auth.AuthConfig
- toString() - Method in class org.glassfish.tyrus.client.auth.Credentials
- toString() - Method in class org.glassfish.tyrus.client.SslEngineConfigurator
- toString() - Method in class org.glassfish.tyrus.client.ThreadPoolConfig
- toString() - Method in class org.glassfish.tyrus.container.grizzly.client.GrizzlyWriter
- toString() - Method in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
- toString() - Method in class org.glassfish.tyrus.core.cluster.RemoteSession
- toString() - Method in class org.glassfish.tyrus.core.coder.CoderWrapper
- toString() - Method in class org.glassfish.tyrus.core.frame.Frame
- toString() - Method in class org.glassfish.tyrus.core.frame.TextFrame
- toString() - Method in class org.glassfish.tyrus.core.TyrusEndpointWrapper
- toString() - Method in class org.glassfish.tyrus.core.TyrusExtension
- toString() - Method in class org.glassfish.tyrus.core.TyrusExtension.TyrusParameter
- toString() - Method in class org.glassfish.tyrus.core.TyrusRemoteEndpoint
- toString() - Method in class org.glassfish.tyrus.core.TyrusSession
- toString() - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- toString() - Method in class org.glassfish.tyrus.core.uri.internal.PatternWithGroups
- toString() - Method in class org.glassfish.tyrus.core.uri.internal.UriTemplate
- toString() - Method in class org.glassfish.tyrus.core.uri.Match
- toString() - Method in enum class org.glassfish.tyrus.core.Version
- toString() - Method in class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
- toString(byte[]) - Static method in class org.glassfish.tyrus.core.Utils
- toString(byte[], int, int) - Static method in class org.glassfish.tyrus.core.Utils
- ToStringEncoder - Class in org.glassfish.tyrus.core.coder
-
Fall-back encoder - encoders any object to string using
Object.toString()
method. - ToStringEncoder() - Constructor for class org.glassfish.tyrus.core.coder.ToStringEncoder
- TRACE - Enum constant in enum class org.glassfish.tyrus.core.DebugContext.TracingThreshold
-
A more verbose tracing, an equivalent to
Level.FINE
logging level. - 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.core.TyrusWebSocketEngine
-
Property used for configuring tracing threshold.
- TRACING_THRESHOLD - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
This header allows temporarily changing tracing threshold.
- TRACING_TYPE - Static variable in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Property used for configuring the type of tracing supported by the server.
- tracingThreshold(DebugContext.TracingThreshold) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
-
Set tracing threshold.
- tracingType(DebugContext.TracingType) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder
-
Set type of tracing.
- TRUST_FACTORY_MANAGER_ALGORITHM - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Trust manager factory algorithm name.
- TRUST_STORE_FILE - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Trust store file name.
- TRUST_STORE_PASSWORD - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Trust store file password - the password used to unlock the trust store file.
- TRUST_STORE_PROVIDER - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Trust store provider name.
- TRUST_STORE_TYPE - Static variable in class org.glassfish.tyrus.client.SslContextConfigurator
-
Trust store type (see
KeyStore.getType()
for more info). - TRY_AGAIN_LATER - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1013 indicates that the service is experiencing overload
- TRY_AGAIN_LATER - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1013 indicates that the service is experiencing overload
- TypeClassPair(Type, Class) - Constructor for class org.glassfish.tyrus.core.ReflectionHelper.TypeClassPair
- TyrusClientEndpointConfigurator - Class in org.glassfish.tyrus.spi
-
Extended Configurator that can be used for subclassing the user provided configurator.
- TyrusClientEndpointConfigurator() - Constructor for class org.glassfish.tyrus.spi.TyrusClientEndpointConfigurator
- TyrusClientEngine - Class in org.glassfish.tyrus.client
-
Tyrus
ClientEngine
implementation. - TyrusClientEngine.ClientHandshakeListener - Interface in org.glassfish.tyrus.client
-
Called when response is received from the server.
- TyrusConfiguration - Interface in org.glassfish.tyrus.core
-
Inner Tyrus configuration properties holder object.
- TyrusConfiguration.Builder - Class in org.glassfish.tyrus.core
- TyrusEndpointWrapper - Class in org.glassfish.tyrus.core
-
Wraps the registered application class.
- TyrusEndpointWrapper(Endpoint, EndpointConfig, ComponentProviderService, WebSocketContainer, String, ServerEndpointConfig.Configurator, TyrusEndpointWrapper.SessionListener, ClusterContext, EndpointEventListener, Boolean) - Constructor for class org.glassfish.tyrus.core.TyrusEndpointWrapper
- TyrusEndpointWrapper(Class<? extends Endpoint>, EndpointConfig, ComponentProviderService, WebSocketContainer, String, ServerEndpointConfig.Configurator, TyrusEndpointWrapper.SessionListener, ClusterContext, EndpointEventListener, Boolean) - Constructor for class org.glassfish.tyrus.core.TyrusEndpointWrapper
-
Create
TyrusEndpointWrapper
for class that extendsEndpoint
. - TyrusEndpointWrapper.SessionListener - Class in org.glassfish.tyrus.core
-
Session listener.
- TyrusEndpointWrapper.SessionListener.OnOpenResult - Enum Class in org.glassfish.tyrus.core
- TyrusExtension - Class in org.glassfish.tyrus.core
-
WebSocket
Extension
implementation. - TyrusExtension(String) - Constructor for class org.glassfish.tyrus.core.TyrusExtension
-
Create
Extension
with specific name. - TyrusExtension(String, List<Extension.Parameter>) - Constructor for class org.glassfish.tyrus.core.TyrusExtension
-
Create
Extension
with name and parameters. - TyrusExtension.TyrusParameter - Class in org.glassfish.tyrus.core
-
WebSocket
Extension.Parameter
implementation. - TyrusFrame - Class in org.glassfish.tyrus.core.frame
-
Frame representation used in Tyrus runtime.
- TyrusFrame(Frame, TyrusFrame.FrameType) - Constructor for class org.glassfish.tyrus.core.frame.TyrusFrame
-
Constructor.
- TyrusFrame.FrameType - Enum Class in org.glassfish.tyrus.core.frame
-
An Enumeration of frame types.
- TyrusFuture<T> - Class in org.glassfish.tyrus.core
-
Tyrus
Future
implementation. - TyrusFuture() - Constructor for class org.glassfish.tyrus.core.TyrusFuture
- TyrusHttpUpgradeHandler - Class in org.glassfish.tyrus.servlet
-
HttpUpgradeHandler
andReadListener
implementation. - TyrusHttpUpgradeHandler() - Constructor for class org.glassfish.tyrus.servlet.TyrusHttpUpgradeHandler
- TyrusParameter(String, String) - Constructor for class org.glassfish.tyrus.core.TyrusExtension.TyrusParameter
-
Create
Extension.Parameter
with name and value. - tyrusProperties() - Method in interface org.glassfish.tyrus.core.TyrusConfiguration
-
Get an immutable map of properties provided by
- tyrusProperties(Map<String, Object>) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set properties for Tyrus framework.
- TyrusRemoteEndpoint - Class in org.glassfish.tyrus.core
-
Wraps the
RemoteEndpoint
and represents the other side of the websocket connection. - TyrusServerConfiguration - Class in org.glassfish.tyrus.server
-
Container for either deployed
ServerApplicationConfig
s, if any, or deployed classes. - TyrusServerConfiguration(Set<Class<?>>, Set<ServerEndpointConfig>) - Constructor for class org.glassfish.tyrus.server.TyrusServerConfiguration
-
Create new
TyrusServerConfiguration
. - TyrusServerConfiguration(Set<Class<?>>, Set<Class<?>>, Set<ServerEndpointConfig>, ErrorCollector) - Constructor for class org.glassfish.tyrus.server.TyrusServerConfiguration
-
Create new
TyrusServerConfiguration
. - TyrusServerContainer - Class in org.glassfish.tyrus.server
-
Server Container Implementation.
- TyrusServerContainer(ServerApplicationConfig) - Constructor for class org.glassfish.tyrus.server.TyrusServerContainer
-
Create new
TyrusServerContainer
using already createdServerApplicationConfig
instance. - TyrusServerContainer(Set<Class<?>>) - Constructor for class org.glassfish.tyrus.server.TyrusServerContainer
-
Create new
TyrusServerContainer
. - TyrusServerEndpointConfig - Interface in org.glassfish.tyrus.core
-
Configuration
ServerEndpointConfig
enhanced to offer tyrus specific attributes like maxSessions. - TyrusServerEndpointConfig.Builder - Class in org.glassfish.tyrus.core
-
The TyrusServerEndpointConfig.Builder is a class used for creating
TyrusServerEndpointConfig.Builder
objects for the purposes of deploying a server endpoint. - TyrusServerEndpointConfigurator - Class in org.glassfish.tyrus.core
-
Tyrus' implementation of
ServerEndpointConfig.Configurator
. - TyrusServerEndpointConfigurator() - Constructor for class org.glassfish.tyrus.core.TyrusServerEndpointConfigurator
- TyrusServletContainerInitializer - Class in org.glassfish.tyrus.servlet
-
Registers a filter for upgrade handshake.
- TyrusServletContainerInitializer() - Constructor for class org.glassfish.tyrus.servlet.TyrusServletContainerInitializer
- TyrusSession - Class in org.glassfish.tyrus.core
-
Implementation of the
Session
. - TyrusUpgradeResponse - Class in org.glassfish.tyrus.core
-
HTTP response representation.
- TyrusUpgradeResponse() - Constructor for class org.glassfish.tyrus.core.TyrusUpgradeResponse
- TyrusWebSocket - Class in org.glassfish.tyrus.core
-
Tyrus representation of web socket connection.
- TyrusWebSocket(ProtocolHandler, TyrusEndpointWrapper) - Constructor for class org.glassfish.tyrus.core.TyrusWebSocket
-
Create new instance, set
ProtocolHandler
and registerTyrusEndpointWrapper
. - TyrusWebSocketEngine - Class in org.glassfish.tyrus.core
-
WebSocketEngine
implementation, which handles server-side handshake, validation and data processing. - TyrusWebSocketEngine.TyrusWebSocketEngineBuilder - Class in org.glassfish.tyrus.core
-
TyrusWebSocketEngine
builder.
U
- UNEXPECTED_CONDITION - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
- UNEXPECTED_CONDITION - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
- UNEXPECTED_END_FRAGMENT() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
End fragment sent, but wasn''t processing any previous fragments.
- UNEXPECTED_ERROR_CONNECTION_CLOSE() - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Unexpected error, closing connection.
- UNEXPECTED_STATE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Unexpected state: {0}.
- unframe(ByteBuffer) - Method in class org.glassfish.tyrus.core.ProtocolHandler
-
TODO!
- UNHANDLED_TEXT_MESSAGE(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Unhandled text message.
- unregister(TyrusEndpointWrapper) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Un-registers the specified
TyrusEndpointWrapper
with theWebSocketEngine
. - UNRESERVED - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
ALPHA / DIGIT / "-" / "." / "_" / "~" characters.
- 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.
- updateHostAndOrigin(UpgradeRequest) - Static method in class org.glassfish.tyrus.core.Handshake
-
Client side only - Generate host and origin header and put them to the upgrade request headers.
- upgrade(UpgradeRequest, UpgradeResponse) - Method in class org.glassfish.tyrus.core.TyrusWebSocketEngine
- 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 - Enum constant in enum class org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeStatus
-
Upgrade process failed.
- upgradeHttpToWebSocket(Object, Object, ServerEndpointConfig, Map<String, String>) - Method in interface jakarta.websocket.server.ServerContainer
-
Upgrade the HTTP connection represented by the
HttpServletRequest
andHttpServletResponse
to the WebSocket protocol and establish a WebSocket connection as per the providedServerEndpointConfig
. - upgradeHttpToWebSocket(Object, Object, ServerEndpointConfig, Map<String, String>) - Method in class org.glassfish.tyrus.server.TyrusServerContainer
- 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
- URI_COMPONENT_ENCODED_OCTET_INVALID_DIGIT(Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Malformed percent-encoded octet at index {0}, invalid hexadecimal digit ''{1}''.
- URI_COMPONENT_ENCODED_OCTET_MALFORMED(Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
Malformed percent-encoded octet at index {0}.
- URI_COMPONENT_INVALID_CHARACTER(Object, Object, Object, Object) - Static method in class org.glassfish.tyrus.core.l10n.LocalizationMessages
-
The string "{0}" for the URI component {1} contains an invalid character, ''{2}'', at index {3}.
- UriComponent - Class in org.glassfish.tyrus.core.uri.internal
-
Utility class for validating, encoding and decoding components of a URI.
- UriComponent.Type - Enum Class in org.glassfish.tyrus.core.uri.internal
-
The URI component type.
- UriTemplate - Class in org.glassfish.tyrus.core.uri.internal
-
A URI template.
- UriTemplate(String) - Constructor for class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Construct a new URI template.
- UriTemplate(UriTemplateParser) - Constructor for class org.glassfish.tyrus.core.uri.internal.UriTemplate
-
Construct a new URI template.
- UriTemplateParser - Class in org.glassfish.tyrus.core.uri.internal
-
A URI template parser that parses JAX-RS specific URI templates.
- UriTemplateParser(String) - Constructor for class org.glassfish.tyrus.core.uri.internal.UriTemplateParser
-
Parse a template.
- USER_INFO - Enum constant in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
The URI user info component type.
- USER_PRINCIPAL - Enum constant in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
User principal.
- userPrincipal(Principal) - Method in class org.glassfish.tyrus.core.RequestContext.Builder
-
Set
Principal
. - userProperties() - Method in interface org.glassfish.tyrus.core.TyrusConfiguration
-
Get a mutable copy of user properties first obtained by
EndpointConfig.getUserProperties()
. - Utf8DecodingException - Exception Class in org.glassfish.tyrus.core
-
TODO
- Utf8DecodingException() - Constructor for exception class org.glassfish.tyrus.core.Utf8DecodingException
-
TODO
- Utils - Class in org.glassfish.tyrus.core
-
Utility methods shared among Tyrus modules.
- Utils() - Constructor for class org.glassfish.tyrus.core.Utils
- Utils.Stringifier<T> - Class in org.glassfish.tyrus.core
-
Define to
String
conversion for various types.
V
- valid(String, UriComponent.Type) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Validates the legal characters of a percent-encoded string that represents a URI component type.
- valid(String, UriComponent.Type, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Validates the legal characters of a percent-encoded string that represents a URI component type.
- validate(String, UriComponent.Type) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Validates the legal characters of a percent-encoded string that represents a URI component type.
- validate(String, UriComponent.Type, boolean) - Static method in class org.glassfish.tyrus.core.uri.internal.UriComponent
-
Validates the legal characters of a percent-encoded string that represents a URI component type.
- validate(UpgradeRequest) - Method in enum class org.glassfish.tyrus.core.Version
- validateConfiguration() - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Validates
SslContextConfigurator
configuration. - validateConfiguration(boolean) - Method in class org.glassfish.tyrus.client.SslContextConfigurator
-
Validates
SslContextConfigurator
configuration. - validateServerResponse(UpgradeResponse) - Method in class org.glassfish.tyrus.core.Handshake
-
Client side only - validate server response.
- value() - Element in annotation interface jakarta.websocket.server.PathParam
-
The name of the variable used in the URI-template.
- value() - Element in annotation interface jakarta.websocket.server.ServerEndpoint
-
The URI or URI-template, level-1 (See RFC 6570) where the endpoint will be deployed.
- value() - Element in annotation interface org.glassfish.tyrus.core.MaxSessions
-
Maximal number of open sessions.
- Value<T> - Interface in org.glassfish.tyrus.core.collection
-
A generic value provider.
- valueOf(String) - Static method in enum class jakarta.websocket.CloseReason.CloseCodes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.core.CloseReasons
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.core.DebugContext.TracingThreshold
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.core.DebugContext.TracingType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.core.DebugContext.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.core.frame.TyrusFrame.FrameType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.core.TyrusEndpointWrapper.SessionListener.OnOpenResult
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.core.uri.internal.PathPattern.RightHandPath
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.core.Version
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class jakarta.websocket.CloseReason.CloseCodes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.core.CloseReasons
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.core.cluster.RemoteSession.DistributedMapKey
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.core.DebugContext.TracingThreshold
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.core.DebugContext.TracingType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.core.DebugContext.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.core.frame.TyrusFrame.FrameType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.core.TyrusEndpointWrapper.SessionListener.OnOpenResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in class org.glassfish.tyrus.core.uri.internal.AbstractMultivaluedMap
- values() - Static method in enum class org.glassfish.tyrus.core.uri.internal.PathPattern.RightHandPath
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.core.uri.internal.UriComponent.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.core.Version
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.spi.WriterInfo.MessageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.glassfish.tyrus.spi.WriterInfo.RemoteEndpointType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- Values - Class in org.glassfish.tyrus.core.collection
-
A collection of
Value provider
factory & utility methods. - Version - Enum Class in org.glassfish.tyrus.core
-
TODO
- VIOLATED_POLICY - Enum constant in enum class jakarta.websocket.CloseReason.CloseCodes
-
1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
- VIOLATED_POLICY - Enum constant in enum class org.glassfish.tyrus.core.CloseReasons
-
1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
W
- wantClientAuth - Variable in class org.glassfish.tyrus.client.SslEngineConfigurator
-
True when requesting authentication.
- WEBSOCKET - Static variable in class org.glassfish.tyrus.spi.UpgradeRequest
-
Expected value in HTTP handshake "Upgrade" header.
- WebSocketAddOn - Class in org.glassfish.tyrus.container.grizzly.server
-
WebSockets
AddOn
for theHttpServer
. - WebSocketContainer - Interface in jakarta.websocket
-
A WebSocketContainer is an implementation provided object that provides applications a view on the container running it.
- 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 Class in org.glassfish.tyrus.spi
-
Upgrade Status for HTTP request upgrading.
- WebSocketException - Exception Class in org.glassfish.tyrus.core
-
WebSocketException can be thrown during runtime (after handshake).
- WebSocketException(String) - Constructor for exception class org.glassfish.tyrus.core.WebSocketException
-
Create new
WebSocketException
. - willDecode(String) - Method in interface jakarta.websocket.Decoder.Text
-
Answer whether the given String can be decoded into an object of type T.
- willDecode(String) - Method in class org.glassfish.tyrus.core.coder.NoOpTextCoder
- willDecode(String) - Method in class org.glassfish.tyrus.core.coder.PrimitiveDecoders
- willDecode(String) - Method in class org.glassfish.tyrus.core.coder.ReaderDecoder
- willDecode(ByteBuffer) - Method in interface jakarta.websocket.Decoder.Binary
-
Answer whether the given bytes can be decoded into an object of type T.
- willDecode(ByteBuffer) - Method in class org.glassfish.tyrus.core.coder.InputStreamDecoder
- willDecode(ByteBuffer) - Method in class org.glassfish.tyrus.core.coder.NoOpByteArrayCoder
- willDecode(ByteBuffer) - Method in class org.glassfish.tyrus.core.coder.NoOpByteBufferCoder
- WLS_HOSTNAME_VERIFIER_CLASS - Static variable in class org.glassfish.tyrus.client.ClientManager
- WLS_IGNORE_HOSTNAME_VERIFICATION - Static variable in class org.glassfish.tyrus.client.ClientManager
- WLS_INCOMING_BUFFER_SIZE - Static variable in interface org.glassfish.tyrus.spi.ClientContainer
-
WLS version of
INCOMING_BUFFER_SIZE
. - WLS_MAX_THREADS - Static variable in class org.glassfish.tyrus.client.ClientManager
- WLS_PROXY_HOST - Static variable in class org.glassfish.tyrus.client.ClientManager
- WLS_PROXY_PASSWORD - Static variable in class org.glassfish.tyrus.client.ClientManager
- WLS_PROXY_PORT - Static variable in class org.glassfish.tyrus.client.ClientManager
- WLS_PROXY_USERNAME - Static variable in class org.glassfish.tyrus.client.ClientManager
- WLS_SSL_PROTOCOLS_PROPERTY - Static variable in class org.glassfish.tyrus.client.ClientManager
- WLS_SSL_TRUSTSTORE_PROPERTY - Static variable in class org.glassfish.tyrus.client.ClientManager
- WLS_SSL_TRUSTSTORE_PWD_PROPERTY - Static variable in class org.glassfish.tyrus.client.ClientManager
- WORKER_THREAD_POOL_CONFIG - Static variable in class org.glassfish.tyrus.client.ClientProperties
-
User property to set worker thread pool configuration.
- WORKER_THREAD_POOL_CONFIG - Static variable in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientProperties
-
Client-side property to set custom worker
ThreadPoolConfig
. - WORKER_THREAD_POOL_CONFIG - Static variable in class org.glassfish.tyrus.container.grizzly.client.GrizzlyClientSocket
-
Deprecated.
- WORKER_THREAD_POOL_CONFIG - Static variable in class org.glassfish.tyrus.container.grizzly.server.GrizzlyServerContainer
-
Server-side property to set custom worker
ThreadPoolConfig
. - wrap(Frame, byte, ByteBuffer) - Static method in class org.glassfish.tyrus.core.frame.TyrusFrame
-
TyrusFrame
factory method. - wrapped - Variable in class org.glassfish.tyrus.core.ServerEndpointConfigWrapper
- write(ByteBuffer, CompletionHandler<ByteBuffer>) - Method in class org.glassfish.tyrus.container.grizzly.client.GrizzlyWriter
- 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
WriterData
instance - WriterInfo.MessageType - Enum Class in org.glassfish.tyrus.spi
-
Possible WebSocket Message Types.
- WriterInfo.RemoteEndpointType - Enum Class in org.glassfish.tyrus.spi
- WSADL_SUPPORT - Static variable in class org.glassfish.tyrus.core.TyrusWebSocketEngine
-
Wsadl support.
- WWW_AUTHENTICATE - Static variable in class org.glassfish.tyrus.spi.UpgradeResponse
-
Header containing challenge with authentication scheme and parameters.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
TyrusSession.addMessageHandler(Class, jakarta.websocket.MessageHandler.Whole)
orTyrusSession.addMessageHandler(Class, jakarta.websocket.MessageHandler.Partial)