[spring] add an option to choose the response wrapper type

Also generate the spring-cloud sample with a HystrixCommand wrapper

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

@@ -17,6 +17,7 @@ public class SpringCodegen extends AbstractJavaCodegen {
     public static final String SINGLE_CONTENT_TYPES = "singleContentTypes";
     public static final String JAVA_8 = "java8";
     public static final String ASYNC = "async";
+    public static final String RESPONSE_WRAPPER = "responseWrapper";
     public static final String SPRING_MVC_LIBRARY = "spring-mvc";
     public static final String SPRING_CLOUD_LIBRARY = "spring-cloud";
 
@@ -27,6 +28,7 @@ public class SpringCodegen extends AbstractJavaCodegen {
     protected boolean singleContentTypes = false;
     protected boolean java8 = false;
     protected boolean async = false;
+    protected String responseWrapper = "";
 
     public SpringCodegen() {
         super();
@@ -51,6 +53,7 @@ public class SpringCodegen extends AbstractJavaCodegen {
         cliOptions.add(CliOption.newBoolean(SINGLE_CONTENT_TYPES, "Whether to select only one produces/consumes content-type by operation."));
         cliOptions.add(CliOption.newBoolean(JAVA_8, "use java8 default interface"));
         cliOptions.add(CliOption.newBoolean(ASYNC, "use async Callable controllers"));
+        cliOptions.add(new CliOption(RESPONSE_WRAPPER, "wrap the responses in given type (Future,Callable,CompletableFuture,ListenableFuture,DeferredResult,HystrixCommand,RxObservable,RxSingle or fully qualified type)"));
 
         supportedLibraries.put(DEFAULT_LIBRARY, "Spring-boot Server application using the SpringFox integration.");
         supportedLibraries.put(SPRING_MVC_LIBRARY, "Spring-MVC Server application using the SpringFox integration.");
@@ -117,6 +120,10 @@ public class SpringCodegen extends AbstractJavaCodegen {
             this.setAsync(Boolean.valueOf(additionalProperties.get(ASYNC).toString()));
         }
 
+        if (additionalProperties.containsKey(RESPONSE_WRAPPER)) {
+            this.setResponseWrapper((String) additionalProperties.get(RESPONSE_WRAPPER));
+        }
+
         supportingFiles.add(new SupportingFile("pom.mustache", "", "pom.xml"));
         supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
 
@@ -173,11 +180,43 @@ public class SpringCodegen extends AbstractJavaCodegen {
         if (this.java8) {
             additionalProperties.put("javaVersion", "1.8");
             additionalProperties.put("jdk8", "true");
+            if (this.async) {
+                additionalProperties.put(RESPONSE_WRAPPER, "CompletableFuture");
+            }
             typeMapping.put("date", "LocalDate");
             typeMapping.put("DateTime", "OffsetDateTime");
             importMapping.put("LocalDate", "java.time.LocalDate");
             importMapping.put("OffsetDateTime", "java.time.OffsetDateTime");
+        } else if (this.async) {
+            additionalProperties.put(RESPONSE_WRAPPER, "Callable");
         }
+
+        // Some well-known Spring or Spring-Cloud response wrappers
+        switch (this.responseWrapper) {
+            case "Future":
+            case "Callable":
+            case "CompletableFuture":
+                additionalProperties.put(RESPONSE_WRAPPER, "java.util.concurrent" + this.responseWrapper);
+                break;
+            case "ListenableFuture":
+                additionalProperties.put(RESPONSE_WRAPPER, "org.springframework.util.concurrent.ListenableFuture");
+                break;
+            case "DeferredResult":
+                additionalProperties.put(RESPONSE_WRAPPER, "org.springframework.web.context.request.DeferredResult");
+                break;
+            case "HystrixCommand":
+                additionalProperties.put(RESPONSE_WRAPPER, "com.netflix.hystrix.HystrixCommand");
+                break;
+            case "RxObservable":
+                additionalProperties.put(RESPONSE_WRAPPER, "rx.Observable");
+                break;
+            case "RxSingle":
+                additionalProperties.put(RESPONSE_WRAPPER, "rx.Single");
+                break;
+            default:
+                break;
+        }
+
     }
 
     @Override
@@ -355,6 +394,8 @@ public class SpringCodegen extends AbstractJavaCodegen {
 
     public void setAsync(boolean async) { this.async = async; }
 
+    public void setResponseWrapper(String responseWrapper) { this.responseWrapper = responseWrapper; }
+
     @Override
     public void postProcessModelProperty(CodegenModel model, CodegenProperty property) {
         super.postProcessModelProperty(model, property);

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

@@ -43,7 +43,7 @@ public interface {{classname}} {
         produces = { {{#produces}}"{{{mediaType}}}"{{#hasMore}}, {{/hasMore}}{{/produces}} }, {{/hasProduces}}{{#hasConsumes}}
         consumes = { {{#consumes}}"{{{mediaType}}}"{{#hasMore}}, {{/hasMore}}{{/consumes}} },{{/hasConsumes}}{{/singleContentTypes}}
         method = RequestMethod.{{httpMethod}})
-    {{#jdk8}}default {{/jdk8}}{{#async}}{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture<{{/jdk8}}{{/async}}ResponseEntity<{{>returnTypes}}>{{#async}}>{{/async}} {{operationId}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{#hasMore}},
+    {{#jdk8}}default {{/jdk8}}{{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{#hasMore}},
         {{/hasMore}}{{/allParams}}){{^jdk8}};{{/jdk8}}{{#jdk8}} {
         // do some magic!
         return {{#async}}CompletableFuture.completedFuture({{/async}}new ResponseEntity<{{>returnTypes}}>(HttpStatus.OK){{#async}}){{/async}};

modules/swagger-codegen/src/main/resources/JavaSpring/libraries/spring-cloud/pom.mustache

@@ -14,7 +14,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>1.3.6.RELEASE</version>
+        <version>1.4.1.RELEASE</version>
     </parent>
     <build>
         <sourceDirectory>src/main/java</sourceDirectory>
@@ -25,7 +25,7 @@
             <dependency>
                 <groupId>org.springframework.cloud</groupId>
                 <artifactId>spring-cloud-starter-parent</artifactId>
-                <version>Brixton.SR2</version>
+                <version>Camden.SR1</version>
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>

modules/swagger-codegen/src/test/java/io/swagger/codegen/options/SpringOptionsProvider.java

@@ -15,6 +15,7 @@ public class SpringOptionsProvider extends JavaOptionsProvider {
     public static final String SINGLE_CONTENT_TYPES = "true";
     public static final String JAVA_8 = "true";
     public static final String ASYNC = "true";
+    public static final String RESPONSE_WRAPPER = "Callable";
 
     @Override
     public String getLanguage() {
@@ -32,6 +33,7 @@ public class SpringOptionsProvider extends JavaOptionsProvider {
         options.put(SpringCodegen.SINGLE_CONTENT_TYPES, SINGLE_CONTENT_TYPES);
         options.put(SpringCodegen.JAVA_8, JAVA_8);
         options.put(SpringCodegen.ASYNC, ASYNC);
+        options.put(SpringCodegen.RESPONSE_WRAPPER, RESPONSE_WRAPPER);
 
         return options;
     }

modules/swagger-codegen/src/test/java/io/swagger/codegen/spring/SpringOptionsTest.java

@@ -64,6 +64,8 @@ public class SpringOptionsTest extends JavaClientOptionsTest {
             times = 1;
             clientCodegen.setAsync(Boolean.valueOf(SpringOptionsProvider.ASYNC));
             times = 1;
+            clientCodegen.setResponseWrapper(SpringOptionsProvider.RESPONSE_WRAPPER);
+            times = 1;
 
         }};
     }