Merge pull request #1162 from xhh/java-okhttp-gson

[Java] Add a new library template: okhttp-gson

Author: wing328

README.md

@@ -264,6 +264,7 @@ CONFIG OPTIONS
 	    library template (sub-template) to use:
 	    <default> - HTTP client: Jersey client 1.18. JSON processing: Jackson 2.4.2
 	    jersey2 - HTTP client: Jersey client 2.6
+	    okhttp-gson - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1
 ```
 
 Your config file for java can look like

bin/all-petstore.sh

@@ -25,6 +25,7 @@ cd $APP_DIR
 ./bin/html-petstore.sh
 ./bin/java-petstore.sh
 ./bin/java-petstore-jersey2.sh
+./bin/java-petstore-okhttp-gson.sh
 ./bin/jaxrs-petstore-server.sh
 ./bin/nodejs-petstore-server.sh
 ./bin/objc-petstore.sh

bin/java-petstore-okhttp-gson.json

@@ -0,0 +1,4 @@
+{
+    "library": "okhttp-gson",
+    "artifactId": "swagger-petstore-okhttp-gson"
+}

bin/java-petstore-okhttp-gson.sh

@@ -0,0 +1,31 @@
+#!/bin/sh
+
+SCRIPT="$0"
+
+while [ -h "$SCRIPT" ] ; do
+  ls=`ls -ld "$SCRIPT"`
+  link=`expr "$ls" : '.*-> \(.*\)$'`
+  if expr "$link" : '/.*' > /dev/null; then
+    SCRIPT="$link"
+  else
+    SCRIPT=`dirname "$SCRIPT"`/"$link"
+  fi
+done
+
+if [ ! -d "${APP_DIR}" ]; then
+  APP_DIR=`dirname "$SCRIPT"`/..
+  APP_DIR=`cd "${APP_DIR}"; pwd`
+fi
+
+executable="./modules/swagger-codegen-cli/target/swagger-codegen-cli.jar"
+
+if [ ! -f "$executable" ]
+then
+  mvn clean package
+fi
+
+# if you've executed sbt assembly previously it will use that instead.
+export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
+ags="$@ generate -i modules/swagger-codegen/src/test/resources/2_0/petstore.json -l java -c bin/java-petstore-okhttp-gson.json -o samples/client/petstore/java/okhttp-gson"
+
+java $JAVA_OPTS -jar $executable $ags

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavaClientCodegen.java

@@ -83,6 +83,7 @@ public JavaClientCodegen() {
 
         supportedLibraries.put("<default>", "HTTP client: Jersey client 1.18. JSON processing: Jackson 2.4.2");
         supportedLibraries.put("jersey2", "HTTP client: Jersey client 2.6");
+        supportedLibraries.put("okhttp-gson", "HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1");
         cliOptions.add(buildLibraryCliOption(supportedLibraries));
     }
 
@@ -159,7 +160,19 @@ public void processOpts() {
         supportingFiles.add(new SupportingFile("JSON.mustache", invokerFolder, "JSON.java"));
         supportingFiles.add(new SupportingFile("Pair.mustache", invokerFolder, "Pair.java"));
         supportingFiles.add(new SupportingFile("StringUtil.mustache", invokerFolder, "StringUtil.java"));
-        supportingFiles.add(new SupportingFile("TypeRef.mustache", invokerFolder, "TypeRef.java"));
+
+        // library-specific files
+        if ("okhttp-gson".equals(getLibrary())) {
+            // the "okhttp-gson" library template requires "ApiCallback.mustache" for async call
+            supportingFiles.add(new SupportingFile("ApiCallback.mustache", invokerFolder, "ApiCallback.java"));
+            // "build.gradle" is for development with Gradle
+            supportingFiles.add(new SupportingFile("build.gradle.mustache", "", "build.gradle"));
+            // "build.sbt" is for development with SBT
+            supportingFiles.add(new SupportingFile("build.sbt.mustache", "", "build.sbt"));
+            // and does not require "TypeRef.mustache"
+        } else {
+            supportingFiles.add(new SupportingFile("TypeRef.mustache", invokerFolder, "TypeRef.java"));
+        }
 
         final String authFolder = (sourceFolder + File.separator + invokerPackage + ".auth").replace(".", File.separator);
         supportingFiles.add(new SupportingFile("auth/Authentication.mustache", authFolder, "Authentication.java"));

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

@@ -39,4 +39,13 @@ public class StringUtil {
     }
     return out.toString();
   }
+
+  /**
+   * Convert the given object to string with each line indented by 4 spaces
+   * (except the first line).
+   */
+  public static String toIndentedString(Object o) {
+    if (o == null) return "null";
+    return o.toString().replace("\n", "\n    ");
+  }
 }

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

@@ -6,20 +6,45 @@ import java.util.List;
 {{>generatedAnnotation}}
 public class ApiException extends Exception {
   private int code = 0;
-  private String message = null;
   private Map<String, List<String>> responseHeaders = null;
   private String responseBody = null;
 
   public ApiException() {}
 
+  public ApiException(Throwable throwable) {
+    super(throwable);
+  }
+
+  public ApiException(String message) {
+    super(message);
+  }
+
+  public ApiException(String message, Throwable throwable, int code, Map<String, List<String>> responseHeaders, String responseBody) {
+    super(message, throwable);
+    this.code = code;
+    this.responseHeaders = responseHeaders;
+    this.responseBody = responseBody;
+  }
+
+  public ApiException(String message, int code, Map<String, List<String>> responseHeaders, String responseBody) {
+    this(message, (Throwable) null, code, responseHeaders, responseBody);
+  }
+
+  public ApiException(String message, Throwable throwable, int code, Map<String, List<String>> responseHeaders) {
+    this(message, throwable, code, responseHeaders, null);
+  }
+
+  public ApiException(int code, Map<String, List<String>> responseHeaders, String responseBody) {
+    this((String) null, (Throwable) null, code, responseHeaders, responseBody);
+  }
+
   public ApiException(int code, String message) {
+    super(message);
     this.code = code;
-    this.message = message;
   }
 
   public ApiException(int code, String message, Map<String, List<String>> responseHeaders, String responseBody) {
-    this.code = code;
-    this.message = message;
+    this(code, message);
     this.responseHeaders = responseHeaders;
     this.responseBody = responseBody;
   }
@@ -28,10 +53,6 @@ public class ApiException extends Exception {
     return code;
   }
 
-  public String getMessage() {
-    return message;
-  }
-
   /**
    * Get the HTTP response headers.
    */

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

@@ -0,0 +1,22 @@
+package {{invokerPackage}};
+
+import java.io.IOException;
+
+/**
+ * Callback for asynchronous API call.
+ *
+ * @param <T> The return type
+ */
+public interface ApiCallback<T> {
+  /**
+   * This is called when the API call fails.
+   */
+  void onFailure(ApiException e);
+
+  /**
+   * This is called when the API call succeeded.
+   *
+   * @param result The result deserialized from response
+   */
+  void onSuccess(T result);
+}