Add proxy authentication support, fixes #102 (#133)

* [#102] HTTP Proxy supports basic auth

* [#102] Proxy config allows auth scheme selection

* [#102] JDK8 is now required

In order to use AHC version 2.0+ JDK8 is the minimum requirement.

* [#102] Proxy config allows auth scheme selection

Added Kerberos and SPNEGO authentication schemes as well.

* [#102] Travis build no longer tries with JDK7

* [#102] README.md updated to indicate JDK8 req

* [#102] Updated travis.yml, removed double JDK8

* [#102] Updated travis.yml,removed "dist:precise"

* [#102] Removed IOException for listArchives

Author: kayhuba

.travis.yml

@@ -2,12 +2,8 @@ dist: trusty
 language: java
 matrix:
   include:
-  - dist: precise
-    jdk: openjdk7
-  - dist: precise
-    jdk: oraclejdk7
-  - jdk: openjdk8
   - jdk: oraclejdk8
+  - jdk: openjdk8
 
 notifications:
   slack:

README.md

@@ -255,7 +255,7 @@ Reference documentation is available at
 You need an OpenTok API key and API secret, which you can obtain by logging into your
 [TokBox account](https://tokbox.com/account).
 
-The OpenTok Java SDK requires JDK 6 or greater to compile. Runtime requires Java SE 6 or greater.
+The OpenTok Java SDK requires JDK 8 or greater to compile. Runtime requires Java SE 8 or greater.
 This project is tested on both OpenJDK and Oracle implementations.
 
 

build.gradle

@@ -48,7 +48,7 @@ dependencies {
     testCompile group: 'junit', name: 'junit', version: '[4.3,5.0['
     testCompile group: 'com.github.tomakehurst', name: 'wiremock', version: '[1.45,1.99999)'
     compile group: 'commons-lang', name: 'commons-lang', version: '[2.6,2.99999)'
-    compile group: 'com.ning', name: 'async-http-client', version: '[1.9,2.0['
+    compile group: 'org.asynchttpclient', name: 'async-http-client', version: '2.0.34'
     compile group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '[2.3.1,2.99999)'
     compile group: 'commons-validator', name: 'commons-validator', version: '[1.4.0,1.99999)'
     compile group: 'commons-codec', name: 'commons-codec', version: '[1.9,1.99999]'
@@ -130,14 +130,14 @@ test {
     maxHeapSize = "1024m"
 }
 
-sourceCompatibility = 1.7
+sourceCompatibility = 1.8
 // credit: http://stackoverflow.com/a/22681854/305340
 tasks.withType(JavaCompile) {
     options.compilerArgs << "-Xlint:deprecation" << "-Xlint:unchecked"
     doFirst {
-        if (System.env.JDK7_HOME != null) {
-            options.bootClasspath = "$System.env.JDK7_HOME/jre/lib/rt.jar"
-            options.bootClasspath += "$File.pathSeparator$System.env.JDK7_HOME/jre/lib/jce.jar"
+        if (System.env.JDK8_HOME != null) {
+            options.bootClasspath = "$System.env.JDK8_HOME/jre/lib/rt.jar"
+            options.bootClasspath += "$File.pathSeparator$System.env.JDK8_HOME/jre/lib/jce.jar"
             // and other specific JDK jars
         }
     }

src/main/java/com/opentok/OpenTok.java

@@ -15,6 +15,7 @@
 import com.opentok.exception.RequestException;
 import com.opentok.util.Crypto;
 import com.opentok.util.HttpClient;
+import com.opentok.util.HttpClient.ProxyAuthScheme;
 
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
@@ -438,6 +439,9 @@ public static class Builder {
         private String apiSecret;
         private String apiUrl;
         private Proxy proxy;
+        private ProxyAuthScheme proxyAuthScheme;
+        private String principal;
+        private String password;
 
         public Builder(int apiKey, String apiSecret) {
             this.apiKey = apiKey;
@@ -450,7 +454,15 @@ public Builder apiUrl(String apiUrl) {
         }
 
         public Builder proxy(Proxy proxy) {
+            proxy(proxy, null, null, null);
+            return this;
+        }
+        
+        public Builder proxy(Proxy proxy, ProxyAuthScheme proxyAuthScheme, String principal, String password) {
             this.proxy = proxy;
+            this.proxyAuthScheme = proxyAuthScheme;
+            this.principal = principal;
+            this.password = password;
             return this;
         }
 
@@ -461,7 +473,7 @@ public OpenTok build() {
                 clientBuilder.apiUrl(this.apiUrl);
             }
             if (this.proxy != null) {
-                clientBuilder.proxy(this.proxy);
+                clientBuilder.proxy(this.proxy, proxyAuthScheme, principal, password);
             }
 
             return new OpenTok(this.apiKey, this.apiSecret, clientBuilder.build());

src/main/java/com/opentok/util/HttpClient.java

@@ -11,26 +11,38 @@
 import java.net.InetSocketAddress;
 import java.net.Proxy;
 import java.net.SocketAddress;
+import java.util.ArrayList;
 import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
 
+import org.asynchttpclient.AsyncHttpClientConfig;
+import org.asynchttpclient.DefaultAsyncHttpClient;
+import org.asynchttpclient.DefaultAsyncHttpClientConfig;
+import org.asynchttpclient.Realm;
+import org.asynchttpclient.Realm.AuthScheme;
+import org.asynchttpclient.RequestBuilder;
+import org.asynchttpclient.Response;
+import org.asynchttpclient.filter.FilterContext;
+import org.asynchttpclient.filter.FilterException;
+import org.asynchttpclient.filter.RequestFilter;
+import org.asynchttpclient.proxy.ProxyServer;
+
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.JsonNodeFactory;
 import com.fasterxml.jackson.databind.node.ObjectNode;
-import com.ning.http.client.*;
-import com.ning.http.client.filter.FilterContext;
-import com.ning.http.client.filter.FilterException;
-import com.ning.http.client.filter.RequestFilter;
 import com.opentok.ArchiveProperties;
 import com.opentok.constants.DefaultApiUrl;
 import com.opentok.constants.Version;
 import com.opentok.exception.OpenTokException;
 import com.opentok.exception.RequestException;
 
-public class HttpClient extends AsyncHttpClient {
+public class HttpClient extends DefaultAsyncHttpClient {
 
     private final String apiUrl;
     private final int apiKey;
@@ -44,10 +56,16 @@ private HttpClient(Builder builder) {
     public String createSession(Map<String, Collection<String>> params) throws RequestException {
         String responseString = null;
         Response response = null;
-        FluentStringsMap paramsString = new FluentStringsMap().addAll(params);
+        Map<String, List<String>> paramsWithList = null;
+        if (params != null) {
+            paramsWithList = new HashMap<>();
+            for (Entry<String, Collection<String>> entry : params.entrySet()) {
+                paramsWithList.put(entry.getKey(), new ArrayList<>(entry.getValue()));
+            }
+        }
 
         Future<Response> request = this.preparePost(this.apiUrl + "/session/create")
-                .setFormParams(paramsString)
+                .setFormParams(paramsWithList)
                 .addHeader("Accept", "application/json") // XML version is deprecated
                 .execute();
 
@@ -61,7 +79,7 @@ public String createSession(Map<String, Collection<String>> params) throws Reque
                     throw new RequestException("Could not create an OpenTok Session. The server response was invalid." +
                             " response code: " + response.getStatusCode());
             }
-        } catch (InterruptedException | ExecutionException | IOException e) {
+        } catch (InterruptedException | ExecutionException e) {
             throw new RequestException("Could not create an OpenTok Session", e);
         }
         return responseString;
@@ -89,7 +107,7 @@ public String getArchive(String archiveId) throws RequestException {
                     throw new RequestException("Could not get an OpenTok Archive. The server response was invalid." +
                             " response code: " + response.getStatusCode());
             }
-        } catch (InterruptedException | ExecutionException | IOException e) {
+        } catch (InterruptedException | ExecutionException e) {
             throw new RequestException("Could not  get an OpenTok Archive", e);
         }
 
@@ -126,7 +144,7 @@ public String getArchives(int offset, int count) throws RequestException {
                     throw new RequestException("Could not get an OpenTok Archive. The server response was invalid." +
                             " response code: " + response.getStatusCode());
             }
-        } catch (InterruptedException | ExecutionException | IOException e) {
+        } catch (InterruptedException | ExecutionException e) {
             throw new RequestException("Could not get OpenTok Archives", e);
         }
 
@@ -150,7 +168,7 @@ public String getArchives(String sessionId) throws RequestException {
                     throw new RequestException("Could not get an OpenTok Archive. The server response was invalid."
                             + " response code: " + response.getStatusCode());
             }
-        } catch (InterruptedException | ExecutionException | IOException e) {
+        } catch (InterruptedException | ExecutionException e) {
             throw new RequestException("Could not get OpenTok Archives", e);
         }
     }
@@ -202,7 +220,7 @@ public String startArchive(String sessionId, ArchiveProperties properties)
                     throw new RequestException("Could not start an OpenTok Archive. The server response was invalid." +
                             " response code: " + response.getStatusCode());
             }
-        } catch (InterruptedException | ExecutionException | IOException e) {
+        } catch (InterruptedException | ExecutionException e) {
             throw new RequestException("Could not start an OpenTok Archive.", e);
         }
         return responseString;
@@ -238,7 +256,7 @@ public String stopArchive(String archiveId) throws RequestException {
                     throw new RequestException("Could not stop an OpenTok Archive. The server response was invalid." +
                             " response code: " + response.getStatusCode());
             }
-        } catch (InterruptedException | ExecutionException | IOException e) {
+        } catch (InterruptedException | ExecutionException e) {
             throw new RequestException("Could not stop an OpenTok Archive.", e);
         }
         return responseString;
@@ -266,17 +284,28 @@ public String deleteArchive(String archiveId) throws RequestException {
                     throw new RequestException("Could not get an OpenTok Archive. The server response was invalid." +
                             " response code: " + response.getStatusCode());
             }
-        } catch (InterruptedException | ExecutionException | IOException e) {
+        } catch (InterruptedException | ExecutionException e) {
             throw new RequestException("Could not delete an OpenTok Archive. archiveId = " + archiveId, e);
         }
 
         return responseString;
     }
+    
+    public static enum ProxyAuthScheme {
+        BASIC,
+        DIGEST,
+        NTLM,
+        SPNEGO,
+        KERBEROS
+    }
 
     public static class Builder {
         private final int apiKey;
         private final String apiSecret;
         private Proxy proxy;
+        private ProxyAuthScheme proxyAuthScheme;
+        private String principal;
+        private String password;
         private String apiUrl;
         private AsyncHttpClientConfig config;
 
@@ -291,20 +320,28 @@ public Builder apiUrl(String apiUrl) {
         }
 
         public Builder proxy(Proxy proxy) {
+            proxy(proxy, null, null, null);
+            return this;
+        }
+        
+        public Builder proxy(Proxy proxy, ProxyAuthScheme proxyAuthScheme, String principal, String password) {
             this.proxy = proxy;
+            this.proxyAuthScheme = proxyAuthScheme;
+            this.principal = principal;
+            this.password = password;
             return this;
         }
 
         public HttpClient build() {
-            AsyncHttpClientConfig.Builder configBuilder = new AsyncHttpClientConfig.Builder()
+            DefaultAsyncHttpClientConfig.Builder configBuilder = new DefaultAsyncHttpClientConfig.Builder()
                     .setUserAgent("Opentok-Java-SDK/" + Version.VERSION + " JRE/" + System.getProperty("java.version"))
                     .addRequestFilter(new TokenAuthRequestFilter(this.apiKey, this.apiSecret));
             if (this.apiUrl == null) {
                 this.apiUrl=DefaultApiUrl.DEFAULT_API_URI;
             }
 
             if (this.proxy != null) {
-                configBuilder.setProxyServer(createProxyServer(this.proxy));
+                configBuilder.setProxyServer(createProxyServer(this.proxy, this.proxyAuthScheme, this.principal, this.password));
             }
 
             this.config = configBuilder.build();
@@ -314,7 +351,7 @@ public HttpClient build() {
         }
 
         // credit: https://github.com/AsyncHttpClient/async-http-client/blob/b52a8de5d6a862b5d1652d62f87ce774cbcff156/src/main/java/com/ning/http/client/ProxyServer.java#L99-L127
-        static ProxyServer createProxyServer(final Proxy proxy) {
+        static ProxyServer createProxyServer(final Proxy proxy, ProxyAuthScheme proxyAuthScheme, String principal, String password) {
             switch (proxy.type()) {
                 case DIRECT:
                     return null;
@@ -329,9 +366,37 @@ static ProxyServer createProxyServer(final Proxy proxy) {
             }
 
             InetSocketAddress isa = (InetSocketAddress) sa;
-
+            
             final String isaHost = isa.isUnresolved() ? isa.getHostName() : isa.getAddress().getHostAddress();
-            return new ProxyServer(isaHost, isa.getPort());
+            ProxyServer.Builder builder = new ProxyServer.Builder(isaHost, isa.getPort());
+
+            if (principal != null) {
+                Realm.AuthScheme authScheme = null;
+                switch (proxyAuthScheme) {
+                case BASIC:
+                    authScheme = AuthScheme.BASIC;
+                    break;
+                case DIGEST:
+                    authScheme = AuthScheme.DIGEST;
+                    break;
+                case NTLM:
+                    authScheme = AuthScheme.NTLM;
+                    break;
+                case KERBEROS:
+                    authScheme = AuthScheme.KERBEROS;
+                    break;
+                case SPNEGO:
+                    authScheme = AuthScheme.SPNEGO;
+                    break;
+                }
+                
+                Realm.Builder rb = new Realm.Builder(principal, password);
+                rb.setScheme(authScheme);
+                
+                builder.setRealm(rb.build());
+            }
+            
+            return builder.build();
         }
     }
 
@@ -346,9 +411,10 @@ public TokenAuthRequestFilter(int apiKey, String apiSecret) {
             this.apiSecret = apiSecret;
         }
 
-        public FilterContext filter(FilterContext ctx) throws FilterException {
+        @Override
+        public <T> FilterContext<T> filter(FilterContext<T> ctx) throws FilterException {
             try {
-                return new FilterContext.FilterContextBuilder(ctx)
+                return new FilterContext.FilterContextBuilder<T>(ctx)
                         .request(new RequestBuilder(ctx.getRequest())
                                 .addHeader(authHeader, TokenGenerator.generateToken(apiKey, apiSecret))
                                 .build())