Tyrus 2.2.0 · org.glassfish.tyrus.core · APIdia, the JavaDoc alternative

Modifier and Type	Interface and Description
pack-priv interface	AsyncMessageHandler Asynchonous message handler with added getType method.
pack-priv interface	BasicMessageHandler Synchronous message handler with added getType method.
public interface	MaskingKeyGenerator Can be implemented to generate masking keys.
public interface	TyrusConfiguration Inner Tyrus configuration properties holder object.
public interface	TyrusServerEndpointConfig Configuration `jakarta.websocket.server.ServerEndpointConfig` enhanced to offer tyrus specific attributes like maxSessions.

Modifier and Type	Annotation and Description
public @interface	Beta Marker of a public Tyrus API that is still in "beta" non-final version.
public @interface	MaxSessions This annotation may be used to annotate server endpoints as a optional annotation to `jakarta.websocket.server.ServerEndpoint`.

Class Summary

Modifier and Type	Class and Description
pack-priv class	AnnotatedClassValidityChecker Used when processing a class annotated with `@ServerEndpoint` to check that it complies with specification.
public class	AnnotatedEndpoint `Endpoint` descendant which represents deployed annotated endpoint.
public abstract class	BaseContainer Base WebSocket container.
pack-priv class	BinaryBuffer Save received partial messages to a list and concatenate them.
pack-priv class	BufferedInputStream Passed to the (@link MessageHandler.Whole} in case that partial messages are being received.
pack-priv class	BufferedStringReader Passed to the (@link MessageHandler.Whole} in case that partial messages are being received.
public abstract class	ComponentProvider Provides an instance.
public class	ComponentProviderService Provides an instance of component.
public class	DebugContext A `java.util.logging.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. After a session ID has been provided, messages are logged immediately.
public class	DefaultComponentProvider Provides instances using reflection.
pack-priv class	DefaultTyrusServerEndpointConfig Default tyrus-specific implementation of `TyrusServerEndpointConfig`.
public class	ErrorCollector Used to collect deployment errors to present these to the user together.
public abstract class	ExecutorServiceProvider
public class	Handshake Class responsible for performing and validating handshake.
public class	HandshakeException `Exception`, which describes the error, occurred during the handshake phase.
pack-priv class	InputStreamBuffer Buffer used for the case when partial messages are received by the `MessageHandler.Whole`.
pack-priv class	Masker
public class	MessageHandlerManager Manages registered `MessageHandler`s and checks whether the new ones may be registered.
pack-priv class	MessageTooBigException Thrown when `jakarta.websocket.OnMessage#maxMessageSize()` is smaller than received message size.
public class	OsgiRegistry Taken from Jersey 2.
pack-priv class	OutputStreamToAsyncBinaryAdapter Simple Writer that writes its data to an async sink.
pack-priv class	PrimitivesToWrappers
public class	ProtocolException Represents issue with parsing or producing websocket frame.
public class	ProtocolHandler Tyrus protocol handler.
pack-priv class	ReaderBuffer Buffer used for the case when partial messages are received by the `MessageHandler.Whole`.
public class	ReflectionHelper Utility methods for Java reflection.
public class	RequestContext Implementation of all possible request interfaces.
pack-priv class	SecKey Class represents security key, used during the handshake phase.
public class	ServerEndpointConfigWrapper A public class that holds a wrapped ServerEndpointConfig.
public class	ServiceConfigurationError Taken from Jersey 2.
public class	ServiceFinder< the type of the service instance. T> A simple service-provider lookup mechanism.
public class	StrictUtf8
pack-priv class	TextBuffer
public class	TyrusEndpointWrapper Wraps the registered application class.
public class	TyrusExtension WebSocket `Extension` implementation.
public class	TyrusFuture<T> Tyrus `Future` implementation.
public abstract class	TyrusRemoteEndpoint Wraps the `jakarta.websocket.RemoteEndpoint` and represents the other side of the websocket connection.
public class	TyrusServerEndpointConfigurator Tyrus' implementation of `ServerEndpointConfig.Configurator`.
public class	TyrusSession Implementation of the `Session`.
public class	TyrusUpgradeResponse HTTP response representation.
public class	TyrusWebSocket Tyrus representation of web socket connection.
public class	TyrusWebSocketEngine `WebSocketEngine` implementation, which handles server-side handshake, validation and data processing.
public class	Utf8DecodingException TODO
public class	Utils Utility methods shared among Tyrus modules.
public abstract class	WebSocketException WebSocketException can be thrown during runtime (after handshake).
pack-priv class	WriterToAsyncTextAdapter Simple Writer that writes its data to an async sink.

Modifier and Type	Enum and Description
public enum	CloseReasons Enum containing standard CloseReasons defined in RFC 6455, see chapter 7.4.1 Defined Status Codes.
public enum	Version TODO

Package org.glassfish.tyrus.core

Interface Summary

Annotation Summary

Class Summary

Enum Summary