Class WsServerContainer
java.lang.Object
org.apache.tomcat.websocket.WsWebSocketContainer
org.apache.tomcat.websocket.server.WsServerContainer
- All Implemented Interfaces:
ServerContainer
,WebSocketContainer
,BackgroundProcess
Provides a per class loader (i.e. per web application) instance of a ServerContainer. Web application wide defaults
may be configured by setting the following servlet context initialisation parameters to the desired values.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Published the provided endpoint implementation at the specified path with the specified configuration.void
addEndpoint
(Class<?> pojo) Provides the equivalent ofaddEndpoint(ServerEndpointConfig)
for publishing plain old java objects (POJOs) that have been annotated as WebSocket endpoints.void
closeAuthenticatedSession
(String httpSessionId) org.apache.tomcat.websocket.server.WsMappingResult
findMapping
(String path) protected InstanceManager
getInstanceManager
(ClassLoader classLoader) Overridden to make it visible to other classes in this package.protected WsWriteTimeout
protected void
registerSession
(Object key, WsSession wsSession) Overridden to make it visible to other classes in this package.protected void
unregisterSession
(Object key, WsSession wsSession) Overridden to make it visible to other classes in this package.void
upgradeHttpToWebSocket
(Object httpServletRequest, Object httpServletResponse, ServerEndpointConfig sec, Map<String, String> pathParameters) Upgrade the HTTP connection represented by theHttpServletRequest
andHttpServletResponse
to the WebSocket protocol and establish a WebSocket connection as per the providedServerEndpointConfig
.Methods inherited from class org.apache.tomcat.websocket.WsWebSocketContainer
backgroundProcess, connectToServer, connectToServer, connectToServer, connectToServer, destroy, getDefaultAsyncSendTimeout, getDefaultMaxBinaryMessageBufferSize, getDefaultMaxSessionIdleTimeout, getDefaultMaxTextMessageBufferSize, getInstalledExtensions, getProcessPeriod, setAsyncSendTimeout, setDefaultMaxBinaryMessageBufferSize, setDefaultMaxSessionIdleTimeout, setDefaultMaxTextMessageBufferSize, setInstanceManager, setProcessPeriod
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jakarta.websocket.WebSocketContainer
connectToServer, connectToServer, connectToServer, connectToServer, getDefaultAsyncSendTimeout, getDefaultMaxBinaryMessageBufferSize, getDefaultMaxSessionIdleTimeout, getDefaultMaxTextMessageBufferSize, getInstalledExtensions, setAsyncSendTimeout, setDefaultMaxBinaryMessageBufferSize, setDefaultMaxSessionIdleTimeout, setDefaultMaxTextMessageBufferSize
-
Method Details
-
addEndpoint
Published the provided endpoint implementation at the specified path with the specified configuration.WsServerContainer(ServletContext)
must be called before calling this method.- Specified by:
addEndpoint
in interfaceServerContainer
- Parameters:
sec
- The configuration to use when creating endpoint instances- Throws:
DeploymentException
- if the endpoint cannot be published as requested
-
addEndpoint
Provides the equivalent ofaddEndpoint(ServerEndpointConfig)
for publishing plain old java objects (POJOs) that have been annotated as WebSocket endpoints.- Specified by:
addEndpoint
in interfaceServerContainer
- Parameters:
pojo
- The annotated POJO- Throws:
DeploymentException
-
upgradeHttpToWebSocket
public void upgradeHttpToWebSocket(Object httpServletRequest, Object httpServletResponse, ServerEndpointConfig sec, Map<String, String> pathParameters) throws IOException, DeploymentExceptionDescription copied from interface:jakarta.websocket.server.ServerContainer
Upgrade the HTTP connection represented by theHttpServletRequest
andHttpServletResponse
to the WebSocket protocol and establish a WebSocket connection as per the providedServerEndpointConfig
.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
.- Specified by:
upgradeHttpToWebSocket
in interfaceServerContainer
- Parameters:
httpServletRequest
- TheHttpServletRequest
to be processed as a WebSocket handshake as per section 4.0 of RFC 6455.httpServletResponse
- TheHttpServletResponse
to be used when processing thehttpServletRequest
as a WebSocket handshake as per section 4.0 of RFC 6455.sec
- The server endpoint configuration to use to configure the WebSocket endpointpathParameters
- 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.- Throws:
IOException
- if an I/O error occurs during the establishment of a WebSocket connectionDeploymentException
- if a configuration error prevents the establishment of a WebSocket connection
-
findMapping
-
getTimeout
-
getInstanceManager
Overridden to make it visible to other classes in this package.- Overrides:
getInstanceManager
in classWsWebSocketContainer
-
registerSession
Overridden to make it visible to other classes in this package.- Overrides:
registerSession
in classWsWebSocketContainer
-
unregisterSession
Overridden to make it visible to other classes in this package.- Overrides:
unregisterSession
in classWsWebSocketContainer
-
closeAuthenticatedSession
-