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

Class UndertowRequestUpgradeStrategy

java.lang.Object

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

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

org.springframework.web.socket.server.standard.UndertowRequestUpgradeStrategy

All Implemented Interfaces:

RequestUpgradeStrategy

public class UndertowRequestUpgradeStrategy
extends StandardWebSocketUpgradeStrategy

A WebSocket RequestUpgradeStrategy for WildFly and its underlying Undertow web server. Also compatible with embedded Undertow usage.

Designed for Undertow 2.2, also compatible with Undertow 2.3 (which implements Jakarta WebSocket 2.1 as well).

Since:

4.0.1

Author:

Rossen Stoyanchev, Juergen Hoeller

See Also:

• ServerWebSocketContainer.doUpgrade(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, 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
UndertowRequestUpgradeStrategy()

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)

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

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

UndertowRequestUpgradeStrategy

public UndertowRequestUpgradeStrategy()

Method Details

getSupportedVersions

public String[] getSupportedVersions()

Description copied from interface: RequestUpgradeStrategy

Return the supported WebSocket protocol versions.

Specified by:

getSupportedVersions in interface RequestUpgradeStrategy

Overrides:

getSupportedVersions in class StandardWebSocketUpgradeStrategy

upgradeHttpToWebSocket

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

Overrides:

upgradeHttpToWebSocket in class StandardWebSocketUpgradeStrategy

Throws:

Exception