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

Introduce SubProtocolHandler abstraction

Browse Source 
Add SubProtocolHandler to encapsulate the logic for using a
sub-protocol.

A SubProtocolWebSocketHandler is also provided to
delegate to the appropriate SubProtocolHandler based on the
negotiated sub-protocol value at handshake.

StompSubProtocolHandler provides handling for STOMP messages.

Issue: SPR-10786
This commit is contained in:
Andy Wilkinson
2013-07-30 11:29:57 +01:00
committed by Rossen Stoyanchev
parent e4d83bbefe
commit 9e20a25607
10 changed files with 532 additions and 341 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -20,12 +20,12 @@ package org.springframework.web.socket;
* A handler for WebSocket messages and lifecycle events.
*
* <p>Implementations of this interface are encouraged to handle exceptions locally where
* it makes sense or alternatively let the exception bubble up in which case the exception
* is logged and the session closed with
* {@link CloseStatus#SERVER_ERROR SERVER_ERROR(1011)} by default. The exception handling
* it makes sense or alternatively let the exception bubble up in which case by default
* 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
* ExceptionWebSocketHandlerDecorator}, which can be customized or replaced by decorating
* ExceptionWebSocketHandlerDecorator} and it can be customized or replaced by decorating
* the {@link WebSocketHandler} with a different decorator.
*
* @author Rossen Stoyanchev
@@ -61,6 +61,7 @@ public interface WebSocketHandler {
* transport error has occurred. Although the session may technically still be open,
* depending on the underlying implementation, sending messages at this point is
* discouraged and most likely will not succeed.
*
* @throws Exception this method can handle or propagate exceptions; see class-level
* Javadoc for details.
*/

125
spring-websocket/src/main/java/org/springframework/web/socket/support/MultiProtocolWebSocketHandler.java
View File

@@ -1,125 +0,0 @@
/*
* 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.support;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.springframework.util.Assert;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;
/**
* A {@link WebSocketHandler} that delegates to other {@link WebSocketHandler} instances
* based on the sub-protocol value accepted at the handshake. A default handler can also
* be configured for use by default when a sub-protocol value if the WebSocket session
* does not have a sub-protocol value associated with it.
*
* @author Rossen Stoyanchev
* @since 4.0
*/
public class MultiProtocolWebSocketHandler implements WebSocketHandler {
private WebSocketHandler defaultHandler;
private Map<String, WebSocketHandler> handlers = new HashMap<String, WebSocketHandler>();
/**
* Configure {@link WebSocketHandler}'s to use by sub-protocol. The values for
* sub-protocols are case insensitive.
*/
public void setProtocolHandlers(Map<String, WebSocketHandler> protocolHandlers) {
this.handlers.clear();
for (String protocol : protocolHandlers.keySet()) {
this.handlers.put(protocol.toLowerCase(), protocolHandlers.get(protocol));
}
}
/**
* Return a read-only copy of the sub-protocol handler map.
*/
public Map<String, WebSocketHandler> getProtocolHandlers() {
return Collections.unmodifiableMap(this.handlers);
}
/**
* Set the default {@link WebSocketHandler} to use if a sub-protocol was not
* requested.
*/
public void setDefaultProtocolHandler(WebSocketHandler defaultHandler) {
this.defaultHandler = defaultHandler;
}
/**
* Return the default {@link WebSocketHandler} to be used.
*/
public WebSocketHandler getDefaultProtocolHandler() {
return this.defaultHandler;
}
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
WebSocketHandler handler = getHandlerForSession(session);
handler.afterConnectionEstablished(session);
}
private WebSocketHandler getHandlerForSession(WebSocketSession session) {
WebSocketHandler handler = null;
String protocol = session.getAcceptedProtocol();
if (protocol != null) {
handler = this.handlers.get(protocol.toLowerCase());
Assert.state(handler != null,
"No WebSocketHandler for sub-protocol '" + protocol + "', handlers=" + this.handlers);
}
else {
handler = this.defaultHandler;
Assert.state(handler != null,
"No sub-protocol was requested and no default WebSocketHandler was configured");
}
return handler;
}
@Override
public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
WebSocketHandler handler = getHandlerForSession(session);
handler.handleMessage(session, message);
}
@Override
public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
WebSocketHandler handler = getHandlerForSession(session);
handler.handleTransportError(session, exception);
}
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
WebSocketHandler handler = getHandlerForSession(session);
handler.afterConnectionClosed(session, closeStatus);
}
@Override
public boolean supportsPartialMessages() {
return false;
}
}

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

@@ -1,106 +0,0 @@
/*
* 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);
}
}