Modifier and Type	Class and Description
private static class	WsServerContainer.ExactPathMatch
private static class	WsServerContainer.TemplatePathMatch

Modifier and Type	Field and Description
private static final CloseReason	AUTHENTICATED_HTTP_SESSION_CLOSED
private final Map<String, Set<WsSession>>	authenticatedSessions
private final Map<String, WsServerContainer.ExactPathMatch>	configExactMatchMap
private final Map<Integer, ConcurrentSkipListMap<String, WsServerContainer.TemplatePathMatch>>	configTemplateMatchMap
private volatile boolean	deploymentFailed
private volatile boolean	endpointsRegistered
private final ServletContext	servletContext
private static final StringManager	sm Hides org.apache.tomcat.websocket.WsWebSocketContainer.sm.
private final WsWriteTimeout	wsWriteTimeout

Access	Constructor and Description
pack-priv	WsServerContainer(ServletContext servletContext)

Method Summary

Modifier and Type	Method and Description
public void	addEndpoint(ServerEndpointConfig The configuration to use when creating endpoint instances sec) Implements jakarta.websocket.server.ServerContainer.addEndpoint. Published the provided endpoint implementation at the specified path with the specified configuration.
pack-priv void	addEndpoint(ServerEndpointConfig sec, boolean fromAnnotatedPojo)
public void	addEndpoint(Class<?> The annotated POJO pojo) Implements jakarta.websocket.server.ServerContainer.addEndpoint. Provides the equivalent of `addEndpoint(ServerEndpointConfig)` for publishing plain old java objects (POJOs) that have been annotated as WebSocket endpoints.
pack-priv void	addEndpoint(Class<?> pojo, boolean fromAnnotatedPojo)
pack-priv boolean	areEndpointsRegistered()
public void	closeAuthenticatedSession(String httpSessionId)
pack-priv void	failDeployment()
public WsMappingResult	findMapping(String path)
protected InstanceManager	getInstanceManager(ClassLoader classLoader) Overrides org.apache.tomcat.websocket.WsWebSocketContainer.getInstanceManager. Overridden to make it visible to other classes in this package.
protected WsWriteTimeout	getTimeout()
private void	registerAuthenticatedSession(WsSession wsSession, String httpSessionId)
protected void	registerSession(Object key, WsSession wsSession) Overrides org.apache.tomcat.websocket.WsWebSocketContainer.registerSession. Overridden to make it visible to other classes in this package.
private void	unregisterAuthenticatedSession(WsSession wsSession, String httpSessionId)
protected void	unregisterSession(Object key, WsSession wsSession) Overrides org.apache.tomcat.websocket.WsWebSocketContainer.unregisterSession. Overridden to make it visible to other classes in this package.
public void	upgradeHttpToWebSocket(Object The `HttpServletRequest` to be processed as a WebSocket handshake as per section 4.0 of RFC 6455. httpServletRequest, Object The `HttpServletResponse` to be used when processing the `httpServletRequest` as a WebSocket handshake as per section 4.0 of RFC 6455. httpServletResponse, ServerEndpointConfig The server endpoint configuration to use to configure the WebSocket endpoint sec, Map<String, String> Provides a mapping of path parameter names and values, if any, to be used for the WebSocket connection established by the call to this method. If no such mapping is defined, an empty Map must be passed. pathParameters) Implements jakarta.websocket.server.ServerContainer.upgradeHttpToWebSocket. Upgrade the HTTP connection represented by the `HttpServletRequest` and `HttpServletResponse` to the WebSocket protocol and establish a WebSocket connection as per the provided `ServerEndpointConfig`.
private static void	validateEncoders(Class<? extends Encoder>[] encoders, InstanceManager instanceManager)

