Options for inject okhttp Call/WebSocket factory

Author: Yu-Hsuan Lin

README.md

@@ -94,14 +94,19 @@ socket.on(Socket.EVENT_OPEN, new Emitter.Listener() {
 Use custom SSL settings:
 
 ```java
+OkHttpClient okHttpClient = new OkHttpClient.Builder()
+    .hostnameVerifier(myHostnameVerifier)
+    .sslSocketFactory(mySSLContext.getSocketFactory(), myX509TrustManager)
+    .build();
+
 // default SSLContext for all sockets
-Socket.setDefaultSSLContext(mySSLContext);
-Socket.setDefaultHostnameVerifier(myHostnameVerifier);
+Socket.setDefaultOkHttpWebSocketFactory(okHttpClient);
+Socket.setDefaultOkHttpCallFactory(okHttpClient);
 
 // set as an option
 opts = new Socket.Options();
-opts.sslContext = mySSLContext;
-opts.hostnameVerifier = myHostnameVerifier;
+opts.callFactory = okHttpClient;
+opts.webSocketFactory = okHttpClient;
 socket = new Socket(opts);
 ```
 

pom.xml

@@ -49,7 +49,7 @@
     <dependency>
       <groupId>com.squareup.okhttp3</groupId>
       <artifactId>okhttp</artifactId>
-      <version>3.5.0</version>
+      <version>3.7.0</version>
     </dependency>
     <dependency>
       <groupId>org.json</groupId>

src/main/java/io/socket/engineio/client/Socket.java

@@ -1,27 +1,31 @@
 package io.socket.engineio.client;
 
-import io.socket.emitter.Emitter;
-import io.socket.engineio.client.transports.Polling;
-import io.socket.engineio.client.transports.PollingXHR;
-import io.socket.engineio.client.transports.WebSocket;
-import io.socket.engineio.parser.Packet;
-import io.socket.engineio.parser.Parser;
-import io.socket.parseqs.ParseQS;
-import io.socket.thread.EventThread;
 import org.json.JSONException;
 
-import javax.net.ssl.HostnameVerifier;
-import javax.net.ssl.SSLContext;
-import java.net.Proxy;
 import java.net.URI;
 import java.net.URISyntaxException;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Logger;
 
+import io.socket.emitter.Emitter;
+import io.socket.engineio.client.transports.Polling;
+import io.socket.engineio.client.transports.PollingXHR;
+import io.socket.engineio.client.transports.WebSocket;
+import io.socket.engineio.parser.Packet;
+import io.socket.engineio.parser.Parser;
+import io.socket.parseqs.ParseQS;
+import io.socket.thread.EventThread;
+import okhttp3.OkHttpClient;
+
 
 /**
  * The socket class for Event.IO Client.
@@ -98,8 +102,9 @@ public String toString() {
 
     private static boolean priorWebsocketSuccess = false;
 
-    private static SSLContext defaultSSLContext;
-    private static HostnameVerifier defaultHostnameVerifier;
+    private static okhttp3.WebSocket.Factory defaultWebSocketFactory;
+    private static okhttp3.Call.Factory defaultCallFactory;
+    private static OkHttpClient defaultOkHttpClient;
 
     private boolean secure;
     private boolean upgrade;
@@ -122,11 +127,8 @@ public String toString() {
     /*package*/ Transport transport;
     private Future pingTimeoutTimer;
     private Future pingIntervalTimer;
-    private SSLContext sslContext;
-    private HostnameVerifier hostnameVerifier;
-    public Proxy proxy;
-    public String proxyLogin;
-    public String proxyPassword;
+    private okhttp3.WebSocket.Factory webSocketFactory;
+    private okhttp3.Call.Factory callFactory;
 
     private ReadyState readyState;
     private ScheduledExecutorService heartbeatScheduler;
@@ -190,7 +192,6 @@ public Socket(Options opts) {
             opts.port = this.secure ? 443 : 80;
         }
 
-        this.sslContext = opts.sslContext != null ? opts.sslContext : defaultSSLContext;
         this.hostname = opts.hostname != null ? opts.hostname : "localhost";
         this.port = opts.port;
         this.query = opts.query != null ?
@@ -203,18 +204,28 @@ public Socket(Options opts) {
                 opts.transports : new String[]{Polling.NAME, WebSocket.NAME}));
         this.policyPort = opts.policyPort != 0 ? opts.policyPort : 843;
         this.rememberUpgrade = opts.rememberUpgrade;
-        this.hostnameVerifier = opts.hostnameVerifier != null ? opts.hostnameVerifier : defaultHostnameVerifier;
-        this.proxy = opts.proxy;
-        this.proxyLogin = opts.proxyLogin;
-        this.proxyPassword = opts.proxyPassword;
+        this.callFactory = opts.callFactory != null ? opts.callFactory : defaultCallFactory;
+        this.webSocketFactory = opts.webSocketFactory != null ? opts.webSocketFactory : defaultWebSocketFactory;
+        if (callFactory == null) {
+            if (defaultOkHttpClient == null) {
+                defaultOkHttpClient = new OkHttpClient();
+            }
+            callFactory = defaultOkHttpClient;
+        }
+        if (webSocketFactory == null) {
+            if (defaultOkHttpClient == null) {
+                defaultOkHttpClient = new OkHttpClient();
+            }
+            webSocketFactory = defaultOkHttpClient;
+        }
     }
 
