Merge pull request #1603 from xhh/java-ignore-empty-auth-values

[Java] Improvements on authentications

modules/swagger-codegen/src/main/resources/Java/auth/ApiKeyAuth.mustache

@@ -44,6 +44,9 @@ public class ApiKeyAuth implements Authentication {
 
   @Override
   public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
+    if (apiKey == null) {
+      return;
+    }
     String value;
     if (apiKeyPrefix != null) {
       value = apiKeyPrefix + " " + apiKey;

modules/swagger-codegen/src/main/resources/Java/auth/HttpBasicAuth.mustache

@@ -2,11 +2,12 @@ package {{invokerPackage}}.auth;
 
 import {{invokerPackage}}.Pair;
 
+import com.migcomponents.migbase64.Base64;
+
 import java.util.Map;
 import java.util.List;
 
 import java.io.UnsupportedEncodingException;
-import javax.xml.bind.DatatypeConverter;
 
 {{>generatedAnnotation}}
 public class HttpBasicAuth implements Authentication {
@@ -31,9 +32,12 @@ public class HttpBasicAuth implements Authentication {
 
   @Override
   public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
+    if (username == null && password == null) {
+      return;
+    }
     String str = (username == null ? "" : username) + ":" + (password == null ? "" : password);
     try {
-      headerParams.put("Authorization", "Basic " + DatatypeConverter.printBase64Binary(str.getBytes("UTF-8")));
+      headerParams.put("Authorization", "Basic " + Base64.encodeToString(str.getBytes("UTF-8"), false));
     } catch (UnsupportedEncodingException e) {
       throw new RuntimeException(e);
     }

modules/swagger-codegen/src/main/resources/Java/libraries/jersey2/pom.mustache

@@ -152,6 +152,13 @@
       <version>${jodatime-version}</version>
     </dependency>
 
+    <!-- Base64 encoding that works in both JVM and Android -->
+    <dependency>
+      <groupId>com.brsanthu</groupId>
+      <artifactId>migbase64</artifactId>
+      <version>2.2</version>
+    </dependency>
+
     <!-- test dependencies -->
     <dependency>
       <groupId>junit</groupId>

modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/auth/HttpBasicAuth.mustache

@@ -2,7 +2,7 @@ package {{invokerPackage}}.auth;
 
 import {{invokerPackage}}.Pair;
 
-import com.migcomponents.migbase64.Base64;
+import com.squareup.okhttp.Credentials;
 
 import java.util.Map;
 import java.util.List;
@@ -31,11 +31,11 @@ public class HttpBasicAuth implements Authentication {
 
   @Override
   public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
-    String str = (username == null ? "" : username) + ":" + (password == null ? "" : password);
+    if (username == null && password == null) {
-    try {
+      return;
-      headerParams.put("Authorization", "Basic " + Base64.encodeToString(str.getBytes("UTF-8"), false));
+    }
-    } catch (UnsupportedEncodingException e) {
+    headerParams.put("Authorization", Credentials.basic(
-      throw new RuntimeException(e);
+        username == null ? "" : username,
-    }
+        password == null ? "" : password));
   }
 }

modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache

@@ -122,11 +122,6 @@
       <artifactId>gson</artifactId>
       <version>${gson-version}</version>
     </dependency>
-    <dependency>
-      <groupId>com.brsanthu</groupId>
-      <artifactId>migbase64</artifactId>
-      <version>2.2</version>
-    </dependency>
 
     <!-- test dependencies -->
     <dependency>

modules/swagger-codegen/src/main/resources/Java/pom.mustache

@@ -148,6 +148,13 @@
       <version>${jodatime-version}</version>
     </dependency>
 
+    <!-- Base64 encoding that works in both JVM and Android -->
+    <dependency>
+      <groupId>com.brsanthu</groupId>
+      <artifactId>migbase64</artifactId>
+      <version>2.2</version>
+    </dependency>
+
     <!-- test dependencies -->
     <dependency>
       <groupId>junit</groupId>

samples/client/petstore/java/default/pom.xml

@@ -148,6 +148,13 @@
       <version>${jodatime-version}</version>
     </dependency>
 
+    <!-- Base64 encoding that works in both JVM and Android -->
+    <dependency>
+      <groupId>com.brsanthu</groupId>
+      <artifactId>migbase64</artifactId>
+      <version>2.2</version>
+    </dependency>
+
     <!-- test dependencies -->
     <dependency>
       <groupId>junit</groupId>

samples/client/petstore/java/default/src/main/java/io/swagger/client/auth/ApiKeyAuth.java

@@ -5,7 +5,7 @@ import io.swagger.client.Pair;
 import java.util.Map;
 import java.util.List;
 
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-11-20T17:28:23.285+08:00")
 public class ApiKeyAuth implements Authentication {
   private final String location;
   private final String paramName;
@@ -44,6 +44,9 @@ public class ApiKeyAuth implements Authentication {
 
   @Override
   public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
+    if (apiKey == null) {
+      return;
+    }
     String value;
     if (apiKeyPrefix != null) {
       value = apiKeyPrefix + " " + apiKey;

samples/client/petstore/java/default/src/main/java/io/swagger/client/auth/HttpBasicAuth.java

@@ -2,13 +2,14 @@ package io.swagger.client.auth;
 
 import io.swagger.client.Pair;
 
+import com.migcomponents.migbase64.Base64;
+
 import java.util.Map;
 import java.util.List;
 
 import java.io.UnsupportedEncodingException;
-import javax.xml.bind.DatatypeConverter;
 
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-30T16:36:47.681+08:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-11-22T13:15:32.345+08:00")
 public class HttpBasicAuth implements Authentication {
   private String username;
   private String password;
@@ -31,9 +32,12 @@ public class HttpBasicAuth implements Authentication {
 
   @Override
   public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
+    if (username == null && password == null) {
+      return;
+    }
     String str = (username == null ? "" : username) + ":" + (password == null ? "" : password);
     try {
-      headerParams.put("Authorization", "Basic " + DatatypeConverter.printBase64Binary(str.getBytes("UTF-8")));
+      headerParams.put("Authorization", "Basic " + Base64.encodeToString(str.getBytes("UTF-8"), false));
     } catch (UnsupportedEncodingException e) {
       throw new RuntimeException(e);
     }

samples/client/petstore/java/jersey2/pom.xml

@@ -152,6 +152,13 @@
       <version>${jodatime-version}</version>
     </dependency>
 
+    <!-- Base64 encoding that works in both JVM and Android -->
+    <dependency>
+      <groupId>com.brsanthu</groupId>
+      <artifactId>migbase64</artifactId>
+      <version>2.2</version>
+    </dependency>
+
     <!-- test dependencies -->
     <dependency>
       <groupId>junit</groupId>

samples/client/petstore/java/jersey2/src/main/java/io/swagger/client/auth/ApiKeyAuth.java

@@ -5,7 +5,7 @@ import io.swagger.client.Pair;
 import java.util.Map;
 import java.util.List;
 
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-11-17T11:17:50.535-05:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-11-20T17:28:47.318+08:00")
 public class ApiKeyAuth implements Authentication {
   private final String location;
   private final String paramName;
@@ -44,6 +44,9 @@ public class ApiKeyAuth implements Authentication {
 
   @Override
   public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
+    if (apiKey == null) {
+      return;
+    }
     String value;
     if (apiKeyPrefix != null) {
       value = apiKeyPrefix + " " + apiKey;

samples/client/petstore/java/jersey2/src/main/java/io/swagger/client/auth/HttpBasicAuth.java

@@ -2,13 +2,14 @@ package io.swagger.client.auth;
 
 import io.swagger.client.Pair;
 
+import com.migcomponents.migbase64.Base64;
+
 import java.util.Map;
 import java.util.List;
 
 import java.io.UnsupportedEncodingException;
-import javax.xml.bind.DatatypeConverter;
 
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-11-17T11:17:50.535-05:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-11-22T13:15:27.225+08:00")
 public class HttpBasicAuth implements Authentication {
   private String username;
   private String password;
@@ -31,9 +32,12 @@ public class HttpBasicAuth implements Authentication {
 
   @Override
   public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
+    if (username == null && password == null) {
+      return;
+    }
     String str = (username == null ? "" : username) + ":" + (password == null ? "" : password);
     try {
-      headerParams.put("Authorization", "Basic " + DatatypeConverter.printBase64Binary(str.getBytes("UTF-8")));
+      headerParams.put("Authorization", "Basic " + Base64.encodeToString(str.getBytes("UTF-8"), false));
     } catch (UnsupportedEncodingException e) {
       throw new RuntimeException(e);
     }

samples/client/petstore/java/okhttp-gson/pom.xml

@@ -122,11 +122,6 @@
       <artifactId>gson</artifactId>
       <version>${gson-version}</version>
     </dependency>
-    <dependency>
-      <groupId>com.brsanthu</groupId>
-      <artifactId>migbase64</artifactId>
-      <version>2.2</version>
-    </dependency>
 
     <!-- test dependencies -->
     <dependency>

samples/client/petstore/java/okhttp-gson/src/main/java/io/swagger/client/auth/ApiKeyAuth.java

@@ -5,7 +5,7 @@ import io.swagger.client.Pair;
 import java.util.Map;
 import java.util.List;
 
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-10-20T11:42:25.339-07:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2015-11-20T17:28:54.086+08:00")
 public class ApiKeyAuth implements Authentication {
   private final String location;
   private final String paramName;
@@ -44,6 +44,9 @@ public class ApiKeyAuth implements Authentication {
 
   @Override
   public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
+    if (apiKey == null) {
+      return;
+    }
     String value;
     if (apiKeyPrefix != null) {
       value = apiKeyPrefix + " " + apiKey;

samples/client/petstore/java/okhttp-gson/src/main/java/io/swagger/client/auth/HttpBasicAuth.java

@@ -2,7 +2,7 @@ package io.swagger.client.auth;
 
 import io.swagger.client.Pair;
 
-import com.migcomponents.migbase64.Base64;
+import com.squareup.okhttp.Credentials;
 
 import java.util.Map;
 import java.util.List;
@@ -31,11 +31,11 @@ public class HttpBasicAuth implements Authentication {
 
   @Override
   public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
-    String str = (username == null ? "" : username) + ":" + (password == null ? "" : password);
+    if (username == null && password == null) {
-    try {
+      return;
-      headerParams.put("Authorization", "Basic " + Base64.encodeToString(str.getBytes("UTF-8"), false));
+    }
-    } catch (UnsupportedEncodingException e) {
+    headerParams.put("Authorization", Credentials.basic(
-      throw new RuntimeException(e);
+        username == null ? "" : username,
-    }
+        password == null ? "" : password));
   }
 }

samples/client/petstore/java/okhttp-gson/src/test/java/io/swagger/client/auth/ApiKeyAuthTest.java

@@ -29,6 +29,20 @@ public class ApiKeyAuthTest {
         assertEquals(0, headerParams.size());
     }
 
+    @Test
+    public void testApplyToParamsInQueryWithNullValue() {
+        List<Pair> queryParams = new ArrayList<Pair>();
+        Map<String, String> headerParams = new HashMap<String, String>();
+
+        ApiKeyAuth auth = new ApiKeyAuth("query", "api_key");
+        auth.setApiKey(null);
+        auth.applyToParams(queryParams, headerParams);
+
+        // no changes to parameters
+        assertEquals(0, queryParams.size());
+        assertEquals(0, headerParams.size());
+    }
+
     @Test
     public void testApplyToParamsInHeaderWithPrefix() {
         List<Pair> queryParams = new ArrayList<Pair>();
@@ -44,4 +58,19 @@ public class ApiKeyAuthTest {
         assertEquals(1, headerParams.size());
         assertEquals("Token my-api-token", headerParams.get("X-API-TOKEN"));
     }
+
+    @Test
+    public void testApplyToParamsInHeaderWithNullValue() {
+        List<Pair> queryParams = new ArrayList<Pair>();
+        Map<String, String> headerParams = new HashMap<String, String>();
+
+        ApiKeyAuth auth = new ApiKeyAuth("header", "X-API-TOKEN");
+        auth.setApiKey(null);
+        auth.setApiKeyPrefix("Token");
+        auth.applyToParams(queryParams, headerParams);
+
+        // no changes to parameters
+        assertEquals(0, queryParams.size());
+        assertEquals(0, headerParams.size());
+    }
 }

samples/client/petstore/java/okhttp-gson/src/test/java/io/swagger/client/auth/HttpBasicAuthTest.java

@@ -48,5 +48,15 @@ public class HttpBasicAuthTest {
         // the string below is base64-encoded result of "my-username:" with the "Basic " prefix
         expected = "Basic bXktdXNlcm5hbWU6";
         assertEquals(expected, headerParams.get("Authorization"));
+
+        // null username and password should be ignored
+        queryParams = new ArrayList<Pair>();
+        headerParams = new HashMap<String, String>();
+        auth.setUsername(null);
+        auth.setPassword(null);
+        auth.applyToParams(queryParams, headerParams);
+        // no changes to parameters
+        assertEquals(0, queryParams.size());
+        assertEquals(0, headerParams.size());
     }
 }