Inherited from org.apache.tomcat.websocket.WsWebSocketContainer:: backgroundProcess connectToServer connectToServer connectToServer connectToServer destroy getDefaultAsyncSendTimeout getDefaultMaxBinaryMessageBufferSize getDefaultMaxSessionIdleTimeout getDefaultMaxTextMessageBufferSize getInstalledExtensions getProcessPeriod setAsyncSendTimeout setDefaultMaxBinaryMessageBufferSize setDefaultMaxSessionIdleTimeout setDefaultMaxTextMessageBufferSize setInstanceManager setProcessPeriod

Field Detail

AUTHENTICATED_HTTP_SESSION_CLOSED	back to summary
private static final CloseReason AUTHENTICATED_HTTP_SESSION_CLOSED

authenticatedSessions	back to summary
private final Map<String, Set<WsSession>> authenticatedSessions

configExactMatchMap	back to summary
private final Map<String, WsServerContainer.ExactPathMatch> configExactMatchMap

configTemplateMatchMap	back to summary
private final Map<Integer, ConcurrentSkipListMap<String, WsServerContainer.TemplatePathMatch>> configTemplateMatchMap

deploymentFailed	back to summary
private volatile boolean deploymentFailed

endpointsRegistered	back to summary
private volatile boolean endpointsRegistered

servletContext	back to summary
private final ServletContext servletContext

sm	back to summary
private static final StringManager sm Hides org.apache.tomcat.websocket.WsWebSocketContainer.sm.

wsWriteTimeout	back to summary
private final WsWriteTimeout wsWriteTimeout

Constructor Detail

WsServerContainer	back to summary
pack-priv WsServerContainer(ServletContext servletContext)

Method Detail

addEndpoint back to summary

addEndpoint	back to summary
public void addEndpoint(ServerEndpointConfig sec) throws DeploymentException Implements jakarta.websocket.server.ServerContainer.addEndpoint. Published the provided endpoint implementation at the specified path with the specified configuration. `WsServerContainer(ServletContext)` must be called before calling this method. Parameters sec:ServerEndpointConfig The configuration to use when creating endpoint instances Annotations @Override Exceptions DeploymentException: if the endpoint cannot be published as requested

public void addEndpoint(ServerEndpointConfig sec) throws DeploymentException

Implements jakarta.websocket.server.ServerContainer.addEndpoint.

Published the provided endpoint implementation at the specified path with the specified configuration. WsServerContainer(ServletContext) must be called before calling this method.

Parameters

sec:ServerEndpointConfig: The configuration to use when creating endpoint instances

Annotations

@Override

Exceptions

DeploymentException:: if the endpoint cannot be published as requested

addEndpoint	back to summary
pack-priv void addEndpoint(ServerEndpointConfig sec, boolean fromAnnotatedPojo) throws DeploymentException

addEndpoint back to summary

addEndpoint	back to summary
public void addEndpoint(Class<?> pojo) throws DeploymentException Implements jakarta.websocket.server.ServerContainer.addEndpoint. Provides the equivalent of `addEndpoint(ServerEndpointConfig)` for publishing plain old java objects (POJOs) that have been annotated as WebSocket endpoints. Parameters pojo:Class<?> The annotated POJO Annotations @Override

public void addEndpoint(Class<?> pojo) throws DeploymentException

Implements jakarta.websocket.server.ServerContainer.addEndpoint.

Provides the equivalent of addEndpoint(ServerEndpointConfig) for publishing plain old java objects (POJOs) that have been annotated as WebSocket endpoints.

Parameters

pojo:Class<?>: The annotated POJO

Annotations

@Override

addEndpoint	back to summary
pack-priv void addEndpoint(Class<?> pojo, boolean fromAnnotatedPojo) throws DeploymentException

areEndpointsRegistered	back to summary
pack-priv boolean areEndpointsRegistered()

closeAuthenticatedSession	back to summary
public void closeAuthenticatedSession(String httpSessionId)

failDeployment	back to summary
pack-priv void failDeployment()

findMapping	back to summary
public WsMappingResult findMapping(String path)

