Tyrus 2.2.0 · org.glassfish.tyrus.core.TyrusEndpointWrapper

Modifier and Type	Class and Description
private static interface	TyrusEndpointWrapper.SessionCallable
public abstract static class	TyrusEndpointWrapper.SessionListener Session listener.

Modifier and Type	Field and Description
private final ClusterContext	clusterContext
private final Map<String, RemoteSession>	clusteredSessions
private final ComponentProviderService	componentProvider
private final EndpointConfig	configuration
private final ServerEndpointConfig.Configurator	configurator
private final WebSocketContainer	container The container for this session.
private final String	contextPath
private final List<CoderWrapper<Decoder>>	decoders
private static final Session	dummySession Used only as a placeholder to get encoder instances from `ComponentProvider`.
private final List<CoderWrapper<Encoder>>	encoders
private final Endpoint	endpoint
private final Class<? extends Endpoint>	endpointClass
private final EndpointEventListener	endpointEventListener
private final String	endpointPath
private static final boolean	IS_JAVASSIST
private static final AtomicBoolean	IS_JAVASSIST_WARNING
private static final Logger	LOGGER
private static final int	MIN_SESSIONS_PER_THREAD Used as threshold for parallel broadcast.
private final Method	onClose
private final Method	onError
private final Method	onOpen
private final boolean	parallelBroadcastEnabled
private final boolean	programmaticEndpoint
private final String	serverEndpointPath
private final TyrusEndpointWrapper.SessionListener	sessionListener
private final Map<TyrusWebSocket, TyrusSession>	webSocketToSession

Constructor Summary

Access	Constructor and Description
public	TyrusEndpointWrapper(Class<? extends Endpoint> endpoint class for which the wrapper is created. endpointClass, EndpointConfig endpoint configuration. configuration, ComponentProviderService component provider. componentProvider, WebSocketContainer container where the wrapper is running. container, String context path of the application. contextPath, ServerEndpointConfig.Configurator endpoint configurator. configurator, TyrusEndpointWrapper.SessionListener session listener. sessionListener, ClusterContext cluster context instance. `null` indicates standalone mode. clusterContext, EndpointEventListener endpoint event listener. endpointEventListener, Boolean `true` if parallel broadcast should be enabled, `true` is default. parallelBroadcastEnabled) Create `TyrusEndpointWrapper` for class that extends `Endpoint`.
public	TyrusEndpointWrapper(Endpoint endpoint instance for which the wrapper is created. endpoint, EndpointConfig endpoint configuration. configuration, ComponentProviderService component provider. componentProvider, WebSocketContainer container where the wrapper is running. container, String context path of the application. contextPath, ServerEndpointConfig.Configurator endpoint configurator. configurator, TyrusEndpointWrapper.SessionListener session listener. sessionListener, ClusterContext cluster context instance. `null` indicates standalone mode. clusterContext, EndpointEventListener endpoint event listener. endpointEventListener, Boolean `true` if parallel broadcast should be enabled, `true` is default. parallelBroadcastEnabled) Create `TyrusEndpointWrapper` for `Endpoint` instance or `AnnotatedEndpoint` instance.
private	TyrusEndpointWrapper(Endpoint endpoint, Class<? extends Endpoint> endpointClass, EndpointConfig configuration, ComponentProviderService componentProvider, WebSocketContainer container, String contextPath, final ServerEndpointConfig.Configurator configurator, TyrusEndpointWrapper.SessionListener sessionListener, final ClusterContext clusterContext, EndpointEventListener endpointEventListener, Boolean parallelBroadcastEnabled)

Method Summary

