Package org.glassfish.tyrus.core
Core classes.
-
Interface Summary Interface Description BaseContainer.ShutDownCondition MaskingKeyGenerator Can be implemented to generate masking keys.RequestContext.Builder.IsUserInRoleDelegate Is user in role delegate.TyrusConfiguration Inner Tyrus configuration properties holder object.TyrusServerEndpointConfig ConfigurationServerEndpointConfig
enhanced to offer tyrus specific attributes like maxSessions. -
Class Summary Class Description AnnotatedEndpoint Endpoint
descendant which represents deployed annotated endpoint.BaseContainer Base WebSocket container.ComponentProvider Provides an instance.ComponentProviderService Provides an instance of component.DebugContext ALogger
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.DefaultComponentProvider Provides instances using reflection.ErrorCollector Used to collect deployment errors to present these to the user together.ExecutorServiceProvider Handshake Class responsible for performing and validating handshake.MessageHandlerManager Manages registeredMessageHandler
s and checks whether the new ones may be registered.OsgiRegistry Taken from Jersey 2.ProtocolHandler Tyrus protocol handler.ReflectionHelper Utility methods for Java reflection.ReflectionHelper.ClassTypePair A tuple consisting of a class and type of the class.ReflectionHelper.DeclaringClassInterfacePair A tuple consisting of a concrete class, declaring class that declares a generic interface type.ReflectionHelper.TypeClassPair RequestContext Implementation of all possible request interfaces.RequestContext.Builder RequestContext
builder.ServerEndpointConfigWrapper A public class that holds a wrapped ServerEndpointConfig.ServiceFinder<T> A simple service-provider lookup mechanism.ServiceFinder.DefaultServiceIteratorProvider The default service iterator provider that looks up provider classes in META-INF/services files.ServiceFinder.ServiceIteratorProvider Supports iteration of provider instances or classes.StrictUtf8 StrictUtf8.Parser Surrogate parsing support.TyrusConfiguration.Builder TyrusEndpointWrapper Wraps the registered application class.TyrusEndpointWrapper.SessionListener Session listener.TyrusExtension WebSocketExtension
implementation.TyrusExtension.TyrusParameter WebSocketExtension.Parameter
implementation.TyrusFuture<T> TyrusFuture
implementation.TyrusRemoteEndpoint Wraps theRemoteEndpoint
and represents the other side of the websocket connection.TyrusServerEndpointConfig.Builder The TyrusServerEndpointConfig.Builder is a class used for creatingTyrusServerEndpointConfig.Builder
objects for the purposes of deploying a server endpoint.TyrusServerEndpointConfigurator Tyrus' implementation ofServerEndpointConfig.Configurator
.TyrusSession Implementation of theSession
.TyrusUpgradeResponse HTTP response representation.TyrusWebSocket Tyrus representation of web socket connection.TyrusWebSocketEngine WebSocketEngine
implementation, which handles server-side handshake, validation and data processing.TyrusWebSocketEngine.TyrusWebSocketEngineBuilder TyrusWebSocketEngine
builder.Utils Utility methods shared among Tyrus modules.Utils.Stringifier<T> Define toString
conversion for various types. -
Enum Summary Enum Description CloseReasons Enum containing standard CloseReasons defined in RFC 6455, see chapter 7.4.1 Defined Status Codes.DebugContext.TracingThreshold Tracing threshold - used for configuration granularity of information that will be sent in tracing headers.DebugContext.TracingType Type of tracing - used for tracing configuration.DebugContext.Type Type of the record - used to graphically distinguish these message types in the log.TyrusEndpointWrapper.SessionListener.OnOpenResult Version TODO -
Exception Summary Exception Description HandshakeException Exception
, which describes the error, occurred during the handshake phase.ProtocolException Represents issue with parsing or producing websocket frame.Utf8DecodingException TODOWebSocketException WebSocketException can be thrown during runtime (after handshake). -
Error Summary Error Description ServiceConfigurationError Taken from Jersey 2. -
Annotation Types Summary Annotation Type Description Beta Marker of a public Tyrus API that is still in "beta" non-final version.MaxSessions This annotation may be used to annotate server endpoints as a optional annotation toServerEndpoint
.