[Java] Implemented support for Play! 2.5.x (java8) for retrofit2 client

bin/java-petstore-retrofit2-all.sh

@@ -1,6 +1,7 @@
 #!/bin/sh
 
 ./bin/java-petstore-retrofit2-play24.sh
+./bin/java-petstore-retrofit2-play25.sh
 ./bin/java-petstore-retrofit2.sh
 ./bin/java-petstore-retrofit2rx.sh
 ./bin/java-petstore-retrofit2rx2.sh

bin/java-petstore-retrofit2-play24.json

@@ -1 +1 @@
-{"useBeanValidation":"true","enableBuilderSupport":"true","library":"retrofit2","usePlay24WS":"true","dateLibrary":"java8"}
+{"useBeanValidation":"true","enableBuilderSupport":"true","library":"retrofit2","usePlayWS":"true","playVersion":"play24","dateLibrary":"java8"}

bin/java-petstore-retrofit2-play25.json

@@ -0,0 +1 @@
+{"useBeanValidation":"true","enableBuilderSupport":"true","library":"retrofit2","usePlayWS":"true","playVersion":"play25"}

bin/java-petstore-retrofit2-play25.sh

@@ -0,0 +1,34 @@
+#!/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-with-fake-endpoints-models-for-testing.yaml -l java -c bin/java-petstore-retrofit2-play25.json -o samples/client/petstore/java/retrofit2-play25 -DhideGenerationTimestamp=true"
+
+echo "Removing files and folders under samples/client/petstore/java/retrofit2-play25/src/main"
+rm -rf samples/client/petstore/java/retrofit2-play25/src/main
+find samples/client/petstore/java/retrofit2-play25 -maxdepth 1 -type f ! -name "README.md" -exec rm {} +
+java $JAVA_OPTS -jar $executable $ags

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

@@ -25,18 +25,23 @@ public class JavaClientCodegen extends AbstractJavaCodegen
     public static final String USE_RX_JAVA = "useRxJava";
     public static final String USE_RX_JAVA2 = "useRxJava2";
     public static final String DO_NOT_USE_RX = "doNotUseRx";
-    public static final String USE_PLAY24_WS = "usePlay24WS";
+    public static final String USE_PLAY_WS = "usePlayWS";
+    public static final String PLAY_VERSION = "playVersion";
     public static final String PARCELABLE_MODEL = "parcelableModel";
     public static final String USE_RUNTIME_EXCEPTION = "useRuntimeException";
 
+    public static final String PLAY_24 = "play24";
+    public static final String PLAY_25 = "play25";
+
     public static final String RETROFIT_1 = "retrofit";
     public static final String RETROFIT_2 = "retrofit2";
 
     protected String gradleWrapperPackage = "gradle.wrapper";
     protected boolean useRxJava = false;
     protected boolean useRxJava2 = false;
     protected boolean doNotUseRx = true; // backwards compatibility for swagger configs that specify neither rx1 nor rx2 (mustache does not allow for boolean operators so we need this extra field)
-    protected boolean usePlay24WS = false;
+    protected boolean usePlayWS = false;
+    protected String playVersion = PLAY_25;
     protected boolean parcelableModel = false;
     protected boolean useBeanValidation = false;
     protected boolean performBeanValidation = false;
