Polish SockJS client

Author: rstoyanchev

spring-websocket/src/main/java/org/springframework/web/socket/sockjs/client/AbstractXhrTransport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -18,6 +18,7 @@
 
 import java.net.URI;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 
 import org.apache.commons.logging.Log;
@@ -66,7 +67,7 @@ public abstract class AbstractXhrTransport implements XhrTransport {
 	@Override
 	public List<TransportType> getTransportTypes() {
 		return (isXhrStreamingDisabled() ?
-				Arrays.asList(TransportType.XHR) :
+				Collections.singletonList(TransportType.XHR) :
 				Arrays.asList(TransportType.XHR_STREAMING, TransportType.XHR));
 	}
 
@@ -111,6 +112,35 @@ public HttpHeaders getRequestHeaders() {
 		return this.requestHeaders;
 	}
 
+
+	// Transport methods
+
+	@Override
+	public ListenableFuture<WebSocketSession> connect(TransportRequest request, WebSocketHandler handler) {
+		SettableListenableFuture<WebSocketSession> connectFuture = new SettableListenableFuture<WebSocketSession>();
+		XhrClientSockJsSession session = new XhrClientSockJsSession(request, handler, this, connectFuture);
+		request.addTimeoutTask(session.getTimeoutTask());
+
+		URI receiveUrl = request.getTransportUrl();
+		if (logger.isDebugEnabled()) {
+			logger.debug("Starting XHR " +
+					(isXhrStreamingDisabled() ? "Polling" : "Streaming") + "session url=" + receiveUrl);
+		}
+
+		HttpHeaders handshakeHeaders = new HttpHeaders();
+		handshakeHeaders.putAll(request.getHandshakeHeaders());
+		handshakeHeaders.putAll(getRequestHeaders());
+
+		connectInternal(request, handler, receiveUrl, handshakeHeaders, session, connectFuture);
+		return connectFuture;
+	}
+
+	protected abstract void connectInternal(TransportRequest request, WebSocketHandler handler,
+			URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session,
+			SettableListenableFuture<WebSocketSession> connectFuture);
+
+	// InfoReceiver methods
+
 	@Override
 	public String executeInfoRequest(URI infoUrl) {
 		if (logger.isDebugEnabled()) {
@@ -131,6 +161,8 @@ public String executeInfoRequest(URI infoUrl) {
 
 	protected abstract ResponseEntity<String> executeInfoRequestInternal(URI infoUrl);
 
+	// XhrTransport methods
+
 	@Override
 	public void executeSendRequest(URI url, TextMessage message) {
 		if (logger.isTraceEnabled()) {
@@ -150,30 +182,6 @@ public void executeSendRequest(URI url, TextMessage message) {
 
 	protected abstract ResponseEntity<String> executeSendRequestInternal(URI url, HttpHeaders headers, TextMessage message);
 
-	@Override
-	public ListenableFuture<WebSocketSession> connect(TransportRequest request, WebSocketHandler handler) {
-		SettableListenableFuture<WebSocketSession> connectFuture = new SettableListenableFuture<WebSocketSession>();
-		XhrClientSockJsSession session = new XhrClientSockJsSession(request, handler, this, connectFuture);
-		request.addTimeoutTask(session.getTimeoutTask());
-
-		URI receiveUrl = request.getTransportUrl();
-		if (logger.isDebugEnabled()) {
-			logger.debug("Starting XHR " +
-					(isXhrStreamingDisabled() ? "Polling" : "Streaming") + "session url=" + receiveUrl);
-		}
-
-		HttpHeaders handshakeHeaders = new HttpHeaders();
-		handshakeHeaders.putAll(request.getHandshakeHeaders());
-		handshakeHeaders.putAll(getRequestHeaders());
-
-		connectInternal(request, handler, receiveUrl, handshakeHeaders, session, connectFuture);
-		return connectFuture;
-	}
-
-	protected abstract void connectInternal(TransportRequest request, WebSocketHandler handler,
-			URI receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session,
-			SettableListenableFuture<WebSocketSession> connectFuture);
-
 
 	@Override
 	public String toString() {

spring-websocket/src/main/java/org/springframework/web/socket/sockjs/client/InfoReceiver.java

@@ -1,14 +1,33 @@
+/*
+ * Copyright 2002-2015 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.sockjs.client;
 
 import java.net.URI;
 
 /**
- * A simple contract for executing the SockJS "Info" request before the SockJS
- * session starts. The request is used to check server capabilities such as
- * whether it permits use of the WebSocket transport.
+ * A component that can execute the SockJS "Info" request that needs to be
+ * performed before the SockJS session starts in order to check server endpoint
+ * capabilities such as whether the endpoint permits use of WebSocket.
+ *
+ * <p>Typically {@link XhrTransport} implementations are also implementations
+ * of this contract.
  *
  * @author Rossen Stoyanchev
  * @since 4.1
+ * @see AbstractXhrTransport
  */
 public interface InfoReceiver {
 

spring-websocket/src/main/java/org/springframework/web/socket/sockjs/client/JettyXhrTransport.java

@@ -44,7 +44,6 @@
 import org.springframework.web.socket.sockjs.SockJsTransportFailureException;
 import org.springframework.web.socket.sockjs.frame.SockJsFrame;
 
-
 /**
  * An XHR transport based on Jetty's {@link org.eclipse.jetty.client.HttpClient}.
  *
@@ -105,6 +104,25 @@ public boolean isRunning() {
 		return this.httpClient.isRunning();
 	}
 
+
+	@Override
+	protected void connectInternal(TransportRequest request, WebSocketHandler handler,
+			URI url, HttpHeaders handshakeHeaders, XhrClientSockJsSession session,
+			SettableListenableFuture<WebSocketSession> connectFuture) {
+
+		SockJsResponseListener listener = new SockJsResponseListener(url, getRequestHeaders(), session, connectFuture);
+		executeReceiveRequest(url, handshakeHeaders, listener);
+	}
+
+	private void executeReceiveRequest(URI url, HttpHeaders headers, SockJsResponseListener listener) {
+		if (logger.isTraceEnabled()) {
+			logger.trace("Starting XHR receive request, url=" + url);
+		}
+		Request httpRequest = this.httpClient.newRequest(url).method(HttpMethod.POST);
+		addHttpHeaders(httpRequest, headers);
+		httpRequest.send(listener);
+	}
+
 	@Override
 	protected ResponseEntity<String> executeInfoRequestInternal(URI infoUrl) {
 		return executeRequest(infoUrl, HttpMethod.GET, getRequestHeaders(), null);
@@ -157,28 +175,11 @@ private static HttpHeaders toHttpHeaders(HttpFields httpFields) {
 		return responseHeaders;
 	}
 
-	@Override
-	protected void connectInternal(TransportRequest request, WebSocketHandler handler,
-			URI url, HttpHeaders handshakeHeaders, XhrClientSockJsSession session,
-			SettableListenableFuture<WebSocketSession> connectFuture) {
-
-		SockJsResponseListener listener = new SockJsResponseListener(url, getRequestHeaders(), session, connectFuture);
-		executeReceiveRequest(url, handshakeHeaders, listener);
-	}
-
-	private void executeReceiveRequest(URI url, HttpHeaders headers, SockJsResponseListener listener) {
-		if (logger.isTraceEnabled()) {
-			logger.trace("Starting XHR receive request, url=" + url);
-		}
-		Request httpRequest = this.httpClient.newRequest(url).method(HttpMethod.POST);
-		addHttpHeaders(httpRequest, headers);
-		httpRequest.send(listener);
-	}
-
 
 	/**
-	 * Splits the body of an HTTP response into SockJS frames and delegates those
-	 * to an {@link XhrClientSockJsSession}.
+	 * Jetty client {@link org.eclipse.jetty.client.api.Response.Listener Response
+	 * Listener} that splits the body of the response into SockJS frames and
+	 * delegates them to the {@link XhrClientSockJsSession}.
 	 */
 	private class SockJsResponseListener extends Response.Listener.Adapter {
 

spring-websocket/src/main/java/org/springframework/web/socket/sockjs/client/RestTemplateXhrTransport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -93,18 +93,6 @@ public TaskExecutor getTaskExecutor() {
 	}
 
 
-	@Override
-	public ResponseEntity<String> executeInfoRequestInternal(URI infoUrl) {
-		RequestCallback requestCallback = new XhrRequestCallback(getRequestHeaders());
-		return this.restTemplate.execute(infoUrl, HttpMethod.GET, requestCallback, textExtractor);
-	}
-
-	@Override
-	public ResponseEntity<String> executeSendRequestInternal(URI url, HttpHeaders headers, TextMessage message) {
-		RequestCallback requestCallback = new XhrRequestCallback(headers, message.getPayload());
-		return this.restTemplate.execute(url, HttpMethod.POST, requestCallback, textExtractor);
-	}
-
 	@Override
 	protected void connectInternal(final TransportRequest request, final WebSocketHandler handler,
 			final URI receiveUrl, final HttpHeaders handshakeHeaders, final XhrClientSockJsSession session,
@@ -143,11 +131,23 @@ public void run() {
 		});
 	}
 
+	@Override
+	public ResponseEntity<String> executeInfoRequestInternal(URI infoUrl) {
+		RequestCallback requestCallback = new XhrRequestCallback(getRequestHeaders());
+		return this.restTemplate.execute(infoUrl, HttpMethod.GET, requestCallback, textResponseExtractor);
+	}
+
+	@Override
+	public ResponseEntity<String> executeSendRequestInternal(URI url, HttpHeaders headers, TextMessage message) {
+		RequestCallback requestCallback = new XhrRequestCallback(headers, message.getPayload());
+		return this.restTemplate.execute(url, HttpMethod.POST, requestCallback, textResponseExtractor);
+	}
+
 
 	/**
 	 * A simple ResponseExtractor that reads the body into a String.
 	 */
-	private final static ResponseExtractor<ResponseEntity<String>> textExtractor =
+	private final static ResponseExtractor<ResponseEntity<String>> textResponseExtractor =
 			new ResponseExtractor<ResponseEntity<String>>() {
 				@Override
 				public ResponseEntity<String> extractData(ClientHttpResponse response) throws IOException {
@@ -161,7 +161,6 @@ public ResponseEntity<String> extractData(ClientHttpResponse response) throws IO
 				}
 			};
 
-
 	/**
 	 * A RequestCallback to add the headers and (optionally) String content.
 	 */
@@ -191,7 +190,6 @@ public void doWithRequest(ClientHttpRequest request) throws IOException {
 		}
 	}
 
-
 	/**
 	 * Splits the body of an HTTP response into SockJS frames and delegates those
 	 * to an {@link XhrClientSockJsSession}.

spring-websocket/src/main/java/org/springframework/web/socket/sockjs/client/SockJsUrlInfo.java

@@ -25,8 +25,9 @@
 import org.springframework.web.util.UriComponentsBuilder;
 
 /**
- * Given the base URL to a SockJS server endpoint, also provides methods to
- * generate and obtain session and a server id used for construct a transport URL.
+ * Container for the base URL of a SockJS endpoint with additional helper methods
+ * to derive related SockJS URLs as the {@link #getInfoUrl() info} URL and
+ * {@link #getTransportUrl(TransportType) transport} URLs.
  *
  * @author Rossen Stoyanchev
  * @since 4.1

spring-websocket/src/main/java/org/springframework/web/socket/sockjs/client/TransportRequest.java

@@ -1,15 +1,36 @@
+/*
+ * Copyright 2002-2015 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.sockjs.client;
 
 import java.net.URI;
 import java.security.Principal;
 
 import org.springframework.http.HttpHeaders;
+import org.springframework.web.socket.WebSocketHandler;
+import org.springframework.web.socket.WebSocketHttpHeaders;
 import org.springframework.web.socket.sockjs.frame.SockJsMessageCodec;
 
 /**
- * Represents a request to connect to a SockJS service using a specific
- * Transport. A single SockJS request however may require falling back
- * and therefore multiple TransportRequest instances.
+ * Exposes information, typically to {@link Transport} and
+ * {@link AbstractClientSockJsSession session} implementations, about a request
+ * to connect to a SockJS server endpoint over a given transport.
+ *
+ * <p>Note that a single request to connect via {@link SockJsClient} may result
+ * in multiple instances of {@link TransportRequest}, one for each transport
+ * before a connection is successfully established.
  *
  * @author Rossen Stoyanchev
  * @since 4.1