Cherry pick feature: Add outboundProxyHost/Port settings to enable co…

…mmunication with html swapper via a proxy. (#173)

README.en.md

@@ -106,6 +106,8 @@ defaultLang               | yes      |
 supportedLangs            | yes      |
 urlPattern                | yes      |
 useProxy                  |          | false
+outboundProxyPort         |          |
+outboundProxyHost         |          |
 originalUrlHeader         |          |
 originalQueryStringHeader |          |
 ignoreClasses             |          |
@@ -169,7 +171,23 @@ Set useProxy to true as follows
 
 Note that if the reverse proxy may also rewrite the request path or query, configuring the originalUrlHeader and/or originalQueryStringHeader may also be necessary.
 
-### 2.6. originalUrlHeader, originalQueryStringHeader
+### 2.6. outboundProxyHost, outboundProxyPort
+
+WovnServletFilter needs to send requests to Wovn's translation API server. This setting should be used if your server requires all outbound requests to be routed through a proxy. Both ``outboundProxyHost`` (host or IP address of the proxy) and ``outboundProxyPort`` (port number of the proxy) are required to be set. 
+
+```xml
+<init-param>
+  <param-name>outboundProxyHost</param-name>
+  <param-value>proxy.company.com</param-value>
+</init-param>
+<init-param>
+  <param-name>outboundProxyPort</param-name>
+  <param-value>8080</param-value>
+</init-param>
+```
+
+
+### 2.7. originalUrlHeader, originalQueryStringHeader
 
 Name of HTTP headers for declaring the original request path and query.
 
@@ -204,7 +222,7 @@ Configure WovnServletFilter to determine request path and query from the same HT
 _The sample request header shown above was referenced from the following site:_
 https://coderwall.com/p/jhkw7w/passing-request-uri-into-request-header
 
-### 2.7. ignorePaths
+### 2.8. ignorePaths
 
 A comma-separated list of URL path for which you would like WOVN to not translation content withing given directories.
 
@@ -234,7 +252,7 @@ https://my-website.com/user/admin
 https://my-website.com/adminpage
 ```
 
-### 2.8. ignoreClasses
+### 2.9. ignoreClasses
 
 A comma-separated list of HTML classes for which you would like WOVN to skip the elements of.
 (This setting is used to prevent confidential data contained in the page to be translated from being sent to WOVN)
@@ -261,7 +279,7 @@ Including three classes, `email-address-element`, `my-secret-class`, and `noshow
 </init-param>
 ```
 
-### 2.9. enableFlushBuffer
+### 2.10. enableFlushBuffer
 A flag to adjust the behavior of `ServletResponse.flushBuffer()`.
 
 This parameter is set to `false` by default (recommended).
@@ -270,7 +288,7 @@ When `enableFlushBuffer` is set to `false`, WovnServletFilter will capture calls
 immediately writing content to the client. Only when the complete HTML response is ready will the filter translate the content
 and send it to the client. This is necessary in order to translate the content properly.
 
-### 2.10. sitePrefixPath
+### 2.11. sitePrefixPath
 
 This parameter lets you set a prefix path to use as an anchor for which WOVN will translate pages. With this setting, WOVN will only translate pages that match the prefix path, and the path language code will be added _after_ the prefix path.
 
@@ -300,7 +318,7 @@ Furthermore, it is highly recommended to also configure your `web.xml` with a co
 </filter-mapping>
 ```
 
-### 2.11. langCodeAliases
+### 2.12. langCodeAliases
 
 This setting lets you specify the language identifier for your supported languages.
 
@@ -335,7 +353,7 @@ To illustrate, here is an example:
 
 Achieve this result by configuring `jp` as an alias for Japanese.
 
-### 2.12. customDomainLangs
+### 2.13. customDomainLangs
 
 This setting lets you define the domain and path that corresponds to each of your supported languages.
 
@@ -376,7 +394,7 @@ If this setting is used, each language declared in `supportedLangs` must be give
 Lastly, the path declared for your original language must match the structure of the underlying web server.
 In other words, you cannot use this setting to change the request path of your content in original language.
 
-### 2.13. debugMode
+### 2.14. debugMode
 
 A flag to enable extra debugging features.
 

pom.xml

@@ -7,7 +7,7 @@
     <groupId>com.github.wovnio</groupId>
     <artifactId>wovnjava</artifactId>
     <name>wovnjava</name>
-    <version>1.6.1</version>
+    <version>1.7.0</version>
     <url>https://github.com/WOVNio/wovnjava</url>
 
     <licenses>
@@ -51,7 +51,7 @@
         <dependency>
             <groupId>org.jetbrains</groupId>
             <artifactId>annotations-java5</artifactId>
-            <version>RELEASE</version>
+            <version>16.0.2</version>
         </dependency>
 
         <dependency>
@@ -123,6 +123,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
+                <version>3.0.0-M1</version>
                 <configuration>
                     <useSystemClassLoader>false</useSystemClassLoader>
                 </configuration>

src/main/java/com/github/wovnio/wovnjava/Api.java

@@ -6,9 +6,11 @@
 import java.io.UnsupportedEncodingException;
 import java.io.IOException;
 import java.net.HttpURLConnection;
+import java.net.InetSocketAddress;
 import java.net.URL;
 import java.net.URLEncoder;
 import java.net.MalformedURLException;
+import java.net.Proxy;
 import java.net.SocketTimeoutException;
 import java.util.zip.GZIPInputStream;
 import java.util.zip.GZIPOutputStream;
@@ -40,7 +42,10 @@ String translate(String lang, String html) throws ApiException {
         HttpURLConnection con = null;
         try {
             URL url = getApiUrl(lang, html);
-            con = (HttpURLConnection) url.openConnection();
+            Proxy proxy = this.settings.outboundProxyHost== null
+                ? Proxy.NO_PROXY
+                : new Proxy(Proxy.Type.HTTP, new InetSocketAddress(this.settings.outboundProxyHost, this.settings.outboundProxyPort));
+            con = (HttpURLConnection) url.openConnection(proxy);
             con.setConnectTimeout(settings.connectTimeout);
             con.setReadTimeout(settings.readTimeout);
             return translate(lang, html, con);

src/main/java/com/github/wovnio/wovnjava/Settings.java

@@ -47,6 +47,9 @@ class Settings {
     public final int connectTimeout;
     public final int readTimeout;
 
+    public final String outboundProxyHost;
+    public final int outboundProxyPort;
+
     Settings(FilterConfig config) throws ConfigurationError {
         FilterConfigReader reader = new FilterConfigReader(config);
 
@@ -78,6 +81,9 @@ class Settings {
 
         this.connectTimeout = positiveIntOrDefault(reader.getIntParameter("connectTimeout"), DefaultTimeout);
         this.readTimeout = positiveIntOrDefault(reader.getIntParameter("readTimeout"), DefaultTimeout);
+
+        this.outboundProxyHost = nonEmptyString(reader, "outboundProxyHost");
+        this.outboundProxyPort = reader.getIntParameter("outboundProxyPort");
     }
 
     private String verifyToken(String declaredUserToken, String declaredProjectToken) throws ConfigurationError {
@@ -196,6 +202,14 @@ private int positiveIntOrDefault(int declaredValue, int defaultValue) {
         return declaredValue > 0 ? declaredValue : defaultValue;
     }
 
+    private String nonEmptyString(FilterConfigReader reader, String key) throws ConfigurationError {
+        String value = reader.getStringParameter(key);
+        if (value != null && value.isEmpty()) {
+            throw new ConfigurationError(String.format("Invalid configuration for \"%s\", value cannot be empty.", value));
+        }
+        return value;
+    }
+
     String hash() throws NoSuchAlgorithmException {
         MessageDigest md = MessageDigest.getInstance("MD5");
         md.update(projectToken.getBytes());

src/test/java/com/github/wovnio/wovnjava/SettingsTest.java

@@ -61,13 +61,8 @@ public void testRequiredSettings__MissingProjectToken__ThrowError() throws Confi
             put("defaultLang", "en");
             put("supportedLangs", "en,ja");
         }});
-        boolean errorThrown = false;
-        try {
-            Settings s = new Settings(config);
-        } catch (ConfigurationError e) {
-            errorThrown = true;
-        }
-        assertEquals(true, errorThrown);
+
+        assertErrorThrown(config);
     }
 
     public void testRequiredSettings__MissingUrlPattern__ThrowError() throws ConfigurationError {
@@ -76,13 +71,8 @@ public void testRequiredSettings__MissingUrlPattern__ThrowError() throws Configu
             put("defaultLang", "en");
             put("supportedLangs", "en,ja");
         }});
-        boolean errorThrown = false;
-        try {
-            Settings s = new Settings(config);
-        } catch (ConfigurationError e) {
-            errorThrown = true;
-        }
-        assertEquals(true, errorThrown);
+
+        assertErrorThrown(config);
     }
 
     public void testRequiredSettings__MissingDefaultLang__ThrowError() throws ConfigurationError {
@@ -91,13 +81,8 @@ public void testRequiredSettings__MissingDefaultLang__ThrowError() throws Config
             put("urlPattern", "path");
             put("supportedLangs", "en,ja");
         }});
-        boolean errorThrown = false;
-        try {
-            Settings s = new Settings(config);
-        } catch (ConfigurationError e) {
-            errorThrown = true;
-        }
-        assertEquals(true, errorThrown);
+
+        assertErrorThrown(config);
     }
 
     public void testRequiredSettings__InvalidDefaultLangCode__ThrowError() throws ConfigurationError {
@@ -107,13 +92,8 @@ public void testRequiredSettings__InvalidDefaultLangCode__ThrowError() throws Co
             put("defaultLang", "English");
             put("supportedLangs", "en,ja");
         }});
-        boolean errorThrown = false;
-        try {
-            Settings s = new Settings(config);
-        } catch (ConfigurationError e) {
-            errorThrown = true;
-        }
-        assertEquals(true, errorThrown);
+
+        assertErrorThrown(config);
     }
 
     public void testRequiredSettings__MissingSupportedLangs__ThrowError() throws ConfigurationError {
@@ -122,13 +102,8 @@ public void testRequiredSettings__MissingSupportedLangs__ThrowError() throws Con
             put("urlPattern", "path");
             put("defaultLang", "en");
         }});
-        boolean errorThrown = false;
-        try {
-            Settings s = new Settings(config);
-        } catch (ConfigurationError e) {
-            errorThrown = true;
-        }
-        assertEquals(true, errorThrown);
+
+        assertErrorThrown(config);
     }
 
     public void testRequiredSettings__InvalidSupportedLangCode__ThrowError() throws ConfigurationError {
@@ -138,13 +113,8 @@ public void testRequiredSettings__InvalidSupportedLangCode__ThrowError() throws
             put("defaultLang", "en");
             put("supportedLangs", "en,Japanese");
         }});
-        boolean errorThrown = false;
-        try {
-            Settings s = new Settings(config);
-        } catch (ConfigurationError e) {
-            errorThrown = true;
-        }
-        assertEquals(true, errorThrown);
+
+        assertErrorThrown(config);
     }
 
     public void testRequiredSettings__SupportedLangDeclaredMultipleTimes__throwError() throws ConfigurationError {
@@ -452,19 +422,62 @@ public void testConnectTimeout__InvalidInteger__ThrowError() throws Configuratio
         FilterConfig config = TestUtil.makeConfigWithValidDefaults(new HashMap<String, String>() {{
             put("connectTimeout", "hoge");
         }});
-        boolean errorThrown = false;
-        try {
-            Settings s = new Settings(config);
-        } catch (ConfigurationError e) {
-            errorThrown = true;
-        }
-        assertEquals(true, errorThrown);
+
+        assertErrorThrown(config);
     }
 
     public void testReadTimeout__InvalidInteger__ThrowError() throws ConfigurationError {
         FilterConfig config = TestUtil.makeConfigWithValidDefaults(new HashMap<String, String>() {{
             put("readTimeout", "");
         }});
+
+        assertErrorThrown(config);
+    }
+
+    public void testOutboundProxyHost__Empty_ThrowsError() throws ConfigurationError {
+        FilterConfig config = TestUtil.makeConfigWithValidDefaults(new HashMap<String, String>() {{
+            put("outboundProxyHost", "");
+        }});
+
+        assertErrorThrown(config);
+    }
+
+    public void testOutboundProxyHost__NonEmpty_AcceptSetting() throws ConfigurationError {
+        FilterConfig config = TestUtil.makeConfigWithValidDefaults(new HashMap<String, String>() {{
+            put("outboundProxyHost", "proxy.com");
+        }});
+
+        Settings settings = new Settings(config);
+
+        assertEquals("proxy.com", settings.outboundProxyHost);
+    }
+
+    public void testOutboundProxyPort__Empty_ThrowsError() throws ConfigurationError {
+        FilterConfig config = TestUtil.makeConfigWithValidDefaults(new HashMap<String, String>() {{
+            put("outboundProxyPort", "");
+        }});
+
+        assertErrorThrown(config);
+    }
+
+    public void testOutboundProxyPort__NonInteger_ThrowsError() throws ConfigurationError {
+        FilterConfig config = TestUtil.makeConfigWithValidDefaults(new HashMap<String, String>() {{
+            put("outboundProxyPort", "abc");
+        }});
+        assertErrorThrown(config);
+    }
+
+    public void testOutboundProxyPort__Integer_AcceptSetting() throws ConfigurationError {
+        FilterConfig config = TestUtil.makeConfigWithValidDefaults(new HashMap<String, String>() {{
+            put("outboundProxyPort", "4000");
+        }});
+
+        Settings settings = new Settings(config);
+
+        assertEquals(4000, settings.outboundProxyPort);
+    }
+
+    private void assertErrorThrown(FilterConfig config) {
         boolean errorThrown = false;
         try {
             Settings s = new Settings(config);