Package org.springframework.web.socket.server.standard

Class TomcatRequestUpgradeStrategy

java.lang.Object

org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

org.springframework.web.socket.server.standard.StandardWebSocketUpgradeStrategy

org.springframework.web.socket.server.standard.TomcatRequestUpgradeStrategy

All Implemented Interfaces:

RequestUpgradeStrategy

public class TomcatRequestUpgradeStrategy
extends StandardWebSocketUpgradeStrategy

A WebSocket RequestUpgradeStrategy for Apache Tomcat. Compatible with Tomcat 10 and higher, in particular with Tomcat 10.0 (not based on Jakarta WebSocket 2.1 yet).

To modify properties of the underlying ServerContainer you can use ServletServerContainerFactoryBean in XML configuration or, when using Java configuration, access the container instance through the "jakarta.websocket.server.ServerContainer" ServletContext attribute.

Since:

4.0

Author:

Rossen Stoyanchev, Juergen Hoeller

See Also:

• WsServerContainer.upgradeHttpToWebSocket(java.lang.Object, java.lang.Object, jakarta.websocket.server.ServerEndpointConfig, java.util.Map<java.lang.String, java.lang.String>)

Field Summary

Fields inherited from class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

logger

Constructor Summary

Constructors

Constructor	Description
TomcatRequestUpgradeStrategy()

Method Summary

Modifier and Type	Method	Description
protected void	upgradeHttpToWebSocket(HttpServletRequest request, HttpServletResponse response, ServerEndpointConfig endpointConfig, Map<String,String> pathParams)

Methods inherited from class org.springframework.web.socket.server.standard.StandardWebSocketUpgradeStrategy

getSupportedVersions, upgradeInternal

Methods inherited from class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

getContainer, getHttpServletRequest, getHttpServletResponse, getInstalledExtensions, getSupportedExtensions, upgrade

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TomcatRequestUpgradeStrategy

public TomcatRequestUpgradeStrategy()

Method Details

upgradeHttpToWebSocket

protected void upgradeHttpToWebSocket(HttpServletRequest request,
 HttpServletResponse response,
 ServerEndpointConfig endpointConfig,
 Map<String,String> pathParams)
                               throws Exception

Overrides:

upgradeHttpToWebSocket in class StandardWebSocketUpgradeStrategy

Throws:

Exception