Tomcat 10.1.19 · org.apache.tomcat.websocket.WsSession

Modifier and Type	Class and Description
private static enum	WsSession.State

Modifier and Type	Field and Description
private final ClassLoader	applicationClassLoader
private volatile MessageHandler	binaryMessageHandler
private static final byte[]	ELLIPSIS_BYTES
private static final int	ELLIPSIS_BYTES_LEN
private final EndpointConfig	endpointConfig
private Map<FutureToSendHandler, FutureToSendHandler>	futures
private final String	httpSessionId
private final String	id
private static AtomicLong	ids
private volatile long	lastActiveRead
private volatile long	lastActiveWrite
private final Endpoint	localEndpoint
private final Log	log
private volatile int	maxBinaryMessageBufferSize
private volatile long	maxIdleTimeout
private volatile int	maxTextMessageBufferSize
private final List<Extension>	negotiatedExtensions
private final Map<String, String>	pathParameters
private volatile MessageHandler.Whole<PongMessage>	pongMessageHandler
private final String	queryString
private final RemoteEndpoint.Async	remoteEndpointAsync
private final RemoteEndpoint.Basic	remoteEndpointBasic
private final Map<String, List<String>>	requestParameterMap
private final URI	requestUri
private static final boolean	SEC_CONFIGURATOR_USES_IMPL_DEFAULT
private final boolean	secure
private volatile Long	sessionCloseTimeoutExpiry
private static final StringManager	sm
private AtomicReference<WsSession.State>	state
private final String	subProtocol
private volatile MessageHandler	textMessageHandler
private final Principal	userPrincipal
private final Map<String, Object>	userProperties
private final WsWebSocketContainer	webSocketContainer
private WsFrameBase	wsFrame
private final WsRemoteEndpointImplBase	wsRemoteEndpoint

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	WsSession(ClientEndpointHolder The end point managed by this code clientEndpointHolder, WsRemoteEndpointImplBase The other / remote end point wsRemoteEndpoint, WsWebSocketContainer The container that created this session wsWebSocketContainer, List<Extension> The agreed extensions to use for this session negotiatedExtensions, String The agreed sub-protocol to use for this session subProtocol, Map<String, String> The path parameters associated with the request that initiated this session or `null` if this is a client session pathParameters, boolean Was this session initiated over a secure connection? secure, ClientEndpointConfig The configuration information for the client end point clientEndpointConfig) Creates a new WebSocket session for communication between the provided client and remote end points.
public	WsSession(WsRemoteEndpointImplBase The other / remote end point wsRemoteEndpoint, WsWebSocketContainer The container that created this session wsWebSocketContainer, URI The URI used to connect to this end point or `null` if this is a client session requestUri, Map<String, List<String>> The parameters associated with the request that initiated this session or `null` if this is a client session requestParameterMap, String The query string associated with the request that initiated this session or `null` if this is a client session queryString, Principal The principal associated with the request that initiated this session or `null` if this is a client session userPrincipal, String The HTTP session ID associated with the request that initiated this session or `null` if this is a client session httpSessionId, List<Extension> The agreed extensions to use for this session negotiatedExtensions, String The agreed sub-protocol to use for this session subProtocol, Map<String, String> The path parameters associated with the request that initiated this session or `null` if this is a client session pathParameters, boolean Was this session initiated over a secure connection? secure, ServerEndpointConfig The configuration information for the server end point serverEndpointConfig) Creates a new WebSocket session for communication between the provided server and remote end points.

public

WsSession(ClientEndpointHolder

The end point managed by this code

clientEndpointHolder, WsRemoteEndpointImplBase

The other / remote end point

wsRemoteEndpoint, WsWebSocketContainer

The container that created this session

wsWebSocketContainer, List<Extension>

The agreed extensions to use for this session

negotiatedExtensions, String

The agreed sub-protocol to use for this session

subProtocol, Map<String, String>

The path parameters associated with the request that initiated this session or null if this is a client session

pathParameters, boolean

Was this session initiated over a secure connection?

secure, ClientEndpointConfig

The configuration information for the client end point

clientEndpointConfig)