Modifier and Type	Method and Description
pack-priv Map<Session, Future<?>>	Returns: map of sessions and futures for user to get the information about status of the message. Messages send from other cluster nodes are not included. broadcast(final String message to be broadcasted. message) Broadcasts text message to all connected clients.
private Map<Session, Future<?>>	broadcast(final String message, boolean local)
pack-priv Map<Session, Future<?>>	Returns: map of sessions and futures for user to get the information about status of the message. Messages send from other cluster nodes are not included. broadcast(final ByteBuffer message to be broadcasted. message) Broadcasts binary message to all connected clients.
private Map<Session, Future<?>>	broadcast(final ByteBuffer message, boolean local)
private Map<Session, Future<?>>	Returns: map of send futures. broadcast(TyrusEndpointWrapper.SessionCallable callable which serializes a frame to byte[] and passes it to `org.glassfish.tyrus.core.TyrusWebSocket`. The `org.glassfish.tyrus.core.TyrusEndpointWrapper.SessionCallable` also handles extensions, if any. broadcastCallable) Perform broadcast.
private HandshakeRequest	createHandshakeRequest(final UpgradeRequest webSocketRequest)
public Session	Returns: `Session` representing the connection. createSessionForRemoteEndpoint(TyrusWebSocket the other end of the connection. socket, String used. subprotocol, List<Extension> extensions used. extensions, DebugContext debug context. debugContext) Creates a Session based on the `TyrusWebSocket`, subprotocols and extensions.
pack-priv TyrusWebSocket	Returns: TODO createSocket(final ProtocolHandler the `ProtocolHandler` to use with the newly created `TyrusWebSocket`. handler) Factory method to create new `TyrusWebSocket` instances.
pack-priv Object	decodeCompleteMessage(TyrusSession session, Object message, Class<?> type, CoderWrapper<Decoder> selectedDecoder)
public Object	doEncode(Session session, Object message)
private Map<Session, Future<?>>	Returns: futures of the operations executed on each session. executeInParallel(final TyrusEndpointWrapper.SessionCallable operation to be executed on open sessions. broadcastCallable) Divides open sessions into subsets on which an operation passed as `broadcastCallable` will be executed in parallel.
private ArrayList<CoderWrapper<Decoder>>	findApplicableDecoders(TyrusSession session, Object message, boolean isString)
private <T> Object	getCoderInstance(Session session, CoderWrapper<T> wrapper)
private Class<?>	getDecoderClassType(Class<?> decoderClass)
pack-priv List<Decoder>	Returns: `List` of registered `Decoder`s. getDecoders() Registered `Decoder`s.
pack-priv static List<Class<? extends Decoder>>	getDefaultDecoders()
private Class<?>	getEncoderClassType(Class<?> encoderClass)
public EndpointConfig	Returns: configuration. getEndpointConfig() Get Endpoint configuration.
public String	Returns: endpoint absolute path. getEndpointPath() Server-side; Get Endpoint absolute path.
pack-priv List<Extension>	Returns: names of extensions supported by both client and class that implements this one. getNegotiatedExtensions(List<Extension> names of the extensions' supported by client. clientExtensions) Server-side; Get the negotiated extensions' names based on the extensions supported by client.
pack-priv String	Returns: negotiated sub-protocol, `null` if none found. getNegotiatedProtocol(List<String> sub-protocols supported by client. clientProtocols) Server-side; Compute the sub-protocol which will be used.
pack-priv Set<TyrusSession>	Returns: open sessions. getOpenSessions() Get the set of open `TyrusSession`.
pack-priv Set<RemoteSession>	getRemoteSessions()
pack-priv String	Returns: server endpoint path. getServerEndpointPath() Server-side; Get server endpoint path.
private TyrusSession	getSession(TyrusWebSocket socket)
private static URI	getURI(String uri, String queryString)
private void	handleSubmitException(Map<Session, Future<?>> futures, List<Map.Entry<TyrusWebSocket, TyrusSession>> sessions, int[] bounds, Exception e)
private void	logUsedEncoder(CoderWrapper<Encoder> encoder, Session session)
pack-priv void	onClose(TyrusWebSocket `TyrusWebSocket` who has just closed the connection. socket, CloseReason closeReason) Called by the provider when the web socket connection to the given remote endpoint has just closed.
pack-priv Session	Returns: Created `Session` instance or `null` when session was not created properly (max sessions limit on endpoint or application or issues with endpoint validation). onConnect(TyrusWebSocket `TyrusWebSocket` who has just connected to this web socket endpoint. socket, UpgradeRequest request associated with accepted connection. upgradeRequest, String subProtocol, List<Extension> extensions, String connectionId, DebugContext debug context. debugContext) Called by the provider when the web socket connection is established.
pack-priv boolean	Returns: `true` if the WebSocket should be closed otherwise `false`. onError(TyrusWebSocket the websocket being processed at the time the exception occurred. socket, Throwable the unexpected exception. t) This method will be invoked if an unexpected exception is caught by the WebSocket runtime.
pack-priv void	onHandShakeResponse(UpgradeRequest original request which caused this handshake. request, UpgradeResponse response to be send. response) Invoked when server side handshake is ready to send response.
pack-priv void	onMessage(TyrusWebSocket `TyrusWebSocket` who sent the message. socket, ByteBuffer the message. messageBytes) Called by the provider when the web socket connection has an incoming text message from the given remote endpoint.
pack-priv void	onMessage(TyrusWebSocket `TyrusWebSocket` who sent the message. socket, String the message. messageString) Called by the provider when the web socket connection has an incoming text message from the given remote endpoint.
pack-priv void	onPartialMessage(TyrusWebSocket `TyrusWebSocket` who sent the message. socket, String the String message. partialString, boolean to indicate if this is the last partial string in the sequence last) Called by the provider when the web socket connection has an incoming partial text message from the given remote endpoint.
pack-priv void	onPartialMessage(TyrusWebSocket `TyrusWebSocket` who sent the message. socket, ByteBuffer the piece of the binary message. partialBytes, boolean to indicate if this is the last partial byte buffer in the sequence last) Called by the provider when the web socket connection has an incoming partial binary message from the given remote endpoint.
pack-priv void	onPing(TyrusWebSocket `TyrusWebSocket` who sent the message. socket, ByteBuffer the message. bytes) Called by the provider when the web socket connection has an incoming ping message from the given remote endpoint.
pack-priv void	onPong(TyrusWebSocket `TyrusWebSocket` who sent the message. socket, final ByteBuffer the message. bytes) Called by the provider when the web socket connection has an incoming pong message from the given remote endpoint.
private boolean	Returns: `true` when exception is handled within this method (framework produced it), `false` otherwise. processThrowable(Throwable thrown `Throwable`. throwable, Session `Session` related to `Throwable`. session) Check `Throwable` produced during `jakarta.websocket.OnMessage` annotated method call.
private Future<?>	Returns: future representing outcome of the send operation. sendBroadcast(TyrusWebSocket `org.glassfish.tyrus.core.TyrusWebSocket` instance used for sending the frame. webSocket, Frame frame to be sent. dataFrame, TyrusFrame.FrameType type of the frame (monitoring). frameType) Serialize dataframe and send it to `org.glassfish.tyrus.core.TyrusWebSocket`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv final boolean	Returns: `true` if the request should be upgraded to a WebSocket connection. upgrade(UpgradeRequest received `UpgradeRequest`. request) Server side check for protocol specific information to determine whether the request can be upgraded.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

public Class TyrusEndpointWrapper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary