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

Class StandardWebSocketUpgradeStrategy

java.lang.Object

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

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

All Implemented Interfaces:

RequestUpgradeStrategy

Direct Known Subclasses:

TomcatRequestUpgradeStrategy, UndertowRequestUpgradeStrategy, WebSphereRequestUpgradeStrategy

public class StandardWebSocketUpgradeStrategy
extends AbstractStandardUpgradeStrategy

A WebSocket RequestUpgradeStrategy for the Jakarta WebSocket API 2.1+.

This strategy serves as a fallback if no specific server has been detected. It can also be used with Jakarta EE 10 level servers such as Tomcat 10.1 and Undertow 2.3 directly, relying on their built-in Jakarta WebSocket 2.1 support.

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:

6.0

Author:

Juergen Hoeller, Rossen Stoyanchev

See Also:

• ServerContainer.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
StandardWebSocketUpgradeStrategy()

Method Summary

Modifier and Type	Method	Description
String[]	getSupportedVersions()	Return the supported WebSocket protocol versions.
protected void	upgradeHttpToWebSocket(HttpServletRequest request, HttpServletResponse response, ServerEndpointConfig endpointConfig, Map<String,String> pathParams)
protected void	upgradeInternal(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint)

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

StandardWebSocketUpgradeStrategy

public StandardWebSocketUpgradeStrategy()

Method Details

getSupportedVersions

public String[] getSupportedVersions()

Description copied from interface: RequestUpgradeStrategy

Return the supported WebSocket protocol versions.

upgradeInternal

protected void upgradeInternal(ServerHttpRequest request,
 ServerHttpResponse response,
 @Nullable
 String selectedProtocol,
 List<Extension> selectedExtensions,
 Endpoint endpoint)
                        throws HandshakeFailureException

Specified by:

upgradeInternal in class AbstractStandardUpgradeStrategy

Throws:

HandshakeFailureException

upgradeHttpToWebSocket

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

Throws:

Exception