Add WebSocket integration tests w/ Java configuration

Issue: SPR-10835

spring-websocket/src/main/java/org/springframework/web/socket/server/config/SockJsServiceRegistration.java

@@ -24,6 +24,7 @@ import org.springframework.scheduling.TaskScheduler;
 import org.springframework.util.ObjectUtils;
 import org.springframework.web.socket.server.HandshakeInterceptor;
 import org.springframework.web.socket.sockjs.SockJsService;
+import org.springframework.web.socket.sockjs.transport.TransportHandler;
 import org.springframework.web.socket.sockjs.transport.handler.DefaultSockJsService;
 
 
@@ -53,7 +54,11 @@ public class SockJsServiceRegistration {
 
 	private Boolean webSocketEnabled;
 
-	private final List<HandshakeInterceptor> handshakeInterceptors = new ArrayList<HandshakeInterceptor>();
+	private final List<TransportHandler> transportHandlers = new ArrayList<TransportHandler>();
+
+	private final List<TransportHandler> transportHandlerOverrides = new ArrayList<TransportHandler>();
+
+	private final List<HandshakeInterceptor> interceptors = new ArrayList<HandshakeInterceptor>();
 
 
 	public SockJsServiceRegistration(TaskScheduler defaultTaskScheduler) {
@@ -66,10 +71,6 @@ public class SockJsServiceRegistration {
 		return this;
 	}
 
-	protected TaskScheduler getTaskScheduler() {
-		return this.taskScheduler;
-	}
-
 	/**
 	 * Transports which don't support cross-domain communication natively (e.g.
 	 * "eventsource", "htmlfile") rely on serving a simple page (using the
@@ -87,14 +88,6 @@ public class SockJsServiceRegistration {
 		return this;
 	}
 
-	/**
-	 * The URL to the SockJS JavaScript client library.
-	 * @see #setSockJsClientLibraryUrl(String)
-	 */
-	protected String getClientLibraryUrl() {
-		return this.clientLibraryUrl;
-	}
-
 	/**
 	 * Streaming transports save responses on the client side and don't free
 	 * memory used by delivered messages. Such transports need to recycle the
@@ -111,10 +104,6 @@ public class SockJsServiceRegistration {
 		return this;
 	}
 
-	protected Integer getStreamBytesLimit() {
-		return this.streamBytesLimit;
-	}
-
 	/**
 	 * Some load balancers do sticky sessions, but only if there is a "JSESSIONID"
 	 * cookie. Even if it is set to a dummy value, it doesn't matter since
@@ -127,14 +116,6 @@ public class SockJsServiceRegistration {
 		return this;
 	}
 
-	/**
-	 * Whether setting JSESSIONID cookie is necessary.
-	 * @see #setDummySessionCookieEnabled(boolean)
-	 */
-	protected Boolean getDummySessionCookieEnabled() {
-		return this.sessionCookieEnabled;
-	}
-
 	/**
 	 * The amount of time in milliseconds when the server has not sent any
 	 * messages and after which the server should send a heartbeat frame to the
@@ -147,10 +128,6 @@ public class SockJsServiceRegistration {
 		return this;
 	}
 
-	protected Long getHeartbeatTime() {
-		return this.heartbeatTime;
-	}
-
 	/**
 	 * The amount of time in milliseconds before a client is considered
 	 * disconnected after not having a receiving connection, i.e. an active
@@ -163,13 +140,6 @@ public class SockJsServiceRegistration {
 		return this;
 	}
 
-	/**
-	 * Return the amount of time in milliseconds before a client is considered disconnected.
-	 */
-	protected Long getDisconnectDelay() {
-		return this.disconnectDelay;
-	}
-
 	/**
 	 * The number of server-to-client messages that a session can cache while waiting for
 	 * the next HTTP polling request from the client. All HTTP transports use this
@@ -186,13 +156,6 @@ public class SockJsServiceRegistration {
 		return this;
 	}
 
-	/**
-	 * Return the size of the HTTP message cache.
-	 */
-	protected Integer getHttpMessageCacheSize() {
-		return this.httpMessageCacheSize;
-	}
-
 	/**
 	 * Some load balancers don't support WebSocket. This option can be used to
 	 * disable the WebSocket transport on the server side.
@@ -204,23 +167,27 @@ public class SockJsServiceRegistration {
 		return this;
 	}
 
-	/**
-	 * Whether WebSocket transport is enabled.
-	 * @see #setWebSocketsEnabled(boolean)
-	 */
-	protected Boolean getWebSocketEnabled() {
-		return this.webSocketEnabled;
-	}
-
-	public SockJsServiceRegistration setInterceptors(HandshakeInterceptor... interceptors) {
-		if (!ObjectUtils.isEmpty(interceptors)) {
-			this.handshakeInterceptors.addAll(Arrays.asList(interceptors));
+	public SockJsServiceRegistration setTransportHandlers(TransportHandler... handlers) {
+		this.transportHandlers.clear();
+		if (!ObjectUtils.isEmpty(handlers)) {
+			this.transportHandlers.addAll(Arrays.asList(handlers));
 		}
 		return this;
 	}
 
-	protected List<HandshakeInterceptor> getInterceptors() {
-		return this.handshakeInterceptors;
+	public SockJsServiceRegistration setTransportHandlerOverrides(TransportHandler... handlers) {
+		this.transportHandlerOverrides.clear();
+		if (!ObjectUtils.isEmpty(handlers)) {
+			this.transportHandlerOverrides.addAll(Arrays.asList(handlers));
+		}
+		return this;
+	}
+
+	public SockJsServiceRegistration setInterceptors(HandshakeInterceptor... interceptors) {
+		if (!ObjectUtils.isEmpty(interceptors)) {
+			this.interceptors.addAll(Arrays.asList(interceptors));
+		}
+		return this;
 	}
 
 	protected SockJsService getSockJsService(String[] sockJsPrefixes) {
@@ -228,33 +195,34 @@ public class SockJsServiceRegistration {
 		if (sockJsPrefixes != null) {
 			service.setValidSockJsPrefixes(sockJsPrefixes);
 		}
-		if (getClientLibraryUrl() != null) {
-			service.setSockJsClientLibraryUrl(getClientLibraryUrl());
+		if (this.clientLibraryUrl != null) {
+			service.setSockJsClientLibraryUrl(this.clientLibraryUrl);
 		}
-		if (getStreamBytesLimit() != null) {
-			service.setStreamBytesLimit(getStreamBytesLimit());
+		if (this.streamBytesLimit != null) {
+			service.setStreamBytesLimit(this.streamBytesLimit);
 		}
-		if (getDummySessionCookieEnabled() != null) {
-			service.setDummySessionCookieEnabled(getDummySessionCookieEnabled());
+		if (this.sessionCookieEnabled != null) {
+			service.setDummySessionCookieEnabled(this.sessionCookieEnabled);
 		}
-		if (getHeartbeatTime() != null) {
-			service.setHeartbeatTime(getHeartbeatTime());
+		if (this.heartbeatTime != null) {
+			service.setHeartbeatTime(this.heartbeatTime);
 		}
-		if (getDisconnectDelay() != null) {
-			service.setDisconnectDelay(getDisconnectDelay());
+		if (this.disconnectDelay != null) {
+			service.setDisconnectDelay(this.heartbeatTime);
 		}
-		if (getHttpMessageCacheSize() != null) {
-			service.setHttpMessageCacheSize(getHttpMessageCacheSize());
+		if (this.httpMessageCacheSize != null) {
+			service.setHttpMessageCacheSize(this.httpMessageCacheSize);
 		}
-		if (getWebSocketEnabled() != null) {
-			service.setWebSocketsEnabled(getWebSocketEnabled());
+		if (this.webSocketEnabled != null) {
+			service.setWebSocketsEnabled(this.webSocketEnabled);
 		}
-		service.setHandshakeInterceptors(getInterceptors());
+		service.setHandshakeInterceptors(this.interceptors);
 		return service;
 	}
 
-	protected DefaultSockJsService createSockJsService() {
-		return new DefaultSockJsService(getTaskScheduler());
+	private DefaultSockJsService createSockJsService() {
+		return new DefaultSockJsService(this.taskScheduler, this.transportHandlers,
+				this.transportHandlerOverrides.toArray(new TransportHandler[this.transportHandlerOverrides.size()]));
 	}
 
 }

spring-websocket/src/main/java/org/springframework/web/socket/server/config/WebSocketConfigurationSupport.java

@@ -32,8 +32,7 @@ public class WebSocketConfigurationSupport {
 
 	@Bean
 	public HandlerMapping webSocketHandlerMapping() {
-		WebSocketHandlerRegistry registry = new WebSocketHandlerRegistry();
-		registry.setDefaultTaskScheduler(sockJsTaskScheduler());
+		WebSocketHandlerRegistry registry = new WebSocketHandlerRegistry(defaultSockJsTaskScheduler());
 		registerWebSocketHandlers(registry);
 		return registry.getHandlerMapping();
 	}
@@ -41,11 +40,14 @@ public class WebSocketConfigurationSupport {
 	protected void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
 	}
 
+	/**
+	 * The default TaskScheduler to use if none is configured via
+	 * {@link SockJsServiceRegistration#setTaskScheduler()}
+	 */
 	@Bean
-	public ThreadPoolTaskScheduler sockJsTaskScheduler() {
+	public ThreadPoolTaskScheduler defaultSockJsTaskScheduler() {
 		ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
 		scheduler.setThreadNamePrefix("SockJS-");
-		scheduler.setPoolSize(10);
 		return scheduler;
 	}
 

spring-websocket/src/main/java/org/springframework/web/socket/server/config/WebSocketHandlerRegistration.java

@@ -48,11 +48,17 @@ public class WebSocketHandlerRegistration {
 
 	private final List<HandshakeInterceptor> interceptors = new ArrayList<HandshakeInterceptor>();
 
+	private HandshakeHandler handshakeHandler;
+
 	private SockJsServiceRegistration sockJsServiceRegistration;
 
-	private TaskScheduler defaultTaskScheduler;
+	private final TaskScheduler defaultTaskScheduler;
 
 
+	public WebSocketHandlerRegistration(TaskScheduler defaultTaskScheduler) {
+		this.defaultTaskScheduler = defaultTaskScheduler;
+	}
+
 	public WebSocketHandlerRegistration addHandler(WebSocketHandler handler, String... paths) {
 		Assert.notNull(handler);
 		Assert.notEmpty(paths);
@@ -60,67 +66,55 @@ public class WebSocketHandlerRegistration {
 		return this;
 	}
 
-	protected MultiValueMap<WebSocketHandler, String> getHandlerMap() {
-		return this.handlerMap;
+	public WebSocketHandlerRegistration setHandshakeHandler(HandshakeHandler handshakeHandler) {
+		this.handshakeHandler = handshakeHandler;
+		return this;
+	}
+
+	public HandshakeHandler getHandshakeHandler() {
+		return handshakeHandler;
 	}
 
 	public void addInterceptors(HandshakeInterceptor... interceptors) {
 		this.interceptors.addAll(Arrays.asList(interceptors));
 	}
 
-	protected List<HandshakeInterceptor> getInterceptors() {
-		return this.interceptors;
-	}
-
 	public SockJsServiceRegistration withSockJS() {
 		this.sockJsServiceRegistration = new SockJsServiceRegistration(this.defaultTaskScheduler);
 		this.sockJsServiceRegistration.setInterceptors(
-				getInterceptors().toArray(new HandshakeInterceptor[getInterceptors().size()]));
+				this.interceptors.toArray(new HandshakeInterceptor[this.interceptors.size()]));
 		return this.sockJsServiceRegistration;
 	}
 
-	protected SockJsServiceRegistration getSockJsServiceRegistration() {
-		return this.sockJsServiceRegistration;
-	}
-
-	protected void setDefaultTaskScheduler(TaskScheduler defaultTaskScheduler) {
-		this.defaultTaskScheduler = defaultTaskScheduler;
-	}
-
-	protected TaskScheduler getDefaultTaskScheduler() {
-		return this.defaultTaskScheduler;
-	}
-
-	protected MultiValueMap<HttpRequestHandler, String> getMappings() {
+	MultiValueMap<HttpRequestHandler, String> getMappings() {
 		MultiValueMap<HttpRequestHandler, String> mappings = new LinkedMultiValueMap<HttpRequestHandler, String>();
-		if (getSockJsServiceRegistration() == null) {
-			HandshakeHandler handshakeHandler = createHandshakeHandler();
-			for (WebSocketHandler handler : getHandlerMap().keySet()) {
-				for (String path : getHandlerMap().get(handler)) {
+		if (this.sockJsServiceRegistration == null) {
+			HandshakeHandler handshakeHandler = getOrCreateHandshakeHandler();
+			for (WebSocketHandler handler : this.handlerMap.keySet()) {
+				for (String path : this.handlerMap.get(handler)) {
 					WebSocketHttpRequestHandler httpHandler = new WebSocketHttpRequestHandler(handler, handshakeHandler);
-					httpHandler.setHandshakeInterceptors(getInterceptors());
+					httpHandler.setHandshakeInterceptors(this.interceptors);
 					mappings.add(httpHandler, path);
 				}
 			}
 		}
 		else {
-			SockJsService sockJsService = getSockJsServiceRegistration().getSockJsService(getAllPrefixes());
-			for (WebSocketHandler handler : getHandlerMap().keySet()) {
-				for (String path : getHandlerMap().get(handler)) {
+			SockJsService sockJsService = this.sockJsServiceRegistration.getSockJsService(getAllPrefixes());
+			for (WebSocketHandler handler : this.handlerMap.keySet()) {
+				for (String path : this.handlerMap.get(handler)) {
 					SockJsHttpRequestHandler httpHandler = new SockJsHttpRequestHandler(sockJsService, handler);
 					mappings.add(httpHandler, path.endsWith("/") ? path + "**" : path + "/**");
 				}
 			}
-
 		}
 		return mappings;
 	}
 
-	protected DefaultHandshakeHandler createHandshakeHandler() {
-		return new DefaultHandshakeHandler();
+	private HandshakeHandler getOrCreateHandshakeHandler() {
+		return (this.handshakeHandler != null) ? this.handshakeHandler : new DefaultHandshakeHandler();
 	}
 
-	protected final String[] getAllPrefixes() {
+	private final String[] getAllPrefixes() {
 		List<String> all = new ArrayList<String>();
 		for (List<String> prefixes: this.handlerMap.values()) {
 			all.addAll(prefixes);

spring-websocket/src/main/java/org/springframework/web/socket/server/config/WebSocketHandlerRegistry.java

@@ -22,6 +22,7 @@ import java.util.List;
 import java.util.Map;
 
 import org.springframework.scheduling.TaskScheduler;
+import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
 import org.springframework.util.MultiValueMap;
 import org.springframework.web.HttpRequestHandler;
 import org.springframework.web.servlet.HandlerMapping;
@@ -45,10 +46,13 @@ public class WebSocketHandlerRegistry {
 	private TaskScheduler defaultTaskScheduler;
 
 
+	public WebSocketHandlerRegistry(ThreadPoolTaskScheduler defaultSockJsTaskScheduler) {
+		this.defaultTaskScheduler = defaultSockJsTaskScheduler;
+	}
+
 	public WebSocketHandlerRegistration addHandler(WebSocketHandler wsHandler, String... paths) {
-		WebSocketHandlerRegistration r = new WebSocketHandlerRegistration();
+		WebSocketHandlerRegistration r = new WebSocketHandlerRegistration(this.defaultTaskScheduler);
 		r.addHandler(wsHandler, paths);
-		r.setDefaultTaskScheduler(this.defaultTaskScheduler);
 		this.registrations.add(r);
 		return r;
 	}
@@ -59,29 +63,16 @@ public class WebSocketHandlerRegistry {
 
 	/**
 	 * Specify the order to use for WebSocket {@link HandlerMapping} relative to other
-	 * handler mappings configured in the Spring MVC configuration. The default value is
-	 * 1.
+	 * handler mappings configured in the Spring MVC configuration. The default value is 1.
 	 */
 	public void setOrder(int order) {
 		this.order = order;
 	}
 
-	protected int getOrder() {
-		return this.order;
-	}
-
-	protected void setDefaultTaskScheduler(TaskScheduler defaultTaskScheduler) {
-		this.defaultTaskScheduler = defaultTaskScheduler;
-	}
-
-	protected TaskScheduler getDefaultTaskScheduler() {
-		return this.defaultTaskScheduler;
-	}
-
 	/**
 	 * Returns a handler mapping with the mapped ViewControllers; or {@code null} in case of no registrations.
 	 */
-	protected AbstractHandlerMapping getHandlerMapping() {
+	AbstractHandlerMapping getHandlerMapping() {
 		Map<String, Object> urlMap = new LinkedHashMap<String, Object>();
 		for (WebSocketHandlerRegistration registration : this.registrations) {
 			MultiValueMap<HttpRequestHandler, String> mappings = registration.getMappings();