Merge pull request #19 from launchdarkly/pk/proxy-support

added ability to pass in HTTP proxy config

Author: pkaeding

build.gradle

@@ -11,7 +11,7 @@ repositories {
 
 allprojects {
     group = 'com.launchdarkly'
-    version = "0.9.0"
+    version = "0.10.0-SNAPSHOT"
     sourceCompatibility = 1.6
     targetCompatibility = 1.6
 }

src/main/java/com/launchdarkly/client/EventProcessor.java

@@ -61,7 +61,7 @@ class Consumer implements Runnable {
 
     Consumer(LDConfig config) {
       this.config = config;
-      client = HttpClients.createDefault();
+      client = HttpClients.custom().setProxy(config.proxyHost).build();
     }
 
     @Override

src/main/java/com/launchdarkly/client/LDClient.java

@@ -88,6 +88,7 @@ protected CloseableHttpClient createClient() {
     RequestConfig requestConfig = RequestConfig.custom()
         .setConnectTimeout(config.connectTimeout)
         .setSocketTimeout(config.socketTimeout)
+        .setProxy(config.proxyHost)
         .build();
     client = CachingHttpClients.custom()
         .setCacheConfig(cacheConfig)

src/main/java/com/launchdarkly/client/LDConfig.java

@@ -1,5 +1,6 @@
 package com.launchdarkly.client;
 
+import org.apache.http.HttpHost;
 import org.apache.http.client.methods.HttpGet;
 import org.apache.http.client.methods.HttpPost;
 import org.apache.http.client.utils.URIBuilder;
@@ -27,13 +28,15 @@ public final class LDConfig {
   final int connectTimeout;
   final int socketTimeout;
   final int flushInterval;
+  final HttpHost proxyHost;
 
   protected LDConfig(Builder builder) {
     this.baseURI = builder.baseURI;
     this.capacity = builder.capacity;
     this.connectTimeout = builder.connectTimeout;
     this.socketTimeout = builder.socketTimeout;
     this.flushInterval = builder.flushInterval;
+    this.proxyHost = builder.proxyHost();
   }
 
   /**
@@ -54,6 +57,9 @@ public static class Builder{
     private int socketTimeout = DEFAULT_SOCKET_TIMEOUT;
     private int capacity = DEFAULT_CAPACITY;
     private int flushInterval = DEFAULT_FLUSH_INTERVAL;
+    private String proxyHost;
+    private int proxyPort = -1;
+    private String proxyScheme;
 
     /**
      * Creates a builder with all configuration parameters set to the default
@@ -151,6 +157,63 @@ public Builder capacity(int capacity) {
       return this;
     }
 
+    /**
+     * Set the host to use as an HTTP proxy for making connections to LaunchDarkly. If this is not set, but
+     * {@link #proxyPort(int)} or  {@link #proxyScheme(String)} are specified, this will default to <code>localhost</code>.
+     * <p>
+     * If none of {@link #proxyHost(String)}, {@link #proxyPort(int)} or {@link #proxyScheme(String)} are specified,
+     * a proxy will not be used, and {@link LDClient} will connect to LaunchDarkly directly.
+     * </p>
+     * @param host
+     * @return
+     */
+    public Builder proxyHost(String host) {
+      this.proxyHost = host;
+      return this;
+    }
+
+    /**
+     * Set the port to use for an HTTP proxy for making connections to LaunchDarkly.  If not set (but {@link #proxyHost(String)}
+     * or {@link #proxyScheme(String)} are specified, the default port for the scheme will be used.
+     *
+     * <p>
+     * If none of {@link #proxyHost(String)}, {@link #proxyPort(int)} or {@link #proxyScheme(String)} are specified,
+     * a proxy will not be used, and {@link LDClient} will connect to LaunchDarkly directly.
+     * </p>
+     * @param port
+     * @return
+     */
+    public Builder proxyPort(int port) {
+      this.proxyPort = port;
+      return this;
+    }
+
+    /**
+     * Set the scheme to use for an HTTP proxy for making connections to LaunchDarkly.  If not set (but {@link #proxyHost(String)}
+     * or {@link #proxyPort(int)} are specified, the default <code>https</code> scheme will be used.
+     *
+     * <p>
+     * If none of {@link #proxyHost(String)}, {@link #proxyPort(int)} or {@link #proxyScheme(String)} are specified,
+     * a proxy will not be used, and {@link LDClient} will connect to LaunchDarkly directly.
+     * </p>
+     * @param scheme
+     * @return
+     */
+    public Builder proxyScheme(String scheme) {
+      this.proxyScheme = scheme;
+      return this;
+    }
+
+    HttpHost proxyHost() {
+      if (this.proxyHost == null && this.proxyPort == -1 && this.proxyScheme == null) {
+        return null;
+      } else {
+        String hostname = this.proxyHost == null ? "localhost" : this.proxyHost;
+        String scheme = this.proxyScheme == null ? "https" : this.proxyScheme;
+        return new HttpHost(hostname, this.proxyPort, scheme);
+      }
+    }
+
     /**
      * Build the configured {@link com.launchdarkly.client.LDConfig} object
      * @return the {@link com.launchdarkly.client.LDConfig} configured by this builder

src/test/java/com/launchdarkly/client/LDConfigTest.java

@@ -1,6 +1,7 @@
 package com.launchdarkly.client;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
 
 import org.junit.Test;
 
@@ -31,4 +32,53 @@ public void testSocketTimeoutSpecifiedInMilliseconds() {
 
     assertEquals(3000, config.socketTimeout);
   }
+
+  @Test
+  public void testNoProxyConfigured() {
+    LDConfig config = new LDConfig.Builder().build();
+
+    assertNull(config.proxyHost);
+  }
+
+  @Test
+  public void testOnlyProxyPortConfiguredHasPort() {
+    LDConfig config = new LDConfig.Builder().proxyPort(1234).build();
+
+    assertEquals(1234, config.proxyHost.getPort());
+  }
+
+  @Test
+  public void testOnlyProxyPortConfiguredHasDefaultHost() {
+    LDConfig config = new LDConfig.Builder().proxyPort(1234).build();
+
+    assertEquals("localhost", config.proxyHost.getHostName());
+  }
+
+  @Test
+  public void testOnlyProxyPortConfiguredHasDefaultScheme() {
+    LDConfig config = new LDConfig.Builder().proxyPort(1234).build();
+
+    assertEquals("https", config.proxyHost.getSchemeName());
+  }
+
+  @Test
+  public void testOnlyProxyHostConfiguredHasDefaultPort() {
+    LDConfig config = new LDConfig.Builder().proxyHost("myproxy.example.com").build();
+
+    assertEquals(-1, config.proxyHost.getPort());
+  }
+
+  @Test
+  public void testProxyHostConfiguredHasHost() {
+    LDConfig config = new LDConfig.Builder().proxyHost("myproxy.example.com").build();
+
+    assertEquals("myproxy.example.com", config.proxyHost.getHostName());
+  }
+
+  @Test
+  public void testProxySchemeConfiguredHasScheme() {
+    LDConfig config = new LDConfig.Builder().proxyScheme("http").build();
+
+    assertEquals("http", config.proxyHost.getSchemeName());
+  }
 }