Creates a new WebSocket session for communication between the provided client and remote end points.

public

WsSession(WsRemoteEndpointImplBase

The other / remote end point

wsRemoteEndpoint, WsWebSocketContainer

The container that created this session

wsWebSocketContainer, URI

The URI used to connect to this end point or null if this is a client session

requestUri, Map<String, List<String>>

The parameters associated with the request that initiated this session or null if this is a client session

requestParameterMap, String

The query string associated with the request that initiated this session or null if this is a client session

queryString, Principal

The principal associated with the request that initiated this session or null if this is a client session

userPrincipal, String

The HTTP session ID associated with the request that initiated this session or null if this is a client session

httpSessionId, List<Extension>

The agreed extensions to use for this session

negotiatedExtensions, String

The agreed sub-protocol to use for this session

subProtocol, Map<String, String>

The path parameters associated with the request that initiated this session or null if this is a client session

pathParameters, boolean

Was this session initiated over a secure connection?

secure, ServerEndpointConfig

The configuration information for the server end point

serverEndpointConfig)

Creates a new WebSocket session for communication between the provided server and remote end points.

Method Summary

Modifier and Type	Method and Description
public void	addMessageHandler(MessageHandler The message handler for a incoming message listener) Implements jakarta.websocket.Session.addMessageHandler. Registers a `MessageHandler` for incoming messages.
public <T> void	addMessageHandler(Class<T> The Class that implements T clazz, MessageHandler.Partial<T> The message handler for a incoming message handler) Implements jakarta.websocket.Session.addMessageHandler. Registers a `MessageHandler` for partial incoming messages.
public <T> void	addMessageHandler(Class<T> The Class that implements T clazz, MessageHandler.Whole<T> The message handler for a incoming message handler) Implements jakarta.websocket.Session.addMessageHandler. Registers a `MessageHandler` for whole incoming messages.
protected static void	appendCloseReasonWithTruncation(ByteBuffer The message msg, String The reason reason) Use protected so unit tests can access this method directly.
protected void	checkCloseTimeout()
protected void	checkExpiration()
private void	checkState()
public void	close() Implements jakarta.websocket.Session.close. Close the connection to the remote end point using the code `jakarta.websocket.CloseReason.CloseCodes#NORMAL_CLOSURE` and an empty reason phrase.
public void	close(CloseReason The reason the WebSocket session is being closed. closeReason) Implements jakarta.websocket.Session.close. Close the connection to the remote end point using the specified code and reason phrase.
private void	closeConnection()
private void	doAddMessageHandler(Class<?> target, MessageHandler listener)
public void	doClose(CloseReason The close reason to pass to the remote endpoint closeReasonMessage, CloseReason The close reason to pass to the local endpoint closeReasonLocal) WebSocket 1.0.
public void	doClose(CloseReason The close reason to pass to the remote endpoint closeReasonMessage, CloseReason The close reason to pass to the local endpoint closeReasonLocal, boolean Should the socket be closed immediately rather than waiting for the server to respond closeSocket) WebSocket 1.0.
private void	fireEndpointOnClose(CloseReason closeReason)
private void	fireEndpointOnError(Throwable throwable)
public RemoteEndpoint.Async	getAsyncRemote() Implements jakarta.websocket.Session.getAsyncRemote.
public RemoteEndpoint.Basic	getBasicRemote() Implements jakarta.websocket.Session.getBasicRemote.
protected MessageHandler	getBinaryMessageHandler()
public WebSocketContainer	getContainer() Implements jakarta.websocket.Session.getContainer. Get the container that created this session.
public String	getHttpSessionId()
public String	getId() Implements jakarta.websocket.Session.getId. Provides a unique identifier for the session.
public InstanceManager	getInstanceManager()
public Endpoint	getLocal()
public int	getMaxBinaryMessageBufferSize() Implements jakarta.websocket.Session.getMaxBinaryMessageBufferSize. Get the current maximum buffer size for binary messages.
public long	getMaxIdleTimeout() Implements jakarta.websocket.Session.getMaxIdleTimeout. Get the idle timeout for this session.
private long	getMaxIdleTimeoutRead()
private long	getMaxIdleTimeoutWrite()
public int	getMaxTextMessageBufferSize() Implements jakarta.websocket.Session.getMaxTextMessageBufferSize. Get the maximum buffer size for text messages.
public Set<MessageHandler>	getMessageHandlers() Implements jakarta.websocket.Session.getMessageHandlers.
public List<Extension>	getNegotiatedExtensions() Implements jakarta.websocket.Session.getNegotiatedExtensions.
public String	getNegotiatedSubprotocol() Implements jakarta.websocket.Session.getNegotiatedSubprotocol.
public Set<Session>	getOpenSessions() Implements jakarta.websocket.Session.getOpenSessions. Obtain the set of open sessions associated with the same local endpoint as this session.
public Map<String, String>	getPathParameters() Implements jakarta.websocket.Session.getPathParameters.
protected MessageHandler.Whole<PongMessage>	getPongMessageHandler()
public String	getProtocolVersion() Implements jakarta.websocket.Session.getProtocolVersion.
public String	getQueryString() Implements jakarta.websocket.Session.getQueryString.
public Map<String, List<String>>	getRequestParameterMap() Implements jakarta.websocket.Session.getRequestParameterMap.
public URI	getRequestURI() Implements jakarta.websocket.Session.getRequestURI.
protected long	getSessionCloseTimeout()
private Object	getSessionMapKey()
protected MessageHandler	getTextMessageHandler()
public Principal	getUserPrincipal() Implements jakarta.websocket.Session.getUserPrincipal.
public Principal	getUserPrincipalInternal()
public Map<String, Object>	getUserProperties() Implements jakarta.websocket.Session.getUserProperties.
public boolean	isClosed()
private boolean	isDefaultConfigurator(ServerEndpointConfig.Configurator configurator)
public boolean	isOpen() Implements jakarta.websocket.Session.isOpen.
public boolean	isSecure() Implements jakarta.websocket.Session.isSecure.
public void	onClose(CloseReason The reason contained within the received close message. closeReason) Called when a close message is received.
protected void	registerFuture(FutureToSendHandler The handler f2sh) Make the session aware of a `FutureToSendHandler` that will need to be forcibly closed if the session closes before the `FutureToSendHandler` completes.
public void	removeMessageHandler(MessageHandler listener) Implements jakarta.websocket.Session.removeMessageHandler.
public void	resume() Resumes the reading of the incoming messages.
private void	sendCloseMessage(CloseReason closeReason)
public void	setMaxBinaryMessageBufferSize(int The new maximum buffer size in bytes max) Implements jakarta.websocket.Session.setMaxBinaryMessageBufferSize. Set the current maximum buffer size for binary messages.
public void	setMaxIdleTimeout(long The new idle timeout for this session in milliseconds. Zero or negative values indicate an infinite timeout. timeout) Implements jakarta.websocket.Session.setMaxIdleTimeout. Set the idle timeout for this session.
public void	setMaxTextMessageBufferSize(int The new maximum buffer size in characters. max) Implements jakarta.websocket.Session.setMaxTextMessageBufferSize. Set the maximum buffer size for text messages.
pack-priv void	setWsFrame(WsFrameBase wsFrame)
public void	suspend() Suspends the reading of the incoming messages.
protected void	unregisterFuture(FutureToSendHandler The handler f2sh) Remove a `FutureToSendHandler` from the set of tracked instances.
protected void	updateLastActiveRead()
protected void	updateLastActiveWrite()

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

public Class WsSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary