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

Modifier and Type	Class and Description
private static class	WsWebSocketContainer.HttpResponse

Modifier and Type	Field and Description
private volatile AsynchronousChannelGroup	asynchronousChannelGroup
private final Object	asynchronousChannelGroupLock
private int	backgroundProcessCount
private static final byte[]	CRLF
private long	defaultAsyncTimeout
private volatile long	defaultMaxSessionIdleTimeout
private final Map<Object, Set<WsSession>>	endpointSessionMap
private final Object	endPointSessionMapLock
private static final byte[]	GET_BYTES
private static final byte[]	HTTP_VERSION_BYTES
private InstanceManager	instanceManager
private final Log	log
private int	maxBinaryMessageBufferSize
private int	maxTextMessageBufferSize
private int	processPeriod
private static final Random	RANDOM
private static final byte[]	ROOT_URI_BYTES
private final Map<WsSession, WsSession>	sessions
private static final StringManager	sm

Access	Constructor and Description
public	WsWebSocketContainer()

Method Summary

Modifier and Type	Method and Description
private static ByteBuffer	addHeader(ByteBuffer result, String key, List<String> values)
public void	backgroundProcess() Implements org.apache.tomcat.websocket.BackgroundProcess.backgroundProcess.
public Session	connectToServer(Object pojo, URI path) Implements jakarta.websocket.WebSocketContainer.connectToServer.
public Session	connectToServer(Class<?> annotatedEndpointClass, URI path) Implements jakarta.websocket.WebSocketContainer.connectToServer.
public Session	connectToServer(Class<? extends Endpoint> An instance of this class will be created to handle responses from the server clazz, ClientEndpointConfig Used to configure the new connection clientEndpointConfiguration, URI The full URL of the WebSocket endpoint to connect to path) Implements jakarta.websocket.WebSocketContainer.connectToServer. Creates a new connection to the WebSocket.
public Session	connectToServer(Endpoint The endpoint instance that will handle responses from the server endpoint, ClientEndpointConfig Used to configure the new connection clientEndpointConfiguration, URI The full URL of the WebSocket endpoint to connect to path) Implements jakarta.websocket.WebSocketContainer.connectToServer. Creates a new connection to the WebSocket.
private Session	connectToServerRecursive(ClientEndpointHolder clientEndpointHolder, ClientEndpointConfig clientEndpointConfiguration, URI path, Set<URI> redirectSet)
private ClientEndpointConfig	createClientEndpointConfig(Class<?> annotatedEndpointClass)
private static ByteBuffer	createProxyRequest(String host, int port, String authorizationHeader)
private static ByteBuffer	createRequest(URI uri, Map<String, List<String>> reqHeaders)
private static Map<String, List<String>>	createRequestHeaders(String host, int port, boolean secure, ClientEndpointConfig clientEndpointConfiguration)
private SSLEngine	createSSLEngine(ClientEndpointConfig clientEndpointConfig, String host, int port)
public void	destroy() Cleans up the resources still in use by WebSocket sessions created from this container.
private static List<String>	generateExtensionHeaders(List<Extension> extensions)
private static String	generateWsKeyValue()
private AsynchronousChannelGroup	getAsynchronousChannelGroup()
public long	getDefaultAsyncSendTimeout() Implements jakarta.websocket.WebSocketContainer.getDefaultAsyncSendTimeout. Get the default timeout for sending a message asynchronously.
public int	getDefaultMaxBinaryMessageBufferSize() Implements jakarta.websocket.WebSocketContainer.getDefaultMaxBinaryMessageBufferSize. Get the default maximum buffer size for binary messages.
public long	getDefaultMaxSessionIdleTimeout() Implements jakarta.websocket.WebSocketContainer.getDefaultMaxSessionIdleTimeout. Get the current default session idle timeout.
public int	getDefaultMaxTextMessageBufferSize() Implements jakarta.websocket.WebSocketContainer.getDefaultMaxTextMessageBufferSize. Get the default maximum buffer size for text messages.
public Set<Extension>	getInstalledExtensions() Implements jakarta.websocket.WebSocketContainer.getInstalledExtensions. Get the installed extensions.
protected InstanceManager	getInstanceManager(ClassLoader classLoader)
pack-priv Set<Session>	getOpenSessions(Object key)
public int	getProcessPeriod() Implements org.apache.tomcat.websocket.BackgroundProcess.getProcessPeriod. The default value is 10 which means session expirations are processed every 10 seconds.
private static boolean	isRedirectStatus(int httpResponseCode)
private void	parseHeaders(String line, Map<String, List<String>> headers)
private int	parseStatus(String line)
private Session	processAuthenticationChallenge(ClientEndpointHolder clientEndpointHolder, ClientEndpointConfig clientEndpointConfiguration, URI path, Set<URI> redirectSet, Map<String, Object> userProperties, ByteBuffer request, WsWebSocketContainer.HttpResponse httpResponse, AuthenticationType authenticationType)
private WsWebSocketContainer.HttpResponse	processResponse(ByteBuffer response, AsyncChannelWrapper channel, long timeout) Process response, blocking until HTTP response has been fully received.
private static ByteBuffer	putWithExpand(ByteBuffer input, byte[] bytes)
private String	readLine(ByteBuffer response)
protected void	registerSession(Object key, WsSession wsSession)
public void	setAsyncSendTimeout(long The new default timeout in milliseconds. A non-positive value means an infinite timeout. timeout) Implements jakarta.websocket.WebSocketContainer.setAsyncSendTimeout. Set the default timeout for sending a message asynchronously.
public void	setDefaultMaxBinaryMessageBufferSize(int The new default maximum buffer size in bytes max) Implements jakarta.websocket.WebSocketContainer.setDefaultMaxBinaryMessageBufferSize. Set the default maximum buffer size for binary messages.
public void	setDefaultMaxSessionIdleTimeout(long The new default session idle timeout in milliseconds. Zero or negative values indicate an infinite timeout. timeout) Implements jakarta.websocket.WebSocketContainer.setDefaultMaxSessionIdleTimeout. Set the default session idle timeout.
public void	setDefaultMaxTextMessageBufferSize(int The new default maximum buffer size in characters max) Implements jakarta.websocket.WebSocketContainer.setDefaultMaxTextMessageBufferSize. Set the default maximum buffer size for text messages.
protected void	setInstanceManager(InstanceManager instanceManager)
public void	setProcessPeriod(int period) Implements org.apache.tomcat.websocket.BackgroundProcess.setProcessPeriod.
protected void	unregisterSession(Object key, WsSession wsSession)
private static void	writeRequest(AsyncChannelWrapper channel, ByteBuffer request, long timeout)

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

asynchronousChannelGroup	back to summary
private volatile AsynchronousChannelGroup asynchronousChannelGroup

asynchronousChannelGroupLock	back to summary
private final Object asynchronousChannelGroupLock

backgroundProcessCount	back to summary
private int backgroundProcessCount

CRLF	back to summary
private static final byte[] CRLF

defaultAsyncTimeout	back to summary
private long defaultAsyncTimeout

defaultMaxSessionIdleTimeout	back to summary
private volatile long defaultMaxSessionIdleTimeout

endpointSessionMap	back to summary
private final Map<Object, Set<WsSession>> endpointSessionMap

endPointSessionMapLock	back to summary
private final Object endPointSessionMapLock

GET_BYTES	back to summary
private static final byte[] GET_BYTES

HTTP_VERSION_BYTES	back to summary
private static final byte[] HTTP_VERSION_BYTES

instanceManager	back to summary
private InstanceManager instanceManager

log	back to summary
private final Log log

maxBinaryMessageBufferSize	back to summary
private int maxBinaryMessageBufferSize

maxTextMessageBufferSize	back to summary
private int maxTextMessageBufferSize

processPeriod	back to summary
private int processPeriod

RANDOM	back to summary
private static final Random RANDOM

ROOT_URI_BYTES	back to summary
private static final byte[] ROOT_URI_BYTES

sessions	back to summary
private final Map<WsSession, WsSession> sessions

sm	back to summary
private static final StringManager sm

WsWebSocketContainer	back to summary
public WsWebSocketContainer()

Method Detail

addHeader	back to summary
private static ByteBuffer addHeader(ByteBuffer result, String key, List<String> values)

backgroundProcess	back to summary
public void backgroundProcess() Implements org.apache.tomcat.websocket.BackgroundProcess.backgroundProcess. Annotations @Override

backgroundProcess

back to summary

public void backgroundProcess()

Implements org.apache.tomcat.websocket.BackgroundProcess.backgroundProcess.

Annotations

@Override

connectToServer	back to summary
public Session connectToServer(Object pojo, URI path) throws DeploymentException Implements jakarta.websocket.WebSocketContainer.connectToServer. Annotations @Override

connectToServer

back to summary

public Session connectToServer(Object pojo, URI path) throws DeploymentException

Implements jakarta.websocket.WebSocketContainer.connectToServer.

Annotations

@Override

connectToServer	back to summary
public Session connectToServer(Class<?> annotatedEndpointClass, URI path) throws DeploymentException Implements jakarta.websocket.WebSocketContainer.connectToServer. Annotations @Override

