Uses of Interface
jakarta.websocket.Session

Packages that use Session

Package	Description
jakarta.websocket	This package contains all the Jakarta WebSocket APIs common to both the client and server side.
org.glassfish.tyrus.client	Common Client.
org.glassfish.tyrus.core	Core classes.
org.glassfish.tyrus.core.cluster	Cluster relates classes and interfaces.

Uses of Session in jakarta.websocket

Methods in jakarta.websocket that return Session

Modifier and Type	Method	Description
Session	WebSocketContainer.connectToServer(Endpoint endpointInstance, ClientEndpointConfig cec, java.net.URI path)	Connect the supplied programmatic client endpoint instance to its server with the given configuration.
Session	WebSocketContainer.connectToServer(java.lang.Class<?> annotatedEndpointClass, java.net.URI path)	Connect the supplied annotated endpoint to its server.
Session	WebSocketContainer.connectToServer(java.lang.Class<? extends Endpoint> endpointClass, ClientEndpointConfig cec, java.net.URI path)	Connect the supplied programmatic endpoint to its server with the given configuration.
Session	WebSocketContainer.connectToServer(java.lang.Object annotatedEndpointInstance, java.net.URI path)	Connect the supplied annotated endpoint instance to its server.
Session	SessionException.getSession()	Return the Session on which the problem occurred.

Methods in jakarta.websocket that return types with arguments of type Session

Modifier and Type	Method	Description
java.util.Set<Session>	Session.getOpenSessions()	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.

Methods in jakarta.websocket with parameters of type Session

Modifier and Type	Method	Description
void	Endpoint.onClose(Session session, CloseReason closeReason)	This method is called immediately prior to the session with the remote peer being closed.
void	Endpoint.onError(Session session, java.lang.Throwable thr)	Developers may implement this method when the web socket session creates some kind of error that is not modeled in the web socket protocol.
abstract void	Endpoint.onOpen(Session session, EndpointConfig config)	Developers must implement this method to be notified when a new conversation has just begun.

Constructors in jakarta.websocket with parameters of type Session

Constructor	Description
SessionException(java.lang.String message, java.lang.Throwable cause, Session session)	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.

Uses of Session in org.glassfish.tyrus.client

Methods in org.glassfish.tyrus.client that return Session

Modifier and Type	Method	Description
Session	ClientManager.connectToServer(Endpoint endpointInstance, ClientEndpointConfig cec, java.net.URI path)
Session	ClientManager.connectToServer(java.lang.Class<? extends Endpoint> endpointClass, ClientEndpointConfig cec, java.net.URI path)
Session	ClientManager.connectToServer(java.lang.Class annotatedEndpointClass, java.net.URI path)
Session	ClientManager.connectToServer(java.lang.Object obj, java.net.URI path)

Methods in org.glassfish.tyrus.client that return types with arguments of type Session

Modifier and Type	Method	Description
java.util.concurrent.Future<Session>	ClientManager.asyncConnectToServer(Endpoint endpointInstance, ClientEndpointConfig cec, java.net.URI path)	Non-blocking version of WebSocketContainer.connectToServer(jakarta.websocket.Endpoint, jakarta.websocket.ClientEndpointConfig, java.net.URI).
java.util.concurrent.Future<Session>	ClientManager.asyncConnectToServer(java.lang.Class<?> annotatedEndpointClass, java.net.URI path)	Non-blocking version of WebSocketContainer.connectToServer(Class, java.net.URI).
java.util.concurrent.Future<Session>	ClientManager.asyncConnectToServer(java.lang.Class<? extends Endpoint> endpointClass, ClientEndpointConfig cec, java.net.URI path)	Non-blocking version of WebSocketContainer.connectToServer(Class, jakarta.websocket.ClientEndpointConfig, java.net.URI).
java.util.concurrent.Future<Session>	ClientManager.asyncConnectToServer(java.lang.Object obj, java.net.URI path)	Non-blocking version of WebSocketContainer.connectToServer(Object, java.net.URI).

Methods in org.glassfish.tyrus.client with parameters of type Session

Modifier and Type	Method	Description
void	TyrusClientEngine.ClientHandshakeListener.onSessionCreated(Session session)	Invoked when handshake is completed and provided Session is open and ready to be returned from WebSocketContainer.connectToServer(Class, jakarta.websocket.ClientEndpointConfig, java.net.URI) (and alternatives) call.

Uses of Session in org.glassfish.tyrus.core

Classes in org.glassfish.tyrus.core that implement Session

Modifier and Type	Class	Description
class	TyrusSession	Implementation of the Session.

Methods in org.glassfish.tyrus.core that return Session

Modifier and Type	Method	Description
Session	TyrusEndpointWrapper.createSessionForRemoteEndpoint(TyrusWebSocket socket, java.lang.String subprotocol, java.util.List<Extension> extensions, DebugContext debugContext)	Creates a Session based on the TyrusWebSocket, subprotocols and extensions.

Methods in org.glassfish.tyrus.core that return types with arguments of type Session

Modifier and Type	Method	Description
java.util.Map<Session,java.util.concurrent.Future<?>>	TyrusSession.broadcast(java.lang.String message)	Broadcasts text message to all connected clients.
java.util.Map<Session,java.util.concurrent.Future<?>>	TyrusSession.broadcast(java.nio.ByteBuffer message)	Broadcasts binary message to all connected clients, including remote sessions (if any).
java.util.Set<Session>	TyrusSession.getOpenSessions()

Methods in org.glassfish.tyrus.core with parameters of type Session

Modifier and Type	Method	Description
java.lang.Object	TyrusEndpointWrapper.doEncode(Session session, java.lang.Object message)
<T> java.lang.Object	ComponentProviderService.getCoderInstance(java.lang.Class<T> c, Session session, EndpointConfig endpointConfig, ErrorCollector collector)	Provide an instance of Encoder or Decoder descendant which is coupled to Session.
<T> java.lang.Object	ComponentProviderService.getInstance(java.lang.Class<T> c, Session session, ErrorCollector collector)	Provide an instance of class which is coupled to Session.
void	AnnotatedEndpoint.onClose(Session session, CloseReason closeReason)
void	AnnotatedEndpoint.onError(Session session, java.lang.Throwable thr)
void	AnnotatedEndpoint.onOpen(Session session, EndpointConfig configuration)
void	ComponentProviderService.removeSession(Session session)	Remove Session from cache.

Uses of Session in org.glassfish.tyrus.core.cluster

Subinterfaces of Session in org.glassfish.tyrus.core.cluster

Modifier and Type	Interface	Description
interface	DistributedSession	Extended Session which adds distributed properties.

Classes in org.glassfish.tyrus.core.cluster that implement Session

Modifier and Type	Class	Description
class	RemoteSession	Remote session represents session originating from another node.

Methods in org.glassfish.tyrus.core.cluster that return types with arguments of type Session

Modifier and Type	Method	Description
java.util.Set<Session>	RemoteSession.getOpenSessions()	This method is not supported on RemoteSession.

Constructors in org.glassfish.tyrus.core.cluster with parameters of type Session

Constructor	Description
RemoteSession(java.lang.String sessionId, ClusterContext clusterContext, java.util.Map<RemoteSession.DistributedMapKey,java.lang.Object> distributedPropertyMap, TyrusEndpointWrapper endpointWrapper, Session session)	Constructor.
SessionEventListener(Session session)	Constructor.