Merge pull request #826 from xhh/java-auth

[Java] Add authentication support (API key, HTTP basic)

modules/swagger-codegen/src/main/java/com/wordnik/swagger/codegen/languages/JavaClientCodegen.java

@@ -106,15 +106,18 @@ public class JavaClientCodegen extends DefaultCodegen implements CodegenConfig {
       this.setSourceFolder((String)additionalProperties.get("sourceFolder"));
     }
 
+    final String invokerFolder = (sourceFolder + File.separator + invokerPackage).replace(".", File.separator);
     supportingFiles.add(new SupportingFile("pom.mustache", "", "pom.xml"));
-    supportingFiles.add(new SupportingFile("ApiClient.mustache",
-      (sourceFolder + File.separator + invokerPackage).replace(".", java.io.File.separator), "ApiClient.java"));
-    supportingFiles.add(new SupportingFile("Configuration.mustache",
-      (sourceFolder + File.separator + invokerPackage).replace(".", java.io.File.separator), "Configuration.java"));
-    supportingFiles.add(new SupportingFile("JsonUtil.mustache",
-      (sourceFolder + File.separator + invokerPackage).replace(".", java.io.File.separator), "JsonUtil.java"));
-    supportingFiles.add(new SupportingFile("apiException.mustache",
-      (sourceFolder + File.separator + invokerPackage).replace(".", java.io.File.separator), "ApiException.java"));
+    supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java"));
+    supportingFiles.add(new SupportingFile("JsonUtil.mustache", invokerFolder, "JsonUtil.java"));
+    supportingFiles.add(new SupportingFile("apiException.mustache", invokerFolder, "ApiException.java"));
+    supportingFiles.add(new SupportingFile("Configuration.mustache", invokerFolder, "Configuration.java"));
+
+    final String authFolder = (sourceFolder + File.separator + invokerPackage + ".auth").replace(".", File.separator);
+    supportingFiles.add(new SupportingFile("auth/Authentication.mustache", authFolder, "Authentication.java"));
+    supportingFiles.add(new SupportingFile("auth/HttpBasicAuth.mustache", authFolder, "HttpBasicAuth.java"));
+    supportingFiles.add(new SupportingFile("auth/ApiKeyAuth.mustache", authFolder, "ApiKeyAuth.java"));
+    supportingFiles.add(new SupportingFile("auth/OAuth.mustache", authFolder, "OAuth.java"));
   }
 
 

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

@@ -17,6 +17,7 @@ import javax.ws.rs.core.Response.Status.Family;
 import javax.ws.rs.core.MediaType;
 
 import java.util.Collection;
+import java.util.Collections;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.HashMap;
@@ -33,12 +34,19 @@ import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 import java.text.ParseException;
 