connectToServer

back to summary

public Session connectToServer(Class<?> annotatedEndpointClass, URI path) throws DeploymentException

Implements jakarta.websocket.WebSocketContainer.connectToServer.

Annotations

@Override

connectToServer	back to summary
public Session connectToServer(Class<? extends Endpoint> clazz, ClientEndpointConfig clientEndpointConfiguration, URI path) throws DeploymentException Implements jakarta.websocket.WebSocketContainer.connectToServer. Doc from jakarta.websocket.WebSocketContainer.connectToServer. Creates a new connection to the WebSocket. Parameters clazz:Class<? extends Endpoint> An instance of this class will be created to handle responses from the server clientEndpointConfiguration:ClientEndpointConfig Used to configure the new connection path:URI The full URL of the WebSocket endpoint to connect to Returns:Session The WebSocket session for the connection Annotations @Override Exceptions DeploymentException: If the connection cannot be established

connectToServer

back to summary

public Session connectToServer(Class<? extends Endpoint> clazz, ClientEndpointConfig clientEndpointConfiguration, URI path) throws DeploymentException

Implements jakarta.websocket.WebSocketContainer.connectToServer.

Doc from jakarta.websocket.WebSocketContainer.connectToServer.

Creates a new connection to the WebSocket.

Parameters

clazz:Class<? extends Endpoint>: An instance of this class will be created to handle responses from the server
clientEndpointConfiguration:ClientEndpointConfig: Used to configure the new connection
path:URI: The full URL of the WebSocket endpoint to connect to

Returns:Session

The WebSocket session for the connection

Annotations

@Override

Exceptions

DeploymentException:: If the connection cannot be established

connectToServer	back to summary
public Session connectToServer(Endpoint endpoint, ClientEndpointConfig clientEndpointConfiguration, URI path) throws DeploymentException Implements jakarta.websocket.WebSocketContainer.connectToServer. Doc from jakarta.websocket.WebSocketContainer.connectToServer. Creates a new connection to the WebSocket. Parameters endpoint:Endpoint The endpoint instance that will handle responses from the server clientEndpointConfiguration:ClientEndpointConfig Used to configure the new connection path:URI The full URL of the WebSocket endpoint to connect to Returns:Session The WebSocket session for the connection Annotations @Override Exceptions DeploymentException: If the connection cannot be established

connectToServer

back to summary

public Session connectToServer(Endpoint endpoint, ClientEndpointConfig clientEndpointConfiguration, URI path) throws DeploymentException

Implements jakarta.websocket.WebSocketContainer.connectToServer.

Doc from jakarta.websocket.WebSocketContainer.connectToServer.

Creates a new connection to the WebSocket.

Parameters

endpoint:Endpoint: The endpoint instance that will handle responses from the server
clientEndpointConfiguration:ClientEndpointConfig: Used to configure the new connection
path:URI: The full URL of the WebSocket endpoint to connect to

Returns:Session

The WebSocket session for the connection

Annotations

@Override

Exceptions

DeploymentException:: If the connection cannot be established

connectToServerRecursive	back to summary
private Session connectToServerRecursive(ClientEndpointHolder clientEndpointHolder, ClientEndpointConfig clientEndpointConfiguration, URI path, Set<URI> redirectSet) throws DeploymentException

createClientEndpointConfig	back to summary
private ClientEndpointConfig createClientEndpointConfig(Class<?> annotatedEndpointClass) throws DeploymentException

createProxyRequest	back to summary
private static ByteBuffer createProxyRequest(String host, int port, String authorizationHeader)

createRequest	back to summary
private static ByteBuffer createRequest(URI uri, Map<String, List<String>> reqHeaders)

createRequestHeaders	back to summary
private static Map<String, List<String>> createRequestHeaders(String host, int port, boolean secure, ClientEndpointConfig clientEndpointConfiguration)

createSSLEngine	back to summary
private SSLEngine createSSLEngine(ClientEndpointConfig clientEndpointConfig, String host, int port) throws DeploymentException Annotations @SuppressWarnings:removal

destroy	back to summary
public void destroy() Cleans up the resources still in use by WebSocket sessions created from this container. This includes closing sessions and cancelling `Future`s associated with blocking read/writes.

generateExtensionHeaders	back to summary
private static List<String> generateExtensionHeaders(List<Extension> extensions)

generateWsKeyValue	back to summary
private static String generateWsKeyValue()

getAsynchronousChannelGroup	back to summary
private AsynchronousChannelGroup getAsynchronousChannelGroup()

getDefaultAsyncSendTimeout	back to summary
public long getDefaultAsyncSendTimeout() Implements jakarta.websocket.WebSocketContainer.getDefaultAsyncSendTimeout. Doc from jakarta.websocket.WebSocketContainer.getDefaultAsyncSendTimeout. Get the default timeout for sending a message asynchronously. The default value for this implementation is -1. Returns:long The current default timeout in milliseconds. A non-positive value means an infinite timeout. Annotations @Override

getDefaultAsyncSendTimeout

back to summary

public long getDefaultAsyncSendTimeout()

Implements jakarta.websocket.WebSocketContainer.getDefaultAsyncSendTimeout.

Doc from jakarta.websocket.WebSocketContainer.getDefaultAsyncSendTimeout.

Get the default timeout for sending a message asynchronously. The default value for this implementation is -1.

Returns:long

The current default timeout in milliseconds. A non-positive value means an infinite timeout.

Annotations

@Override

getDefaultMaxBinaryMessageBufferSize	back to summary
public int getDefaultMaxBinaryMessageBufferSize() Implements jakarta.websocket.WebSocketContainer.getDefaultMaxBinaryMessageBufferSize. Doc from jakarta.websocket.WebSocketContainer.getDefaultMaxBinaryMessageBufferSize. Get the default maximum buffer size for binary messages. Returns:int The current default maximum buffer size in bytes Annotations @Override

getDefaultMaxBinaryMessageBufferSize

back to summary

public int getDefaultMaxBinaryMessageBufferSize()

Implements jakarta.websocket.WebSocketContainer.getDefaultMaxBinaryMessageBufferSize.

Doc from jakarta.websocket.WebSocketContainer.getDefaultMaxBinaryMessageBufferSize.

Get the default maximum buffer size for binary messages.

Returns:int

The current default maximum buffer size in bytes

Annotations

@Override

getDefaultMaxSessionIdleTimeout	back to summary
public long getDefaultMaxSessionIdleTimeout() Implements jakarta.websocket.WebSocketContainer.getDefaultMaxSessionIdleTimeout. Doc from jakarta.websocket.WebSocketContainer.getDefaultMaxSessionIdleTimeout. Get the current default session idle timeout. Returns:long The current default session idle timeout in milliseconds. Zero or negative values indicate an infinite timeout. Annotations @Override

getDefaultMaxSessionIdleTimeout

back to summary

public long getDefaultMaxSessionIdleTimeout()

Implements jakarta.websocket.WebSocketContainer.getDefaultMaxSessionIdleTimeout.

Doc from jakarta.websocket.WebSocketContainer.getDefaultMaxSessionIdleTimeout.

Get the current default session idle timeout.

Returns:long

The current default session idle timeout in milliseconds. Zero or negative values indicate an infinite timeout.

Annotations

@Override

getDefaultMaxTextMessageBufferSize	back to summary
public int getDefaultMaxTextMessageBufferSize() Implements jakarta.websocket.WebSocketContainer.getDefaultMaxTextMessageBufferSize. Doc from jakarta.websocket.WebSocketContainer.getDefaultMaxTextMessageBufferSize. Get the default maximum buffer size for text messages. Returns:int The current default maximum buffer size in characters Annotations @Override

getDefaultMaxTextMessageBufferSize

back to summary

public int getDefaultMaxTextMessageBufferSize()

Implements jakarta.websocket.WebSocketContainer.getDefaultMaxTextMessageBufferSize.

Doc from jakarta.websocket.WebSocketContainer.getDefaultMaxTextMessageBufferSize.

Get the default maximum buffer size for text messages.

Returns:int

The current default maximum buffer size in characters

Annotations

@Override

getInstalledExtensions	back to summary
public Set<Extension> getInstalledExtensions() Implements jakarta.websocket.WebSocketContainer.getInstalledExtensions. Doc from jakarta.websocket.WebSocketContainer.getInstalledExtensions. Get the installed extensions. Currently, this implementation does not support any extensions. Returns:Set<Extension> The set of extensions that are supported by this WebSocket implementation. Annotations @Override

getInstalledExtensions

back to summary

public Set<Extension> getInstalledExtensions()

Implements jakarta.websocket.WebSocketContainer.getInstalledExtensions.

Doc from jakarta.websocket.WebSocketContainer.getInstalledExtensions.

Get the installed extensions. Currently, this implementation does not support any extensions.

Returns:Set<Extension>

The set of extensions that are supported by this WebSocket implementation.

Annotations

@Override

getInstanceManager	back to summary
protected InstanceManager getInstanceManager(ClassLoader classLoader)

getOpenSessions	back to summary
pack-priv Set<Session> getOpenSessions(Object key)

