Use a SocketFactory to support reconnecting

marci4 · marci4 · commit 95e0a50b1eaf · 2018-09-10T19:32:30.000+02:00
Fixes TooTallNate#764
diff --git a/.gitignore b/.gitignore
@@ -16,6 +16,5 @@ bin
 /doc
 *.xml
 .idea/.name
-*.jks
 lib/junit-4.7.jar
 *.jar
diff --git a/src/main/example/SSLClientExample.java b/src/main/example/SSLClientExample.java
@@ -104,7 +104,7 @@ public static void main( String[] args ) throws Exception {
 
 		SSLSocketFactory factory = sslContext.getSocketFactory();// (SSLSocketFactory) SSLSocketFactory.getDefault();
 
-		chatclient.setSocket( factory.createSocket() );
+		chatclient.setSocketFactory( factory );
 
 		chatclient.connectBlocking();
 
diff --git a/src/main/java/org/java_websocket/client/WebSocketClient.java b/src/main/java/org/java_websocket/client/WebSocketClient.java
@@ -40,6 +40,7 @@
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
+import javax.net.SocketFactory;
 import javax.net.ssl.SSLContext;
 import javax.net.ssl.SSLException;
 import javax.net.ssl.SSLSocketFactory;
@@ -79,6 +80,12 @@ public abstract class WebSocketClient extends AbstractWebSocket implements Runna
 	 */
 	private Socket socket = null;
 
+	/**
+	 * The SocketFactory for this WebSocketClient
+	 * @since 1.4.0
+	 */
+	private SocketFactory socketFactory = null;
+
 	/**
 	 * The used OutputStream
 	 */
@@ -372,8 +379,9 @@ public void run() {
 		InputStream istream;
 		try {
 			boolean isNewSocket = false;
-
-			if( socket == null ) {
+			if (socketFactory != null) {
+				socket = socketFactory.createSocket();
+			} else if( socket == null ) {
 				socket = new Socket( proxy );
 				isNewSocket = true;
 
@@ -691,14 +699,26 @@ public void setProxy( Proxy proxy ) {
 	 * This method must be called before <code>connect</code>.
 	 * If the given socket is not yet bound it will be bound to the uri specified in the constructor.
 	 * @param socket The socket which should be used for the connection
+	 * @deprecated use setSocketFactory
 	 */
+	@Deprecated
 	public void setSocket( Socket socket ) {
 		if( this.socket != null ) {
 			throw new IllegalStateException( "socket has already been set" );
 		}
 		this.socket = socket;
 	}
 
+	/**
+	 * Accepts a SocketFactory.<br>
+	 * This method must be called before <code>connect</code>.
+	 * The socket will be bound to the uri specified in the constructor.
+	 * @param socketFactory The socket factory which should be used for the connection.
+	 */
+	public void setSocketFactory(SocketFactory socketFactory) {
+		this.socketFactory = socketFactory;
+	}
+
 	@Override
 	public void sendFragmentedFrame(Opcode op, ByteBuffer buffer, boolean fin ) {
 		engine.sendFragmentedFrame( op, buffer, fin );
diff --git a/src/test/java/org/java_websocket/issues/AllIssueTests.java b/src/test/java/org/java_websocket/issues/AllIssueTests.java
@@ -37,7 +37,9 @@
 		org.java_websocket.issues.Issue661Test.class,
 		org.java_websocket.issues.Issue666Test.class,
 		org.java_websocket.issues.Issue677Test.class,
-		org.java_websocket.issues.Issue732Test.class
+		org.java_websocket.issues.Issue732Test.class,
+		org.java_websocket.issues.Issue764Test.class,
+		org.java_websocket.issues.Issue765Test.class
 })
 /**
  * Start all tests for issues
diff --git a/src/test/java/org/java_websocket/issues/Issue764Test.java b/src/test/java/org/java_websocket/issues/Issue764Test.java
@@ -0,0 +1,142 @@
+/*
+ * Copyright (c) 2010-2018 Nathan Rajlich
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ */
+
+package org.java_websocket.issues;
+
+import org.java_websocket.WebSocket;
+import org.java_websocket.client.WebSocketClient;
+import org.java_websocket.handshake.ClientHandshake;
+import org.java_websocket.handshake.ServerHandshake;
+import org.java_websocket.server.DefaultSSLWebSocketServerFactory;
+import org.java_websocket.server.WebSocketServer;
+import org.java_websocket.util.SocketUtil;
+import org.junit.Test;
+
+import javax.net.ssl.KeyManagerFactory;
+import javax.net.ssl.SSLContext;
+import javax.net.ssl.TrustManagerFactory;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.net.InetSocketAddress;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.security.*;
+import java.security.cert.CertificateException;
+import java.util.concurrent.CountDownLatch;
+
+public class Issue764Test {
+    private CountDownLatch countClientDownLatch = new CountDownLatch(2);
+    private CountDownLatch countServerDownLatch = new CountDownLatch(1);
+
+    @Test(timeout = 2000)
+    public void testIssue() throws IOException, URISyntaxException, KeyStoreException, NoSuchAlgorithmException, KeyManagementException, UnrecoverableKeyException, CertificateException, InterruptedException {
+        int port = SocketUtil.getAvailablePort();
+        final WebSocketClient webSocket = new WebSocketClient(new URI("wss://localhost:" + port)) {
+            @Override
+            public void onOpen(ServerHandshake handshakedata) {
+                countClientDownLatch.countDown();
+                countServerDownLatch.countDown();
+            }
+
+            @Override
+            public void onMessage(String message) {
+            }
+
+            @Override
+            public void onClose(int code, String reason, boolean remote) {
+            }
+
+            @Override
+            public void onError(Exception ex) {
+            }
+        };
+        WebSocketServer server = new MyWebSocketServer(port, webSocket, countServerDownLatch);
+
+        // load up the key store
+        String STORETYPE = "JKS";
+        String KEYSTORE = String.format("src%1$stest%1$1sjava%1$1sorg%1$1sjava_websocket%1$1skeystore.jks", File.separator);
+        String STOREPASSWORD = "storepassword";
+        String KEYPASSWORD = "keypassword";
+
+        KeyStore ks = KeyStore.getInstance(STORETYPE);
+        File kf = new File(KEYSTORE);
+        ks.load(new FileInputStream(kf), STOREPASSWORD.toCharArray());
+
+        KeyManagerFactory kmf = KeyManagerFactory.getInstance("SunX509");
+        kmf.init(ks, KEYPASSWORD.toCharArray());
+        TrustManagerFactory tmf = TrustManagerFactory.getInstance("SunX509");
+        tmf.init(ks);
+
+        SSLContext sslContext = null;
+        sslContext = SSLContext.getInstance("TLS");
+        sslContext.init(kmf.getKeyManagers(), tmf.getTrustManagers(), null);
+
+        server.setWebSocketFactory(new DefaultSSLWebSocketServerFactory(sslContext));
+        webSocket.setSocketFactory(sslContext.getSocketFactory());
+        server.start();
+        countServerDownLatch.await();
+        webSocket.connectBlocking();
+        webSocket.reconnectBlocking();
+        countClientDownLatch.await();
+    }
+
+
+    private static class MyWebSocketServer extends WebSocketServer {
+        private final WebSocketClient webSocket;
+        private final CountDownLatch countServerDownLatch;
+
+
+        public MyWebSocketServer(int port, WebSocketClient webSocket, CountDownLatch countServerDownLatch) {
+            super(new InetSocketAddress(port));
+            this.webSocket = webSocket;
+            this.countServerDownLatch = countServerDownLatch;
+        }
+
+        @Override
+        public void onOpen(WebSocket conn, ClientHandshake handshake) {
+        }
+
+        @Override
+        public void onClose(WebSocket conn, int code, String reason, boolean remote) {
+        }
+
+        @Override
+        public void onMessage(WebSocket conn, String message) {
+
+        }
+
+        @Override
+        public void onError(WebSocket conn, Exception ex) {
+            ex.printStackTrace();
+        }
+
+        @Override
+        public void onStart() {
+            countServerDownLatch.countDown();
+        }
+    }
+}
diff --git a/src/test/java/org/java_websocket/keystore.jks b/src/test/java/org/java_websocket/keystore.jks