+import {{invokerPackage}}.auth.Authentication;
+import {{invokerPackage}}.auth.HttpBasicAuth;
+import {{invokerPackage}}.auth.ApiKeyAuth;
+import {{invokerPackage}}.auth.OAuth;
+
 public class ApiClient {
   private Map<String, Client> hostMap = new HashMap<String, Client>();
   private Map<String, String> defaultHeaderMap = new HashMap<String, String>();
   private boolean debugging = false;
   private String basePath = "{{basePath}}";
 
+  private Map<String, Authentication> authentications;
+
   private DateFormat dateFormat;
 
   public ApiClient() {
@@ -51,6 +59,14 @@ public class ApiClient {
 
     // Set default User-Agent.
     setUserAgent("Java-Swagger");
+
+    // Setup authentications (key: authentication name, value: authentication).
+    authentications = new HashMap<String, Authentication>();{{#authMethods}}{{#isBasic}}
+    authentications.put("{{name}}", new HttpBasicAuth());{{/isBasic}}{{#isApiKey}}
+    authentications.put("{{name}}", new ApiKeyAuth({{#isKeyInHeader}}"header"{{/isKeyInHeader}}{{^isKeyInHeader}}"query"{{/isKeyInHeader}}, "{{keyParamName}}"));{{/isApiKey}}{{#isOAuth}}
+    authentications.put("{{name}}", new OAuth());{{/isOAuth}}{{/authMethods}}
+    // Prevent the authentications from being modified.
+    authentications = Collections.unmodifiableMap(authentications);
   }
 
   public String getBasePath() {
@@ -62,6 +78,75 @@ public class ApiClient {
     return this;
   }
 
+  /**
+   * Get authentications (key: authentication name, value: authentication).
+   */
+  public Map<String, Authentication> getAuthentications() {
+    return authentications;
+  }
+
+  /**
+   * Get authentication for the given name.
+   *
+   * @param authName The authentication name
+   * @return The authentication, null if not found
+   */
+  public Authentication getAuthentication(String authName) {
+    return authentications.get(authName);
+  }
+
+  /**
+   * Helper method to set username for the first HTTP basic authentication.
+   */
+  public void setUsername(String username) {
+    for (Authentication auth : authentications.values()) {
+      if (auth instanceof HttpBasicAuth) {
+        ((HttpBasicAuth) auth).setUsername(username);
+        return;
+      }
+    }
+    throw new RuntimeException("No HTTP basic authentication configured!");
+  }
+
+  /**
+   * Helper method to set password for the first HTTP basic authentication.
+   */
+  public void setPassword(String password) {
+    for (Authentication auth : authentications.values()) {
+      if (auth instanceof HttpBasicAuth) {
+        ((HttpBasicAuth) auth).setPassword(password);
+        return;
+      }
+    }
+    throw new RuntimeException("No HTTP basic authentication configured!");
+  }
+
+  /**
+   * Helper method to set API key value for the first API key authentication.
+   */
+  public void setApiKey(String apiKey) {
+    for (Authentication auth : authentications.values()) {
+      if (auth instanceof ApiKeyAuth) {
+        ((ApiKeyAuth) auth).setApiKey(apiKey);
+        return;
+      }
+    }
+    throw new RuntimeException("No API key authentication configured!");
+  }
+
+  /**
+   * Helper method to set API key prefix for the first API key authentication.
+   */
+  public void setApiKeyPrefix(String apiKeyPrefix) {
+    for (Authentication auth : authentications.values()) {
+      if (auth instanceof ApiKeyAuth) {
+        ((ApiKeyAuth) auth).setApiKeyPrefix(apiKeyPrefix);
+        return;
+      }
+    }
+    throw new RuntimeException("No API key authentication configured!");
+  }
+
   /**
    * Set the User-Agent header's value (by adding to the default header map).
    */
@@ -222,13 +307,15 @@ public class ApiClient {
    * @param headerParams The header parameters
    * @param formParams The form parameters
    * @param contentType The request Content-Type
+   * @param authNames The authentications to apply
    * @return The response body in type of string
    */
-  public String invokeAPI(String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String contentType) throws ApiException {
+  public String invokeAPI(String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String contentType, String[] authNames) throws ApiException {
+    updateParamsForAuth(authNames, queryParams, headerParams);
+
     Client client = getClient();
 
     StringBuilder b = new StringBuilder();
-
     for(String key : queryParams.keySet()) {
       String value = queryParams.get(key);
       if (value != null){
@@ -329,6 +416,19 @@ public class ApiClient {
     }
   }
 
+  /**
+   * Update query and header parameters based on authentication settings.
+   *
+   * @param authNames The authentications to apply
+   */
+  private void updateParamsForAuth(String[] authNames, Map<String, String> queryParams, Map<String, String> headerParams) {
+    for (String authName : authNames) {
+      Authentication auth = authentications.get(authName);
+      if (auth == null) throw new RuntimeException("Authentication undefined: " + authName);
+      auth.applyToParams(queryParams, headerParams);
+    }
+  }
+
   /**
    * Encode the given form parameters as request body.
    */

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

@@ -9,7 +9,7 @@ public class Configuration {
    */
   public static ApiClient getDefaultApiClient() {
     return defaultApiClient;
-  }
+   }
 
   /**
    * Set the default API client, which would be used when creating API

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

@@ -102,7 +102,8 @@ public class {{classname}} {
     }
 
     try {
-      String response = apiClient.invokeAPI(path, "{{httpMethod}}", queryParams, postBody, headerParams, formParams, contentType);
+      String[] authNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
+      String response = apiClient.invokeAPI(path, "{{httpMethod}}", queryParams, postBody, headerParams, formParams, contentType, authNames);
       if(response != null){
         return {{#returnType}}({{{returnType}}}) apiClient.deserialize(response, "{{returnContainer}}", {{returnBaseType}}.class){{/returnType}};
       }

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

@@ -0,0 +1,55 @@
+package {{invokerPackage}}.auth;
+
+import java.util.Map;
+
+public class ApiKeyAuth implements Authentication {
+  private final String location;
+  private final String paramName;
+
+  private String apiKey;
+  private String apiKeyPrefix;
+
+  public ApiKeyAuth(String location, String paramName) {
+    this.location = location;
+    this.paramName = paramName;
+  }
+
+  public String getLocation() {
+    return location;
+  }
+
+  public String getParamName() {
+    return paramName;
+  }
+
+  public String getApiKey() {
+    return apiKey;
+  }
+
+  public void setApiKey(String apiKey) {
+    this.apiKey = apiKey;
+  }
+
+  public String getApiKeyPrefix() {
+    return apiKeyPrefix;
+  }
+
+  public void setApiKeyPrefix(String apiKeyPrefix) {
+    this.apiKeyPrefix = apiKeyPrefix;
+  }
+
+  @Override
+  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+    String value;
+    if (apiKeyPrefix != null) {
+      value = apiKeyPrefix + " " + apiKey;
+    } else {
+      value = apiKey;
+    }
+    if (location == "query") {
+      queryParams.put(paramName, value);
+    } else if (location == "header") {
+      headerParams.put(paramName, value);
+    }
+  }
+}

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

@@ -0,0 +1,8 @@
+package {{invokerPackage}}.auth;
+
+import java.util.Map;
+
+public interface Authentication {
+  /** Apply authentication settings to header and query params. */
+  void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams);
+}

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

@@ -0,0 +1,37 @@
+package {{invokerPackage}}.auth;
+
+import java.util.Map;
+
+import java.io.UnsupportedEncodingException;
+import javax.xml.bind.DatatypeConverter;
+
+public class HttpBasicAuth implements Authentication {
+  private String username;
+  private String password;
+
+  public String getUsername() {
+    return username;
+  }
+
+  public void setUsername(String username) {
+    this.username = username;
+  }
+
+  public String getPassword() {
+    return password;
+  }
+
+  public void setPassword(String password) {
+    this.password = password;
+  }
+
+  @Override
+  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+    String str = (username == null ? "" : username) + ":" + (password == null ? "" : password);
+    try {
+      headerParams.put("Authorization", "Basic " + DatatypeConverter.printBase64Binary(str.getBytes("UTF-8")));
+    } catch (UnsupportedEncodingException e) {
+      throw new RuntimeException(e);
+    }
+  }
+}

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

@@ -0,0 +1,10 @@
+package {{invokerPackage}}.auth;
+
+import java.util.Map;
+
+public class OAuth implements Authentication {
+  @Override
+  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+    // TODO: support oauth
+  }
+}