Consistent ".jetty" and ".standard" subpackages; consolidated GlassFishRequestUpgradeStrategy implementation; renamed Text/BinaryWebSocketHandler and moved them to web.socket.support

Author: jhoeller

spring-websocket/src/main/java/org/springframework/web/socket/server/support/GlassFishRequestUpgradeStrategy.java renamed to spring-websocket/src/main/java/org/springframework/web/socket/SubProtocolCapable.java

@@ -14,25 +14,23 @@
  * limitations under the License.
  */
 
-package org.springframework.web.socket.server.support;
+package org.springframework.web.socket;
 
-import org.glassfish.tyrus.core.EndpointWrapper;
-import org.glassfish.tyrus.core.TyrusEndpoint;
-import org.glassfish.tyrus.websockets.WebSocketApplication;
+import java.util.List;
 
 /**
- * Extension of the {@link AbstractGlassFishRequestUpgradeStrategy} that provides support
- * for GlassFish 4.0.1 and beyond.
+ * An interface for WebSocket handlers that support sub-protocols as defined in RFC 6455.
  *
  * @author Rossen Stoyanchev
- * @author Michael Irwin
  * @since 4.0
+ * @see WebSocketHandler
+ * @see <a href="http://tools.ietf.org/html/rfc6455#section-1.9">RFC-6455 section 1.9</a>
  */
-public class GlassFishRequestUpgradeStrategy extends AbstractGlassFishRequestUpgradeStrategy {
+public interface SubProtocolCapable {
 
-	@Override
-	protected WebSocketApplication createTyrusEndpoint(EndpointWrapper endpoint) {
-		return new TyrusEndpoint(endpoint);
-	}
+	/**
+	 * Return the list of supported sub-protocols.
+	 */
+	List<String> getSubProtocols();
 
 }

spring-websocket/src/main/java/org/springframework/web/socket/WebSocketExtension.java

@@ -23,9 +23,6 @@
 import java.util.Locale;
 import java.util.Map;
 
-import javax.websocket.Extension;
-
-import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
 import org.springframework.util.Assert;
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.LinkedCaseInsensitiveMap;
@@ -177,64 +174,4 @@ public String toString() {
 		return str.toString();
 	}
 
-
-	// Standard WebSocketExtension adapters
-
-	public static class StandardToWebSocketExtensionAdapter extends WebSocketExtension {
-
-		public StandardToWebSocketExtensionAdapter(Extension ext) {
-			super(ext.getName());
-			for (Extension.Parameter p : ext.getParameters()) {
-				super.getParameters().put(p.getName(), p.getValue());
-			}
-		}
-	}
-
-	public static class WebSocketToStandardExtensionAdapter implements Extension {
-
-		private final String name;
-
-		private final List<Parameter> parameters = new ArrayList<Parameter>();
-
-		public WebSocketToStandardExtensionAdapter(final WebSocketExtension ext) {
-			this.name = ext.getName();
-			for (final String paramName : ext.getParameters().keySet()) {
-				this.parameters.add(new Parameter() {
-					@Override
-					public String getName() {
-						return paramName;
-					}
-					@Override
-					public String getValue() {
-						return ext.getParameters().get(paramName);
-					}
-				});
-			}
-		}
-
-		@Override
-		public String getName() {
-			return name;
-		}
-
-		@Override
-		public List<Parameter> getParameters() {
-			return this.parameters;
-		}
-	}
-
-	// Jetty WebSocketExtension adapters
-
-	public static class WebSocketToJettyExtensionConfigAdapter extends ExtensionConfig {
-
-		public WebSocketToJettyExtensionConfigAdapter(WebSocketExtension extension) {
-			super(extension.getName());
-			for (Map.Entry<String,String> p : extension.getParameters().entrySet()) {
-				super.setParameter(p.getKey(), p.getValue());
-			}
-		}
-	}
-
-
-
 }

spring-websocket/src/main/java/org/springframework/web/socket/WebSocketHandler.java

