Add MultiProtocolWebSocketHandler

It makes it possible to deploy multiple WebSocketHandler's to a URL,
each supporting a different sub-protocol.

Issue: SPR-10786

spring-websocket/src/test/java/org/springframework/web/socket/client/WebSocketConnectionManagerTests.java

@@ -51,7 +51,7 @@ public class WebSocketConnectionManagerTests {
 		WebSocketHandler handler = new WebSocketHandlerAdapter();
 
 		WebSocketConnectionManager manager = new WebSocketConnectionManager(client, handler , "/path/{id}", "123");
-		manager.setSubProtocols(subprotocols);
+		manager.setSupportedProtocols(subprotocols);
 		manager.openConnection();
 
 		ArgumentCaptor<WebSocketHandlerDecorator> captor = ArgumentCaptor.forClass(WebSocketHandlerDecorator.class);

spring-websocket/src/test/java/org/springframework/web/socket/server/DefaultHandshakeHandlerTests.java

@@ -0,0 +1,71 @@
+/*
+ * 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.server;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.springframework.web.socket.AbstractHttpRequestTests;
+import org.springframework.web.socket.WebSocketHandler;
+import org.springframework.web.socket.adapter.TextWebSocketHandlerAdapter;
+
+import static org.mockito.Mockito.*;
+
+
+/**
+ * Test fixture for {@link DefaultHandshakeHandler}.
+ *
+ * @author Rossen Stoyanchev
+ */
+public class DefaultHandshakeHandlerTests extends AbstractHttpRequestTests {
+
+	private DefaultHandshakeHandler handshakeHandler;
+
+	@Mock
+	private RequestUpgradeStrategy upgradeStrategy;
+
+
+	@Before
+	public void setup() throws Exception {
+		MockitoAnnotations.initMocks(this);
+		this.handshakeHandler = new DefaultHandshakeHandler(this.upgradeStrategy);
+	}
+
+
+	@Test
+	public void selectSubProtocol() throws Exception {
+
+		this.handshakeHandler.setSupportedProtocols("stomp", "mqtt");
+
+		when(this.upgradeStrategy.getSupportedVersions()).thenReturn(new String[] { "13" });
+
+		this.servletRequest.setMethod("GET");
+		this.request.getHeaders().setUpgrade("WebSocket");
+		this.request.getHeaders().setConnection("Upgrade");
+		this.request.getHeaders().setSecWebSocketVersion("13");
+		this.request.getHeaders().setSecWebSocketKey("82/ZS2YHjEnUN97HLL8tbw==");
+		this.request.getHeaders().setSecWebSocketProtocol("STOMP");
+
+		WebSocketHandler handler = new TextWebSocketHandlerAdapter();
+
+		this.handshakeHandler.doHandshake(this.request, this.response, handler);
+
+		verify(this.upgradeStrategy).upgrade(request, response, "STOMP", handler);
+	}
+
+}

spring-websocket/src/test/java/org/springframework/web/socket/sockjs/TestSockJsSession.java

@@ -40,11 +40,23 @@ public class TestSockJsSession extends AbstractSockJsSession {
 
 	private boolean cancelledHeartbeat;
 
+	private String subProtocol;
+
 
 	public TestSockJsSession(String sessionId, SockJsConfiguration config, WebSocketHandler handler) {
 		super(sessionId, config, handler);
 	}
 
+	@Override
+	public String getAcceptedProtocol() {
+		return this.subProtocol;
+	}
+
+	@Override
+	public void setAcceptedProtocol(String protocol) {
+		this.subProtocol = protocol;
+	}
+
 	public CloseStatus getStatus() {
 		return this.status;
 	}

spring-websocket/src/test/java/org/springframework/web/socket/support/MultiProtocolWebSocketHandlerTests.java

@@ -0,0 +1,106 @@
+/*
+ * 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 CONDITIOsNS 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.support;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.springframework.web.socket.WebSocketHandler;
+
+import static org.mockito.Mockito.*;
+
+
+/**
+ * Test fixture for {@link MultiProtocolWebSocketHandler}.
+ *
+ * @author Rossen Stoyanchev
+ */
+public class MultiProtocolWebSocketHandlerTests {
+
+	private MultiProtocolWebSocketHandler multiProtocolHandler;
+
+	@Mock
+	WebSocketHandler stompHandler;
+
+	@Mock
+	WebSocketHandler mqttHandler;
+
+	@Mock
+	WebSocketHandler defaultHandler;
+
+
+	@Before
+	public void setup() {
+
+		MockitoAnnotations.initMocks(this);
+
+		Map<String, WebSocketHandler> handlers = new HashMap<String, WebSocketHandler>();
+		handlers.put("STOMP", this.stompHandler);
+		handlers.put("MQTT", this.mqttHandler);
+
+		this.multiProtocolHandler = new MultiProtocolWebSocketHandler();
+		this.multiProtocolHandler.setProtocolHandlers(handlers);
+		this.multiProtocolHandler.setDefaultProtocolHandler(this.defaultHandler);
+	}
+
+
+	@Test
+	public void subProtocol() throws Exception {
+
+		TestWebSocketSession session = new TestWebSocketSession();
+		session.setAcceptedProtocol("sToMp");
+
+		this.multiProtocolHandler.afterConnectionEstablished(session);
+
+		verify(this.stompHandler).afterConnectionEstablished(session);
+		verifyZeroInteractions(this.mqttHandler);
+	}
+
+	@Test(expected=IllegalStateException.class)
+	public void subProtocolNoMatch() throws Exception {
+
+		TestWebSocketSession session = new TestWebSocketSession();
+		session.setAcceptedProtocol("wamp");
+
+		this.multiProtocolHandler.afterConnectionEstablished(session);
+	}
+
+	@Test
+	public void noSubProtocol() throws Exception {
+
+		TestWebSocketSession session = new TestWebSocketSession();
+
+		this.multiProtocolHandler.afterConnectionEstablished(session);
+
+		verify(this.defaultHandler).afterConnectionEstablished(session);
+		verifyZeroInteractions(this.stompHandler, this.mqttHandler);
+	}
+
+	@Test(expected=IllegalStateException.class)
+	public void noSubProtocolNoDefaultHandler() throws Exception {
+
+		TestWebSocketSession session = new TestWebSocketSession();
+
+		this.multiProtocolHandler.setDefaultProtocolHandler(null);
+		this.multiProtocolHandler.afterConnectionEstablished(session);
+	}
+
+}

spring-websocket/src/test/java/org/springframework/web/socket/support/TestWebSocketSession.java

@@ -45,6 +45,8 @@ public class TestWebSocketSession implements WebSocketSession {
 
 	private String remoteAddress;
 
+	private String protocol;
+
 	private boolean open;
 
 	private final List<WebSocketMessage<?>> messages = new ArrayList<>();
@@ -142,6 +144,20 @@ public class TestWebSocketSession implements WebSocketSession {
 		this.remoteAddress = remoteAddress;
 	}
 
+	/**
+	 * @return the subProtocol
+	 */
+	public String getAcceptedProtocol() {
+		return this.protocol;
+	}
+
+	/**
+	 * @param protocol the subProtocol to set
+	 */
+	public void setAcceptedProtocol(String protocol) {
+		this.protocol = protocol;
+	}
+
 	/**
 	 * @return the open
 	 */