-    public static void setDefaultSSLContext(SSLContext sslContext) {
-        defaultSSLContext = sslContext;
+    public static void setDefaultOkHttpWebSocketFactory(okhttp3.WebSocket.Factory factory) {
+        defaultWebSocketFactory = factory;
     }
 
-    public static void setDefaultHostnameVerifier(HostnameVerifier hostnameVerifier) {
-        defaultHostnameVerifier = hostnameVerifier;
+    public static void setDefaultOkHttpCallFactory(okhttp3.Call.Factory factory) {
+        defaultCallFactory = factory;
     }
 
     /**
@@ -262,7 +273,6 @@ private Transport createTransport(String name) {
         }
 
         Transport.Options opts = new Transport.Options();
-        opts.sslContext = this.sslContext;
         opts.hostname = this.hostname;
         opts.port = this.port;
         opts.secure = this.secure;
@@ -272,10 +282,8 @@ private Transport createTransport(String name) {
         opts.timestampParam = this.timestampParam;
         opts.policyPort = this.policyPort;
         opts.socket = this;
-        opts.hostnameVerifier = this.hostnameVerifier;
-        opts.proxy = this.proxy;
-        opts.proxyLogin = this.proxyLogin;
-        opts.proxyPassword = this.proxyPassword;
+        opts.callFactory = this.callFactory;
+        opts.webSocketFactory = this.webSocketFactory;
 
         Transport transport;
         if (WebSocket.NAME.equals(name)) {

src/main/java/io/socket/engineio/client/Transport.java

@@ -1,16 +1,15 @@
 package io.socket.engineio.client;
 
 
+import java.util.Map;
+
 import io.socket.emitter.Emitter;
 import io.socket.engineio.parser.Packet;
 import io.socket.engineio.parser.Parser;
 import io.socket.thread.EventThread;
 import io.socket.utf8.UTF8Exception;
-
-import javax.net.ssl.HostnameVerifier;
-import javax.net.ssl.SSLContext;
-import java.net.Proxy;
-import java.util.Map;
+import okhttp3.Call;
+import okhttp3.WebSocket;
 
 public abstract class Transport extends Emitter {
 
@@ -41,14 +40,10 @@ public String toString() {
     protected String path;
     protected String hostname;
     protected String timestampParam;
-    protected SSLContext sslContext;
     protected Socket socket;
-    protected HostnameVerifier hostnameVerifier;
-    protected Proxy proxy;
-    protected String proxyLogin;
-    protected String proxyPassword;
-
     protected ReadyState readyState;
+    protected WebSocket.Factory webSocketFactory;
+    protected Call.Factory callFactory;
 
     public Transport(Options opts) {
         this.path = opts.path;
@@ -58,12 +53,9 @@ public Transport(Options opts) {
         this.query = opts.query;
         this.timestampParam = opts.timestampParam;
         this.timestampRequests = opts.timestampRequests;
-        this.sslContext = opts.sslContext;
         this.socket = opts.socket;
-        this.hostnameVerifier = opts.hostnameVerifier;
-        this.proxy = opts.proxy;
-        this.proxyLogin = opts.proxyLogin;
-        this.proxyPassword = opts.proxyPassword;
+        this.webSocketFactory = opts.webSocketFactory;
+        this.callFactory = opts.callFactory;
     }
 
     protected Transport onError(String msg, Exception desc) {
@@ -156,11 +148,8 @@ public static class Options {
         public int port = -1;
         public int policyPort = -1;
         public Map<String, String> query;
-        public SSLContext sslContext;
-        public HostnameVerifier hostnameVerifier;
         protected Socket socket;
-        public Proxy proxy;
-        public String proxyLogin;
-        public String proxyPassword;
+        public WebSocket.Factory webSocketFactory;
+        public Call.Factory callFactory;
     }
 }