@@ -24,7 +24,7 @@
  * the exception is logged and the session closed with
  * {@link CloseStatus#SERVER_ERROR SERVER_ERROR(1011)}. The exception handling
  * strategy is provided by
- * {@link org.springframework.web.socket.support.ExceptionWebSocketHandlerDecorator
+ * {@link org.springframework.web.socket.handler.ExceptionWebSocketHandlerDecorator
  * ExceptionWebSocketHandlerDecorator} and it can be customized or replaced by decorating
  * the {@link WebSocketHandler} with a different decorator.
  *

spring-websocket/src/main/java/org/springframework/web/socket/support/WebSocketHttpHeaders.java renamed to spring-websocket/src/main/java/org/springframework/web/socket/WebSocketHttpHeaders.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.web.socket.support;
+package org.springframework.web.socket;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -25,7 +25,6 @@
 
 import org.springframework.http.HttpHeaders;
 import org.springframework.util.CollectionUtils;
-import org.springframework.web.socket.WebSocketExtension;
 
 /**
  * An {@link org.springframework.http.HttpHeaders} variant that adds support for
@@ -36,8 +35,6 @@
  */
 public class WebSocketHttpHeaders extends HttpHeaders {
 
-	private static final long serialVersionUID = -6644521016187828916L;
-
 	public static final String SEC_WEBSOCKET_ACCEPT = "Sec-WebSocket-Accept";
 
 	public static final String SEC_WEBSOCKET_EXTENSIONS = "Sec-WebSocket-Extensions";
@@ -48,6 +45,9 @@ public class WebSocketHttpHeaders extends HttpHeaders {
 
 	public static final String SEC_WEBSOCKET_VERSION = "Sec-WebSocket-Version";
 
+	private static final long serialVersionUID = -6644521016187828916L;
+
+
 	private final HttpHeaders headers;
 
 

spring-websocket/src/main/java/org/springframework/web/socket/adapter/AbstractWebSocketSesssion.java renamed to spring-websocket/src/main/java/org/springframework/web/socket/adapter/AbstractWebSocketSession.java

@@ -1,4 +1,5 @@
 /*
+ * Copyright 2002-2013 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.
@@ -20,6 +21,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+
 import org.springframework.util.Assert;
 import org.springframework.web.socket.BinaryMessage;
 import org.springframework.web.socket.CloseStatus;
@@ -35,7 +37,7 @@
  * @author Rossen Stoyanchev
  * @since 4.0
  */
-public abstract class AbstractWebSocketSesssion<T> implements WebSocketSession, NativeWebSocketSession {
+public abstract class AbstractWebSocketSession<T> implements NativeWebSocketSession {
 
 	protected final Log logger = LogFactory.getLog(getClass());
 
@@ -49,7 +51,7 @@ public abstract class AbstractWebSocketSesssion<T> implements WebSocketSession,
 	 * @param handshakeAttributes attributes from the HTTP handshake to make available
 	 * through the WebSocket session
 	 */
-	public AbstractWebSocketSesssion(Map<String, Object> handshakeAttributes) {
+	public AbstractWebSocketSession(Map<String, Object> handshakeAttributes) {
 		this.handshakeAttributes = handshakeAttributes;
 	}
 

spring-websocket/src/main/java/org/springframework/web/socket/adapter/JettyWebSocketHandlerAdapter.java renamed to spring-websocket/src/main/java/org/springframework/web/socket/adapter/jetty/JettyWebSocketHandlerAdapter.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.web.socket.adapter;
+package org.springframework.web.socket.adapter.jetty;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -33,7 +33,7 @@
 import org.springframework.web.socket.PongMessage;
 import org.springframework.web.socket.TextMessage;
 import org.springframework.web.socket.WebSocketHandler;
-import org.springframework.web.socket.support.ExceptionWebSocketHandlerDecorator;
+import org.springframework.web.socket.handler.ExceptionWebSocketHandlerDecorator;
 
 /**
  * Adapts {@link WebSocketHandler} to the Jetty 9 WebSocket API.
@@ -52,10 +52,8 @@ public class JettyWebSocketHandlerAdapter {
 
 
 	public JettyWebSocketHandlerAdapter(WebSocketHandler webSocketHandler, JettyWebSocketSession wsSession) {
-
 		Assert.notNull(webSocketHandler, "webSocketHandler must not be null");
 		Assert.notNull(wsSession, "wsSession must not be null");
-
 		this.webSocketHandler = webSocketHandler;
 		this.wsSession = wsSession;
 	}

spring-websocket/src/main/java/org/springframework/web/socket/adapter/JettyWebSocketSession.java renamed to spring-websocket/src/main/java/org/springframework/web/socket/adapter/jetty/JettyWebSocketSession.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.web.socket.adapter;
+package org.springframework.web.socket.adapter.jetty;
 
 import java.io.IOException;
 import java.net.InetSocketAddress;
@@ -24,6 +24,7 @@
 import java.util.List;
 import java.util.Map;
 
+import org.eclipse.jetty.websocket.api.Session;
 import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
 import org.springframework.http.HttpHeaders;
 import org.springframework.util.ObjectUtils;
@@ -34,6 +35,7 @@
 import org.springframework.web.socket.TextMessage;
 import org.springframework.web.socket.WebSocketExtension;
 import org.springframework.web.socket.WebSocketSession;
+import org.springframework.web.socket.adapter.AbstractWebSocketSession;
 
 /**
  * A {@link WebSocketSession} for use with the Jetty 9 WebSocket API.
@@ -42,7 +44,7 @@
  * @author Rossen Stoyanchev
  * @since 4.0
  */
-public class JettyWebSocketSession extends AbstractWebSocketSesssion<org.eclipse.jetty.websocket.api.Session> {
+public class JettyWebSocketSession extends AbstractWebSocketSession<Session> {
 
 	private HttpHeaders headers;
 

spring-websocket/src/main/java/org/springframework/web/socket/adapter/jetty/WebSocketToJettyExtensionConfigAdapter.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2002-2013 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.web.socket.adapter.jetty;
+
+import java.util.Map;
+
+import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
+
+import org.springframework.web.socket.WebSocketExtension;
+
+/**
+ * @author Rossen Stoyanchev
+ * @since 4.0
+ */
+public class WebSocketToJettyExtensionConfigAdapter extends ExtensionConfig {
+
+	public WebSocketToJettyExtensionConfigAdapter(WebSocketExtension extension) {
+		super(extension.getName());
+		for (Map.Entry<String,String> p : extension.getParameters().entrySet()) {
+			super.setParameter(p.getKey(), p.getValue());
+		}
+	}
+}

spring-websocket/src/main/java/org/springframework/web/socket/adapter/jetty/package-info.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2002-2013 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Adapter classes for the Jetty WebSocket API.
+ */
+package org.springframework.web.socket.adapter.jetty;
+

spring-websocket/src/main/java/org/springframework/web/socket/adapter/package-info.java

@@ -15,9 +15,7 @@
  */
 
 /**
- * Classes adapting Spring's WebSocket API classes to and from WebSocket
- * implementations. Also contains convenient base classes for
- * {@link org.springframework.web.socket.WebSocketHandler} implementations.
+ * Classes adapting Spring's WebSocket API to and from WebSocket providers.
  */
 package org.springframework.web.socket.adapter;