getInstanceManager	back to summary
protected InstanceManager getInstanceManager(ClassLoader classLoader) Overrides org.apache.tomcat.websocket.WsWebSocketContainer.getInstanceManager. Overridden to make it visible to other classes in this package. Annotations @Override

getInstanceManager

back to summary

protected InstanceManager getInstanceManager(ClassLoader classLoader)

Overrides org.apache.tomcat.websocket.WsWebSocketContainer.getInstanceManager.

Overridden to make it visible to other classes in this package.

Annotations

@Override

getTimeout	back to summary
protected WsWriteTimeout getTimeout()

registerAuthenticatedSession	back to summary
private void registerAuthenticatedSession(WsSession wsSession, String httpSessionId)

registerSession	back to summary
protected void registerSession(Object key, WsSession wsSession) Overrides org.apache.tomcat.websocket.WsWebSocketContainer.registerSession. Overridden to make it visible to other classes in this package. Annotations @Override

registerSession

back to summary

protected void registerSession(Object key, WsSession wsSession)

Overrides org.apache.tomcat.websocket.WsWebSocketContainer.registerSession.

Overridden to make it visible to other classes in this package.

Annotations

@Override

unregisterAuthenticatedSession	back to summary
private void unregisterAuthenticatedSession(WsSession wsSession, String httpSessionId)

unregisterSession	back to summary
protected void unregisterSession(Object key, WsSession wsSession) Overrides org.apache.tomcat.websocket.WsWebSocketContainer.unregisterSession. Overridden to make it visible to other classes in this package. Annotations @Override

unregisterSession

back to summary

protected void unregisterSession(Object key, WsSession wsSession)

Overrides org.apache.tomcat.websocket.WsWebSocketContainer.unregisterSession.

Overridden to make it visible to other classes in this package.

Annotations

@Override

upgradeHttpToWebSocket back to summary

upgradeHttpToWebSocket	back to summary
public void upgradeHttpToWebSocket(Object httpServletRequest, Object httpServletResponse, ServerEndpointConfig sec, Map<String, String> pathParameters) throws IOException, DeploymentException Implements jakarta.websocket.server.ServerContainer.upgradeHttpToWebSocket. Doc from jakarta.websocket.server.ServerContainer.upgradeHttpToWebSocket. Upgrade the HTTP connection represented by the `HttpServletRequest` and `HttpServletResponse` to the WebSocket protocol and establish a WebSocket connection as per the provided `ServerEndpointConfig`. This method is primarily intended to be used by frameworks that implement the front-controller pattern. It does not deploy the provided endpoint. If the WebSocket implementation is not deployed as part of a Jakarta Servlet container, this method will throw an `UnsupportedOperationException`. Parameters httpServletRequest:Object The `HttpServletRequest` to be processed as a WebSocket handshake as per section 4.0 of RFC 6455. httpServletResponse:Object The `HttpServletResponse` to be used when processing the `httpServletRequest` as a WebSocket handshake as per section 4.0 of RFC 6455. sec:ServerEndpointConfig The server endpoint configuration to use to configure the WebSocket endpoint pathParameters:Map<String, String> Provides a mapping of path parameter names and values, if any, to be used for the WebSocket connection established by the call to this method. If no such mapping is defined, an empty Map must be passed. Annotations @Override Exceptions IOException: if an I/O error occurs during the establishment of a WebSocket connection DeploymentException: if a configuration error prevents the establishment of a WebSocket connection

public void upgradeHttpToWebSocket(Object httpServletRequest, Object httpServletResponse, ServerEndpointConfig sec, Map<String, String> pathParameters) throws IOException, DeploymentException

Implements jakarta.websocket.server.ServerContainer.upgradeHttpToWebSocket.

Doc from jakarta.websocket.server.ServerContainer.upgradeHttpToWebSocket.

Upgrade the HTTP connection represented by the HttpServletRequest and HttpServletResponse to the WebSocket protocol and establish a WebSocket connection as per the provided ServerEndpointConfig.