@@ -55,7 +60,8 @@ public JavaClientCodegen() {
         cliOptions.add(CliOption.newBoolean(USE_RX_JAVA, "Whether to use the RxJava adapter with the retrofit2 library."));
         cliOptions.add(CliOption.newBoolean(USE_RX_JAVA2, "Whether to use the RxJava2 adapter with the retrofit2 library."));
         cliOptions.add(CliOption.newBoolean(PARCELABLE_MODEL, "Whether to generate models for Android that implement Parcelable with the okhttp-gson library."));
-        cliOptions.add(CliOption.newBoolean(USE_PLAY24_WS, "Use Play! 2.4 Async HTTP client (Play WS API)"));
+        cliOptions.add(CliOption.newBoolean(USE_PLAY_WS, "Use Play! Async HTTP client (Play WS API)"));
+        cliOptions.add(CliOption.newString(PLAY_VERSION, "Version of Play! Framework (possible values \"play24\", \"play25\")"));
         cliOptions.add(CliOption.newBoolean(SUPPORT_JAVA6, "Whether to support Java6 with the Jersey1 library."));
         cliOptions.add(CliOption.newBoolean(USE_BEANVALIDATION, "Use BeanValidation API annotations"));
         cliOptions.add(CliOption.newBoolean(PERFORM_BEANVALIDATION, "Perform BeanValidation"));
@@ -111,10 +117,15 @@ public void processOpts() {
         if (!useRxJava && !useRxJava2) {
             additionalProperties.put(DO_NOT_USE_RX, true);
         }
-        if (additionalProperties.containsKey(USE_PLAY24_WS)) {
-            this.setUsePlay24WS(Boolean.valueOf(additionalProperties.get(USE_PLAY24_WS).toString()));
+        if (additionalProperties.containsKey(USE_PLAY_WS)) {
+            this.setUsePlayWS(Boolean.valueOf(additionalProperties.get(USE_PLAY_WS).toString()));
+        }
+        additionalProperties.put(USE_PLAY_WS, usePlayWS);
+
+        if (additionalProperties.containsKey(PLAY_VERSION)) {
+            this.setPlayVersion(additionalProperties.get(PLAY_VERSION).toString());
         }
-        additionalProperties.put(USE_PLAY24_WS, usePlay24WS);
+        additionalProperties.put(PLAY_VERSION, playVersion);
 
         if (additionalProperties.containsKey(PARCELABLE_MODEL)) {
             this.setParcelableModel(Boolean.valueOf(additionalProperties.get(PARCELABLE_MODEL).toString()));
@@ -204,7 +215,7 @@ public void processOpts() {
             supportingFiles.add(new SupportingFile("auth/OAuthOkHttpClient.mustache", authFolder, "OAuthOkHttpClient.java"));
             supportingFiles.add(new SupportingFile("CollectionFormats.mustache", invokerFolder, "CollectionFormats.java"));
             additionalProperties.put("gson", "true");
-            if ("retrofit2".equals(getLibrary()) && !usePlay24WS) {
+            if ("retrofit2".equals(getLibrary()) && !usePlayWS) {
                 supportingFiles.add(new SupportingFile("JSON.mustache", invokerFolder, "JSON.java"));
             }
         } else if ("jersey2".equals(getLibrary()) || "resteasy".equals(getLibrary()))  {
@@ -228,8 +239,8 @@ public void processOpts() {
             LOGGER.error("Unknown library option (-l/--library): " + getLibrary());
         }
 
-        if (usePlay24WS) {
-            // remove unsupported auth
+        if (usePlayWS) {
+            // remove unsupported auth 
             Iterator<SupportingFile> iter = supportingFiles.iterator();
             while (iter.hasNext()) {
                 SupportingFile sf = iter.next();
@@ -238,27 +249,39 @@ public void processOpts() {
                 }
             }
 
-            // auth
-            supportingFiles.add(new SupportingFile("play24/auth/ApiKeyAuth.mustache", authFolder, "ApiKeyAuth.java"));
+            apiTemplateFiles.remove("api.mustache");
+
+            if (PLAY_24.equals(playVersion)) {
+                additionalProperties.put(PLAY_24, true);
+                apiTemplateFiles.put("play24/api.mustache", ".java");
+
+                supportingFiles.add(new SupportingFile("play24/ApiClient.mustache", invokerFolder, "ApiClient.java"));
+                supportingFiles.add(new SupportingFile("play24/Play24CallFactory.mustache", invokerFolder, "Play24CallFactory.java"));
+                supportingFiles.add(new SupportingFile("play24/Play24CallAdapterFactory.mustache", invokerFolder,
+                        "Play24CallAdapterFactory.java"));
+            } else {
+                additionalProperties.put(PLAY_25, true);
+                apiTemplateFiles.put("play25/api.mustache", ".java");
+
+                supportingFiles.add(new SupportingFile("play25/ApiClient.mustache", invokerFolder, "ApiClient.java"));
+                supportingFiles.add(new SupportingFile("play25/Play25CallFactory.mustache", invokerFolder, "Play25CallFactory.java"));
+                supportingFiles.add(new SupportingFile("play25/Play25CallAdapterFactory.mustache", invokerFolder,
+                        "Play25CallAdapterFactory.java"));
+                additionalProperties.put("java8", "true");
+            }
+
+            supportingFiles.add(new SupportingFile("play-common/auth/ApiKeyAuth.mustache", authFolder, "ApiKeyAuth.java"));
             supportingFiles.add(new SupportingFile("auth/Authentication.mustache", authFolder, "Authentication.java"));
             supportingFiles.add(new SupportingFile("Pair.mustache", invokerFolder, "Pair.java"));
-
-            // api client
-            supportingFiles.add(new SupportingFile("play24/ApiClient.mustache", invokerFolder, "ApiClient.java"));
-
-            // adapters
-            supportingFiles
-                    .add(new SupportingFile("play24/Play24CallFactory.mustache", invokerFolder, "Play24CallFactory.java"));
-            supportingFiles.add(new SupportingFile("play24/Play24CallAdapterFactory.mustache", invokerFolder,
-                    "Play24CallAdapterFactory.java"));
+
             additionalProperties.put("jackson", "true");
             additionalProperties.remove("gson");
         }
 
-        if (additionalProperties.containsKey("jackson") ) {
+        if (additionalProperties.containsKey("jackson")) {
             supportingFiles.add(new SupportingFile("RFC3339DateFormat.mustache", invokerFolder, "RFC3339DateFormat.java"));
-            if ("threetenbp".equals(dateLibrary)) {
-                supportingFiles.add(new SupportingFile("CustomInstantDeserializer.mustache", invokerFolder, "CustomInstantDeserializer.java"));
+            if (!"threetenbp".equals(dateLibrary)) {
+                supportingFiles.remove("CustomInstantDeserializer.mustache");
             }
         }
     }
@@ -445,10 +468,13 @@ public void setDoNotUseRx(boolean doNotUseRx) {
         this.doNotUseRx = doNotUseRx;
     }
 
-    public void setUsePlay24WS(boolean usePlay24WS) {
-        this.usePlay24WS = usePlay24WS;
+    public void setUsePlayWS(boolean usePlayWS) {
+        this.usePlayWS = usePlayWS;
     }
 
+    public void setPlayVersion(String playVersion) {
+        this.playVersion = playVersion;
+    }
 
     public void setParcelableModel(boolean parcelableModel) {
         this.parcelableModel = parcelableModel;

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

@@ -25,11 +25,6 @@ import java.util.List;
 import java.util.Map;
 {{/fullJavaUtil}}
 
-{{#usePlay24WS}}
-import play.libs.F;
-import retrofit2.Response;
-{{/usePlay24WS}}
-
 {{#operations}}
 public interface {{classname}} {
   {{#operation}}
@@ -60,7 +55,7 @@ public interface {{classname}} {
   {{/prioritizedContentTypes}}
   {{/formParams}}  
   @{{httpMethod}}("{{{path}}}")
-  {{^usePlay24WS}}{{^doNotUseRx}}Observable{{/doNotUseRx}}{{#doNotUseRx}}Call{{/doNotUseRx}}{{/usePlay24WS}}{{#usePlay24WS}}F.Promise<Response{{/usePlay24WS}}<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Object{{/returnType}}>{{#usePlay24WS}}>{{/usePlay24WS}} {{operationId}}({{^allParams}});{{/allParams}}
+  {{^doNotUseRx}}Observable{{/doNotUseRx}}{{#doNotUseRx}}Call{{/doNotUseRx}}<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Object{{/returnType}}> {{operationId}}({{^allParams}});{{/allParams}}
     {{#allParams}}{{>libraries/retrofit2/queryParams}}{{>libraries/retrofit2/pathParams}}{{>libraries/retrofit2/headerParams}}{{>libraries/retrofit2/bodyParams}}{{>libraries/retrofit2/formParams}}{{#hasMore}}, {{/hasMore}}{{^hasMore}}
   );{{/hasMore}}{{/allParams}}
 

modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/build.gradle.mustache

@@ -101,14 +101,17 @@ if(hasProperty('target') && target == 'android') {
 
 ext {
     oltu_version = "1.0.1"
-    {{^usePlay24WS}}
     retrofit_version = "2.3.0"
-    {{/usePlay24WS}}
-    {{#usePlay24WS}}
-    retrofit_version = "2.1.0"
-    jackson_version = "2.8.9"
+    {{#usePlayWS}}
+    {{#play24}}
+    jackson_version = "2.6.6"
     play_version = "2.4.11"
-    {{/usePlay24WS}}
+    {{/play24}}
+    {{#play25}}
+    jackson_version = "2.7.8"
+    play_version = "2.5.14"
+    {{/play25}}
+    {{/usePlayWS}}
     swagger_annotations_version = "1.5.15"
     junit_version = "4.12"
     {{#useRxJava}}
@@ -145,13 +148,13 @@ dependencies {
     {{#threetenbp}}
     compile "org.threeten:threetenbp:$threetenbp_version"
     {{/threetenbp}}
-    {{#usePlay24WS}}
+    {{#usePlayWS}}
     compile "com.typesafe.play:play-java-ws_2.11:$play_version"
     compile "com.squareup.retrofit2:converter-jackson:$retrofit_version"
     compile "com.fasterxml.jackson.core:jackson-core:$jackson_version"
     compile "com.fasterxml.jackson.core:jackson-annotations:$jackson_version"
     compile "com.fasterxml.jackson.datatype:jackson-datatype-{{^java8}}joda{{/java8}}{{#java8}}jsr310{{/java8}}:$jackson_version"
-    {{/usePlay24WS}}
+    {{/usePlayWS}}
 
     testCompile "junit:junit:$junit_version"
 }

modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/build.sbt.mustache

@@ -9,23 +9,28 @@ lazy val root = (project in file(".")).
     publishArtifact in (Compile, packageDoc) := false,
     resolvers += Resolver.mavenLocal,
     libraryDependencies ++= Seq(
-      {{^usePlay24WS}}
       "com.squareup.retrofit2" % "retrofit" % "2.3.0" % "compile",
       "com.squareup.retrofit2" % "converter-scalars" % "2.3.0" % "compile",
+      {{^usePlayWS}}
       "com.squareup.retrofit2" % "converter-gson" % "2.3.0" % "compile",
-      {{/usePlay24WS}}
-      {{#usePlay24WS}}
+      {{/usePlayWS}}
+      {{#usePlayWS}}
+      {{#play24}}
       "com.typesafe.play" % "play-java-ws_2.11" % "2.4.11" % "compile",
-      "com.squareup.retrofit2" % "retrofit" % "2.1.0" % "compile",
-      "com.squareup.retrofit2" % "converter-scalars" % "2.1.0" % "compile",
-      "com.squareup.retrofit2" % "converter-gson" % "2.1.0" % "compile",
-      "com.squareup.retrofit2" % "converter-jackson" % "2.1.0" % "compile",
-      "com.fasterxml.jackson.core" % "jackson-core" % "2.8.9" % "compile",
-      "com.fasterxml.jackson.core" % "jackson-annotations" % "2.8.9" % "compile",
-      "com.fasterxml.jackson.core" % "jackson-databind" % "2.8.9" % "compile",
-      {{/usePlay24WS}}
+      "com.fasterxml.jackson.core" % "jackson-core" % "2.6.6" % "compile",
+      "com.fasterxml.jackson.core" % "jackson-annotations" % "2.6.6" % "compile",
+      "com.fasterxml.jackson.core" % "jackson-databind" % "2.6.6" % "compile",
+      {{/play24}}
+      {{#play25}}
+      "com.typesafe.play" % "play-java-ws_2.11" % "2.5.15" % "compile",
+      "com.fasterxml.jackson.core" % "jackson-core" % "2.7.8" % "compile",
+      "com.fasterxml.jackson.core" % "jackson-annotations" % "2.7.8" % "compile",
+      "com.fasterxml.jackson.core" % "jackson-databind" % "2.7.8" % "compile",
+      {{/play25}}
+      "com.squareup.retrofit2" % "converter-jackson" % "2.3.0" % "compile",
+      {{/usePlayWS}}
       {{#useRxJava}}
-      "com.squareup.retrofit2" % "adapter-rxjava" % "{{^usePlay24WS}}2.3.0{{/usePlay24WS}}{{#usePlay24WS}}2.1.0{{/usePlay24WS}}" % "compile",
+      "com.squareup.retrofit2" % "adapter-rxjava" % "2.3.0" % "compile",
       "io.reactivex" % "rxjava" % "1.3.0" % "compile",
       {{/useRxJava}}
       {{#useRxJava2}}

modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/formParams.mustache

@@ -1 +1 @@
-{{#isFormParam}}{{#notFile}}{{#isMultipart}}@retrofit2.http.Part{{/isMultipart}}{{^isMultipart}}@retrofit2.http.Field{{/isMultipart}}("{{baseName}}") {{{dataType}}} {{paramName}}{{/notFile}}{{#isFile}}{{#isMultipart}}@retrofit2.http.Part{{/isMultipart}}{{^isMultipart}}@retrofit2.http.Field{{/isMultipart}}("{{baseName}}\"; filename=\"{{baseName}}") RequestBody {{paramName}}{{/isFile}}{{/isFormParam}}
+{{#isFormParam}}{{#notFile}}{{#isMultipart}}@retrofit2.http.Part{{/isMultipart}}{{^isMultipart}}@retrofit2.http.Field{{/isMultipart}}("{{baseName}}") {{{dataType}}} {{paramName}}{{/notFile}}{{#isFile}}{{#isMultipart}}@retrofit2.http.Part{{/isMultipart}}{{^isMultipart}}@retrofit2.http.Field{{/isMultipart}} okhttp3.MultipartBody.Part {{paramName}}{{/isFile}}{{/isFormParam}}

modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/formParams.mustache.save

@@ -1 +1 @@
-{{#isFormParam}}{{#notFile}}{{#isMultipart}}retrofit.http@retrofit2.http.Part{{/isMultipart}}{{^isMultipart}}@Field{{/isMultipart}}("{{baseName}}") {{{dataType}}} {{paramName}}{{/notFile}}{{#isFile}}{{#isMultipart}}@Part{{/isMultipart}}{{^isMultipart}}@Field{{/isMultipart}}("{{baseName}}\"; filename=\"{{baseName}}") RequestBody {{paramName}}{{/isFile}}{{/isFormParam}}
+{{#isFormParam}}{{#notFile}}{{#isMultipart}}retrofit.http@retrofit2.http.Part{{/isMultipart}}{{^isMultipart}}@Field{{/isMultipart}}("{{baseName}}") {{{dataType}}} {{paramName}}{{/notFile}}{{#isFile}}{{#isMultipart}}@Part{{/isMultipart}}{{^isMultipart}}@Field{{/isMultipart}} okhttp3.MultipartBody.Part {{paramName}}{{/isFile}}{{/isFormParam}}

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

@@ -0,0 +1,57 @@
+package {{package}};
+
+import {{invokerPackage}}.CollectionFormats.*;
+
+{{#useRxJava}}import rx.Observable;{{/useRxJava}}
+{{#useRxJava2}}import io.reactivex.Observable;{{/useRxJava2}}
+{{#doNotUseRx}}import retrofit2.Call;{{/doNotUseRx}}
+import retrofit2.http.*;
+
+import okhttp3.RequestBody;
+
+{{#imports}}import {{import}};
+{{/imports}}
+
+{{^fullJavaUtil}}
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+{{/fullJavaUtil}}
+
+import play.libs.F;
+import retrofit2.Response;
+
+{{#operations}}
+public interface {{classname}} {
+  {{#operation}}
+  /**
+   * {{summary}}
+   * {{notes}}
+{{#allParams}}
+   * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
+{{/allParams}}
+   * @return Call<{{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}Object{{/returnType}}>
+   */
+  {{#formParams}}
+  {{#-first}}
+  {{#isMultipart}}@retrofit2.http.Multipart{{/isMultipart}}{{^isMultipart}}@retrofit2.http.FormUrlEncoded{{/isMultipart}}
+  {{/-first}}
+  {{/formParams}}
+  {{^formParams}}
+  {{#prioritizedContentTypes}}
+  {{#-first}}
+  @Headers({
+    "Content-Type:{{mediaType}}"
+  })
+  {{/-first}}
+  {{/prioritizedContentTypes}}
+  {{/formParams}}  
+  @{{httpMethod}}("{{{path}}}")
+  F.Promise<Response<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Object{{/returnType}}>> {{operationId}}({{^allParams}});{{/allParams}}
+    {{#allParams}}{{>libraries/retrofit2/queryParams}}{{>libraries/retrofit2/pathParams}}{{>libraries/retrofit2/headerParams}}{{>libraries/retrofit2/bodyParams}}{{>libraries/retrofit2/formParams}}{{#hasMore}}, {{/hasMore}}{{^hasMore}}
+  );{{/hasMore}}{{/allParams}}
+
+  {{/operation}}
+}
+{{/operations}}