getProcessPeriod	back to summary
public int getProcessPeriod() Implements org.apache.tomcat.websocket.BackgroundProcess.getProcessPeriod. The default value is 10 which means session expirations are processed every 10 seconds. Annotations @Override

getProcessPeriod

back to summary

public int getProcessPeriod()

Implements org.apache.tomcat.websocket.BackgroundProcess.getProcessPeriod.

The default value is 10 which means session expirations are processed every 10 seconds.

Annotations

@Override

isRedirectStatus	back to summary
private static boolean isRedirectStatus(int httpResponseCode)

parseHeaders	back to summary
private void parseHeaders(String line, Map<String, List<String>> headers)

parseStatus	back to summary
private int parseStatus(String line) throws DeploymentException

processAuthenticationChallenge	back to summary
private Session processAuthenticationChallenge(ClientEndpointHolder clientEndpointHolder, ClientEndpointConfig clientEndpointConfiguration, URI path, Set<URI> redirectSet, Map<String, Object> userProperties, ByteBuffer request, WsWebSocketContainer.HttpResponse httpResponse, AuthenticationType authenticationType) throws DeploymentException, AuthenticationException

processResponse

back to summary

private WsWebSocketContainer.HttpResponse processResponse(ByteBuffer response, AsyncChannelWrapper channel, long timeout) throws InterruptedException, ExecutionException, DeploymentException, EOFException, TimeoutException

Process response, blocking until HTTP response has been fully received.

Exceptions

InterruptedException:: if the thread is interrupted while reading the response
ExecutionException:: if there is an exception reading the response
DeploymentException:: if the response status line is not correctly formatted
TimeoutException:: if the response was not read within the expected timeout

putWithExpand	back to summary
private static ByteBuffer putWithExpand(ByteBuffer input, byte[] bytes)

readLine	back to summary
private String readLine(ByteBuffer response)

registerSession	back to summary
protected void registerSession(Object key, WsSession wsSession)

setAsyncSendTimeout

back to summary

public void setAsyncSendTimeout(long timeout)

Implements jakarta.websocket.WebSocketContainer.setAsyncSendTimeout.

Doc from jakarta.websocket.WebSocketContainer.setAsyncSendTimeout.

Set the default timeout for sending a message asynchronously. The default value for this implementation is -1.

Parameters

timeout:long: The new default timeout in milliseconds. A non-positive value means an infinite timeout.

Annotations

@Override

setDefaultMaxBinaryMessageBufferSize

back to summary

public void setDefaultMaxBinaryMessageBufferSize(int max)

Implements jakarta.websocket.WebSocketContainer.setDefaultMaxBinaryMessageBufferSize.

Doc from jakarta.websocket.WebSocketContainer.setDefaultMaxBinaryMessageBufferSize.

Set the default maximum buffer size for binary messages.

Parameters

max:int: The new default maximum buffer size in bytes

Annotations

@Override

setDefaultMaxSessionIdleTimeout

back to summary

public void setDefaultMaxSessionIdleTimeout(long timeout)

Implements jakarta.websocket.WebSocketContainer.setDefaultMaxSessionIdleTimeout.

Doc from jakarta.websocket.WebSocketContainer.setDefaultMaxSessionIdleTimeout.

Set the default session idle timeout.

Parameters

timeout:long: The new default session idle timeout in milliseconds. Zero or negative values indicate an infinite timeout.

Annotations

@Override

setDefaultMaxTextMessageBufferSize

back to summary

public void setDefaultMaxTextMessageBufferSize(int max)

Implements jakarta.websocket.WebSocketContainer.setDefaultMaxTextMessageBufferSize.

Doc from jakarta.websocket.WebSocketContainer.setDefaultMaxTextMessageBufferSize.

Set the default maximum buffer size for text messages.

Parameters

max:int: The new default maximum buffer size in characters

Annotations

@Override

setInstanceManager	back to summary
protected void setInstanceManager(InstanceManager instanceManager)

setProcessPeriod

back to summary

public void setProcessPeriod(int period)

Implements org.apache.tomcat.websocket.BackgroundProcess.setProcessPeriod.

Annotations

@Override

unregisterSession	back to summary
protected void unregisterSession(Object key, WsSession wsSession)

writeRequest	back to summary
private static void writeRequest(AsyncChannelWrapper channel, ByteBuffer request, long timeout) throws TimeoutException, InterruptedException, ExecutionException

public Class WsWebSocketContainer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WsWebSocketContainer.HttpResponse

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final HandshakeResponse	handshakeResponse
private final int	status

Modifier and Type	Method and Description
public HandshakeResponse	getHandshakeResponse()
public int	getStatus()