This method is primarily intended to be used by frameworks that implement the front-controller pattern. It does not deploy the provided endpoint.

If the WebSocket implementation is not deployed as part of a Jakarta Servlet container, this method will throw an UnsupportedOperationException.

Parameters

httpServletRequest:Object: The HttpServletRequest to be processed as a WebSocket handshake as per section 4.0 of RFC 6455.
httpServletResponse:Object: The HttpServletResponse to be used when processing the httpServletRequest as a WebSocket handshake as per section 4.0 of RFC 6455.
sec:ServerEndpointConfig: The server endpoint configuration to use to configure the WebSocket endpoint
pathParameters:Map<String, String>: Provides a mapping of path parameter names and values, if any, to be used for the WebSocket connection established by the call to this method. If no such mapping is defined, an empty Map must be passed.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs during the establishment of a WebSocket connection
DeploymentException:: if a configuration error prevents the establishment of a WebSocket connection

validateEncoders	back to summary
private static void validateEncoders(Class<? extends Encoder>[] encoders, InstanceManager instanceManager) throws DeploymentException

org.apache.tomcat.websocket.server back to summary

private Class WsServerContainer.ExactPathMatch

Class Inheritance

extends Object

java.lang.Object
org.apache.tomcat.websocket.server.WsServerContainer.ExactPathMatch

Field Summary

Modifier and Type	Field and Description
private final ServerEndpointConfig	config
private final boolean	fromAnnotatedPojo

Constructor Summary

Access	Constructor and Description
pack-priv	ExactPathMatch(ServerEndpointConfig config, boolean fromAnnotatedPojo)

Method Summary

Modifier and Type	Method and Description
public ServerEndpointConfig	getConfig()
public boolean	isFromAnnotatedPojo()

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

Field Detail

config	back to summary
private final ServerEndpointConfig config

fromAnnotatedPojo	back to summary
private final boolean fromAnnotatedPojo

Constructor Detail

ExactPathMatch	back to summary
pack-priv ExactPathMatch(ServerEndpointConfig config, boolean fromAnnotatedPojo)

Method Detail

getConfig	back to summary
public ServerEndpointConfig getConfig()

isFromAnnotatedPojo	back to summary
public boolean isFromAnnotatedPojo()

org.apache.tomcat.websocket.server back to summary

private Class WsServerContainer.TemplatePathMatch

Class Inheritance

extends Object

java.lang.Object
org.apache.tomcat.websocket.server.WsServerContainer.TemplatePathMatch

Field Summary

Modifier and Type	Field and Description
private final ServerEndpointConfig	config
private final boolean	fromAnnotatedPojo
private final UriTemplate	uriTemplate

Constructor Summary

Access	Constructor and Description
pack-priv	TemplatePathMatch(ServerEndpointConfig config, UriTemplate uriTemplate, boolean fromAnnotatedPojo)

Method Summary

Modifier and Type	Method and Description
public ServerEndpointConfig	getConfig()
public UriTemplate	getUriTemplate()
public boolean	isFromAnnotatedPojo()

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

Field Detail

config	back to summary
private final ServerEndpointConfig config

fromAnnotatedPojo	back to summary
private final boolean fromAnnotatedPojo

uriTemplate	back to summary
private final UriTemplate uriTemplate

Constructor Detail

TemplatePathMatch	back to summary
pack-priv TemplatePathMatch(ServerEndpointConfig config, UriTemplate uriTemplate, boolean fromAnnotatedPojo)

Method Detail

getConfig	back to summary
public ServerEndpointConfig getConfig()

getUriTemplate	back to summary
public UriTemplate getUriTemplate()

isFromAnnotatedPojo	back to summary
public boolean isFromAnnotatedPojo()

public Class WsServerContainer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WsServerContainer.ExactPathMatch

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WsServerContainer.TemplatePathMatch

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail