Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reuse StandardWebSocketUpgradeStrategy as a base class for Tomcat etc

Browse Source 
Includes non-reflective instantiation of well-known strategy classes.

See gh-29436
This commit is contained in:
Juergen Hoeller
2022-11-07 17:35:31 +01:00
parent 465575f8f2
commit a2ac764f9c
14 changed files with 379 additions and 382 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-websocket/src/main/java/org/springframework/web/socket/server/jetty/JettyRequestUpgradeStrategy.java
View File

@@ -49,7 +49,7 @@ import org.springframework.web.socket.server.RequestUpgradeStrategy;
*/
public class JettyRequestUpgradeStrategy implements RequestUpgradeStrategy {
private static final String[] SUPPORTED_VERSIONS = new String[] { String.valueOf(13) };
private static final String[] SUPPORTED_VERSIONS = new String[] {"13"};
@Override

8
spring-websocket/src/main/java/org/springframework/web/socket/server/standard/AbstractTyrusRequestUpgradeStrategy.java
View File

@@ -58,8 +58,6 @@ import static org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus.SUCCESS;
* A base class for {@code RequestUpgradeStrategy} implementations on top of
* JSR-356 based servers which include Tyrus as their WebSocket engine.
*
* <p>Works with Tyrus 1.11 (WebLogic 12.2.1) and Tyrus 1.12 (GlassFish 4.1.1).
*
* @author Rossen Stoyanchev
* @author Brian Clozel
* @author Juergen Hoeller
@@ -68,6 +66,10 @@ import static org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus.SUCCESS;
*/
public abstract class AbstractTyrusRequestUpgradeStrategy extends AbstractStandardUpgradeStrategy {
private static final String[] SUPPORTED_VERSIONS =
StringUtils.tokenizeToStringArray(Version.getSupportedWireProtocolVersions(), ",");
private static final Random random = new Random();
private static final Constructor<?> constructor;
@@ -111,7 +113,7 @@ public abstract class AbstractTyrusRequestUpgradeStrategy extends AbstractStanda
@Override
public String[] getSupportedVersions() {
return StringUtils.tokenizeToStringArray(Version.getSupportedWireProtocolVersions(), ",");
return SUPPORTED_VERSIONS;
}
@Override

21
spring-websocket/src/main/java/org/springframework/web/socket/server/standard/StandardWebSocketUpgradeStrategy.java
View File

@@ -24,6 +24,7 @@ import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.websocket.Endpoint;
import jakarta.websocket.Extension;
import jakarta.websocket.server.ServerEndpointConfig;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
@@ -33,24 +34,32 @@ import org.springframework.web.socket.server.HandshakeFailureException;
/**
* A WebSocket {@code RequestUpgradeStrategy} for the Jakarta WebSocket API 2.1+.
*
* <p>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.
*
* <p>To modify properties of the underlying {@link jakarta.websocket.server.ServerContainer}
* you can use {@link ServletServerContainerFactoryBean} in XML configuration or,
* when using Java configuration, access the container instance through the
* "jakarta.websocket.server.ServerContainer" ServletContext attribute.
*
* @author Juergen Hoeller
* @author Rossen Stoyanchev
* @since 6.0
* @see jakarta.websocket.server.ServerContainer#upgradeHttpToWebSocket
*/
public class StandardWebSocketUpgradeStrategy extends AbstractStandardUpgradeStrategy {
private static final String[] SUPPORTED_VERSIONS = new String[] {"13"};
@Override
public String[] getSupportedVersions() {
return new String[] {"13"};
return SUPPORTED_VERSIONS;
}
@Override
public void upgradeInternal(ServerHttpRequest request, ServerHttpResponse response,
protected void upgradeInternal(ServerHttpRequest request, ServerHttpResponse response,
@Nullable String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint)
throws HandshakeFailureException {
@@ -66,7 +75,7 @@ public class StandardWebSocketUpgradeStrategy extends AbstractStandardUpgradeStr
endpointConfig.setExtensions(selectedExtensions);
try {
getContainer(servletRequest).upgradeHttpToWebSocket(servletRequest, servletResponse, endpointConfig, pathParams);
upgradeHttpToWebSocket(servletRequest, servletResponse, endpointConfig, pathParams);
}
catch (Exception ex) {
throw new HandshakeFailureException(
@@ -74,4 +83,10 @@ public class StandardWebSocketUpgradeStrategy extends AbstractStandardUpgradeStr
}
}
protected void upgradeHttpToWebSocket(HttpServletRequest request, HttpServletResponse response,
ServerEndpointConfig endpointConfig, Map<String,String> pathParams) throws Exception {
getContainer(request).upgradeHttpToWebSocket(request, response, endpointConfig, pathParams);
}
}

54
spring-websocket/src/main/java/org/springframework/web/socket/server/standard/TomcatRequestUpgradeStrategy.java
View File

@@ -16,24 +16,16 @@
package org.springframework.web.socket.server.standard;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.websocket.Endpoint;
import jakarta.websocket.Extension;
import jakarta.websocket.server.ServerEndpointConfig;
import org.apache.tomcat.websocket.server.WsServerContainer;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.lang.Nullable;
import org.springframework.web.socket.server.HandshakeFailureException;
/**
* A WebSocket {@code RequestUpgradeStrategy} for Apache Tomcat. Compatible with
* Tomcat 10 and higher.
* A WebSocket {@code RequestUpgradeStrategy} for Apache Tomcat. Compatible with Tomcat 10
* and higher, in particular with Tomcat 10.0 (not based on Jakarta WebSocket 2.1 yet).
*
* <p>To modify properties of the underlying {@link jakarta.websocket.server.ServerContainer}
* you can use {@link ServletServerContainerFactoryBean} in XML configuration or,
@@ -41,44 +33,18 @@ import org.springframework.web.socket.server.HandshakeFailureException;
* "jakarta.websocket.server.ServerContainer" ServletContext attribute.
*
* @author Rossen Stoyanchev
* @author Juergen Hoeller
* @since 4.0
* @see WsServerContainer#upgradeHttpToWebSocket
* @see org.apache.tomcat.websocket.server.WsServerContainer#upgradeHttpToWebSocket
*/
public class TomcatRequestUpgradeStrategy extends AbstractStandardUpgradeStrategy {
public class TomcatRequestUpgradeStrategy extends StandardWebSocketUpgradeStrategy {
@Override
public String[] getSupportedVersions() {
return new String[] {"13"};
}
protected void upgradeHttpToWebSocket(HttpServletRequest request, HttpServletResponse response,
ServerEndpointConfig endpointConfig, Map<String, String> pathParams) throws Exception {
@Override
public void upgradeInternal(ServerHttpRequest request, ServerHttpResponse response,
@Nullable String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint)
throws HandshakeFailureException {
HttpServletRequest servletRequest = getHttpServletRequest(request);
HttpServletResponse servletResponse = getHttpServletResponse(response);
StringBuffer requestUrl = servletRequest.getRequestURL();
String path = servletRequest.getRequestURI(); // shouldn't matter
Map<String, String> pathParams = Collections.<String, String> emptyMap();
ServerEndpointRegistration endpointConfig = new ServerEndpointRegistration(path, endpoint);
endpointConfig.setSubprotocols(Collections.singletonList(selectedProtocol));
endpointConfig.setExtensions(selectedExtensions);
try {
getContainer(servletRequest).upgradeHttpToWebSocket(servletRequest, servletResponse, endpointConfig, pathParams);
}
catch (Exception ex) {
throw new HandshakeFailureException(
"Servlet request failed to upgrade to WebSocket: " + requestUrl, ex);
}
}
@Override
public WsServerContainer getContainer(HttpServletRequest request) {
return (WsServerContainer) super.getContainer(request);
((WsServerContainer) getContainer(request)).upgradeHttpToWebSocket(
request, response, endpointConfig, pathParams);
}
}

64
spring-websocket/src/main/java/org/springframework/web/socket/server/standard/UndertowRequestUpgradeStrategy.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -16,79 +16,41 @@
package org.springframework.web.socket.server.standard;
import java.io.IOException;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import io.undertow.websockets.core.WebSocketVersion;
import io.undertow.websockets.jsr.ServerWebSocketContainer;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.websocket.Endpoint;
import jakarta.websocket.Extension;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.lang.Nullable;
import org.springframework.web.socket.server.HandshakeFailureException;
import jakarta.websocket.server.ServerEndpointConfig;
/**
* A WebSocket {@code RequestUpgradeStrategy} for WildFly and its underlying
* Undertow web server. Also compatible with embedded Undertow usage.
*
* <p>Requires Undertow 1.3.5+ as of Spring Framework 5.0.
* <p>Designed for Undertow 2.2, also compatible with Undertow 2.3
* (which implements Jakarta WebSocket 2.1 as well).
*
* @author Rossen Stoyanchev
* @author Juergen Hoeller
* @since 4.0.1
* @see io.undertow.websockets.jsr.ServerWebSocketContainer#doUpgrade
*/
public class UndertowRequestUpgradeStrategy extends AbstractStandardUpgradeStrategy {
public class UndertowRequestUpgradeStrategy extends StandardWebSocketUpgradeStrategy {
private static final String[] VERSIONS = new String[] {
WebSocketVersion.V13.toHttpHeaderValue(),
WebSocketVersion.V08.toHttpHeaderValue(),
WebSocketVersion.V07.toHttpHeaderValue()
};
private static final String[] SUPPORTED_VERSIONS = new String[] {"13", "8", "7"};
@Override
public String[] getSupportedVersions() {
return VERSIONS;
return SUPPORTED_VERSIONS;
}
@Override
protected void upgradeInternal(ServerHttpRequest request, ServerHttpResponse response,
@Nullable String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint)
throws HandshakeFailureException {
protected void upgradeHttpToWebSocket(HttpServletRequest request, HttpServletResponse response,
ServerEndpointConfig endpointConfig, Map<String, String> pathParams) throws Exception {
HttpServletRequest servletRequest = getHttpServletRequest(request);
HttpServletResponse servletResponse = getHttpServletResponse(response);
StringBuffer requestUrl = servletRequest.getRequestURL();
String path = servletRequest.getRequestURI(); // shouldn't matter
Map<String, String> pathParams = Collections.emptyMap();
ServerEndpointRegistration endpointConfig = new ServerEndpointRegistration(path, endpoint);
endpointConfig.setSubprotocols(Collections.singletonList(selectedProtocol));
endpointConfig.setExtensions(selectedExtensions);
try {
getContainer(servletRequest).doUpgrade(servletRequest, servletResponse, endpointConfig, pathParams);
}
catch (ServletException ex) {
throw new HandshakeFailureException(
"Servlet request failed to upgrade to WebSocket: " + requestUrl, ex);
}
catch (IOException ex) {
throw new HandshakeFailureException(
"Response update failed during upgrade to WebSocket: " + requestUrl, ex);
}
}
@Override
public ServerWebSocketContainer getContainer(HttpServletRequest request) {
return (ServerWebSocketContainer) super.getContainer(request);
((ServerWebSocketContainer) getContainer(request)).doUpgrade(
request, response, endpointConfig, pathParams);
}
}

47
spring-websocket/src/main/java/org/springframework/web/socket/server/standard/WebSphereRequestUpgradeStrategy.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2021 the original author or authors.
* Copyright 2002-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,22 +17,13 @@
package org.springframework.web.socket.server.standard;
import java.lang.reflect.Method;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.websocket.Endpoint;
import jakarta.websocket.Extension;
import jakarta.websocket.server.ServerContainer;
import jakarta.websocket.server.ServerEndpointConfig;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.lang.Nullable;
import org.springframework.web.socket.server.HandshakeFailureException;
/**
* WebSphere support for upgrading an {@link HttpServletRequest} during a
* WebSocket handshake. To modify properties of the underlying
@@ -41,12 +32,11 @@ import org.springframework.web.socket.server.HandshakeFailureException;
* Java configuration, access the container instance through the
* "javax.websocket.server.ServerContainer" ServletContext attribute.
*
* <p>Tested with WAS Liberty beta (August 2015) for the upcoming 8.5.5.7 release.
*
* @author Rossen Stoyanchev
* @author Juergen Hoeller
* @since 4.2.1
*/
public class WebSphereRequestUpgradeStrategy extends AbstractStandardUpgradeStrategy {
public class WebSphereRequestUpgradeStrategy extends StandardWebSocketUpgradeStrategy {
private static final Method upgradeMethod;
@@ -64,34 +54,11 @@ public class WebSphereRequestUpgradeStrategy extends AbstractStandardUpgradeStra
@Override
public String[] getSupportedVersions() {
return new String[] {"13"};
}
protected void upgradeHttpToWebSocket(HttpServletRequest request, HttpServletResponse response,
ServerEndpointConfig endpointConfig, Map<String, String> pathParams) throws Exception {
@Override
public void upgradeInternal(ServerHttpRequest httpRequest, ServerHttpResponse httpResponse,
@Nullable String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint)
throws HandshakeFailureException {
HttpServletRequest request = getHttpServletRequest(httpRequest);
HttpServletResponse response = getHttpServletResponse(httpResponse);
StringBuffer requestUrl = request.getRequestURL();
String path = request.getRequestURI(); // shouldn't matter
Map<String, String> pathParams = Collections.<String, String> emptyMap();
ServerEndpointRegistration endpointConfig = new ServerEndpointRegistration(path, endpoint);
endpointConfig.setSubprotocols(Collections.singletonList(selectedProtocol));
endpointConfig.setExtensions(selectedExtensions);
try {
ServerContainer container = getContainer(request);
upgradeMethod.invoke(container, request, response, endpointConfig, pathParams);
}
catch (Exception ex) {
throw new HandshakeFailureException(
"Servlet request failed to upgrade to WebSocket for " + requestUrl, ex);
}
ServerContainer container = getContainer(request);
upgradeMethod.invoke(container, request, response, endpointConfig, pathParams);
}
}

84
spring-websocket/src/main/java/org/springframework/web/socket/server/support/AbstractHandshakeHandler.java
View File

@@ -37,7 +37,6 @@ import org.springframework.http.server.ServerHttpResponse;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.util.ReflectionUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.socket.SubProtocolCapable;
import org.springframework.web.socket.WebSocketExtension;
@@ -47,7 +46,13 @@ import org.springframework.web.socket.handler.WebSocketHandlerDecorator;
import org.springframework.web.socket.server.HandshakeFailureException;
import org.springframework.web.socket.server.HandshakeHandler;
import org.springframework.web.socket.server.RequestUpgradeStrategy;
import org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy;
import org.springframework.web.socket.server.standard.GlassFishRequestUpgradeStrategy;
import org.springframework.web.socket.server.standard.StandardWebSocketUpgradeStrategy;
import org.springframework.web.socket.server.standard.TomcatRequestUpgradeStrategy;
import org.springframework.web.socket.server.standard.UndertowRequestUpgradeStrategy;
import org.springframework.web.socket.server.standard.WebLogicRequestUpgradeStrategy;
import org.springframework.web.socket.server.standard.WebSphereRequestUpgradeStrategy;
/**
* A base class for {@link HandshakeHandler} implementations, independent of the Servlet API.
@@ -129,42 +134,6 @@ public abstract class AbstractHandshakeHandler implements HandshakeHandler, Life
}
private static RequestUpgradeStrategy initRequestUpgradeStrategy() {
String className;
if (tomcatWsPresent) {
className = "org.springframework.web.socket.server.standard.TomcatRequestUpgradeStrategy";
}
else if (jettyWsPresent) {
className = "org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy";
}
else if (undertowWsPresent) {
className = "org.springframework.web.socket.server.standard.UndertowRequestUpgradeStrategy";
}
else if (glassfishWsPresent) {
className = "org.springframework.web.socket.server.standard.GlassFishRequestUpgradeStrategy";
}
else if (weblogicWsPresent) {
className = "org.springframework.web.socket.server.standard.WebLogicRequestUpgradeStrategy";
}
else if (websphereWsPresent) {
className = "org.springframework.web.socket.server.standard.WebSphereRequestUpgradeStrategy";
}
else {
// Let's assume Jakarta WebSocket API 2.1+
return new StandardWebSocketUpgradeStrategy();
}
try {
Class<?> clazz = ClassUtils.forName(className, AbstractHandshakeHandler.class.getClassLoader());
return (RequestUpgradeStrategy) ReflectionUtils.accessibleConstructor(clazz).newInstance();
}
catch (Exception ex) {
throw new IllegalStateException(
"Failed to instantiate RequestUpgradeStrategy: " + className, ex);
}
}
/**
* Return the {@link RequestUpgradeStrategy} for WebSocket requests.
*/
@@ -425,4 +394,45 @@ public abstract class AbstractHandshakeHandler implements HandshakeHandler, Life
return request.getPrincipal();
}
private static RequestUpgradeStrategy initRequestUpgradeStrategy() {
if (tomcatWsPresent) {
return new TomcatRequestUpgradeStrategy();
}
else if (jettyWsPresent) {
return new JettyRequestUpgradeStrategy();
}
else if (undertowWsPresent) {
return new UndertowRequestUpgradeStrategy();
}
else if (glassfishWsPresent) {
return TyrusStrategyDelegate.forGlassFish();
}
else if (weblogicWsPresent) {
return TyrusStrategyDelegate.forWebLogic();
}
else if (websphereWsPresent) {
return new WebSphereRequestUpgradeStrategy();
}
else {
// Let's assume Jakarta WebSocket API 2.1+
return new StandardWebSocketUpgradeStrategy();
}
}
/**
* Inner class to avoid a reachable dependency on Tyrus API.
*/
private static class TyrusStrategyDelegate {
public static RequestUpgradeStrategy forGlassFish() {
return new GlassFishRequestUpgradeStrategy();
}
public static RequestUpgradeStrategy forWebLogic() {
return new WebLogicRequestUpgradeStrategy();
}
}
}