[JAXRS-RS-CDI] Add a basic JAX-RS Application and CDI fixes

bin/jaxrs-cxf-cdi-petstore-server.sh

@@ -26,6 +26,6 @@ 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 -t modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml -l jaxrs-cxf-cdi -o samples/server/petstore/jaxrs-cxf-cdi -DhideGenerationTimestamp=true"
+ags="$@ generate -t modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf-cdi -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml -l jaxrs-cxf-cdi -o samples/server/petstore/jaxrs-cxf-cdi -DhideGenerationTimestamp=true"
 
 java $JAVA_OPTS -jar $executable $ags

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

@@ -1,12 +1,22 @@
 package io.swagger.codegen.languages;
 
-import io.swagger.codegen.*;
 import io.swagger.codegen.CodegenModel;
 import io.swagger.codegen.CodegenProperty;
+import io.swagger.codegen.SupportingFile;
 
 import java.io.File;
 
+/**
+ * Generates a Java JAXRS Server according to JAXRS 2.0 specification, assuming an
+ * Apache CXF runtime and a Java EE runtime with CDI enabled.
+ * Similar to the original JAXRS generator, this creates API and Service classes
+ * in /src/gen/java and a sample ServiceImpl in /src/main/java. The API uses CDI
+ * to get an instance of ServiceImpl that implements the Service interface.
+ */
 public class JavaJAXRSCXFCDIServerCodegen extends JavaJAXRSSpecServerCodegen {
+    /**
+     * Default constructor
+     */
     public JavaJAXRSCXFCDIServerCodegen() {
         outputFolder = "generated-code/JavaJaxRS-CXF-CDI";
         artifactId = "swagger-jaxrs-cxf-cdi-server";
@@ -20,7 +30,8 @@ public JavaJAXRSCXFCDIServerCodegen() {
         typeMapping.put("DateTime", "java.util.Date");
 
         // Updated template directory
-        embeddedTemplateDir = templateDir = JAXRS_TEMPLATE_DIRECTORY_NAME + File.separator + "cxf-cdi";
+        embeddedTemplateDir = templateDir = JAXRS_TEMPLATE_DIRECTORY_NAME
+                + File.separator + "cxf-cdi";
     }
 
     @Override
@@ -31,8 +42,21 @@ public String getName() {
     @Override
     public void processOpts() {
         super.processOpts();
+
         supportingFiles.clear(); // Don't need extra files provided by AbstractJAX-RS & Java Codegen
+
+        // writeOptional means these files are only written if they don't already exist
+
+        // POM
         writeOptional(outputFolder, new SupportingFile("pom.mustache", "", "pom.xml"));
+
+        // RestApplication into src/main/java
+        writeOptional(outputFolder, new SupportingFile("RestApplication.mustache",
+                (implFolder + '/' + invokerPackage).replace(".", "/"), "RestApplication.java"));
+
+        // Make CDI work in containers with implicit archive scanning disabled
+        writeOptional(outputFolder, new SupportingFile("beans.mustache",
+                "src/main/webapp/WEB-INF", "beans.xml"));
     }
 
     @Override
@@ -45,7 +69,8 @@ public void postProcessModelProperty(CodegenModel model, CodegenProperty propert
 
     @Override
     public String getHelp() {
-        return "Generates a Java JAXRS Server according to JAXRS 2.0 specification, assuming an Apache CXF runtime and a Java EE runtime with CDI enabled.";
+        return "Generates a Java JAXRS Server according to JAXRS 2.0 specification, assuming an "
+                + "Apache CXF runtime and a Java EE runtime with CDI enabled.";
     }
 
 }

modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf-cdi/RestApplication.mustache

@@ -0,0 +1,9 @@
+package {{invokerPackage}};
+
+import javax.ws.rs.ApplicationPath;
+import javax.ws.rs.core.Application;
+
+@ApplicationPath("/")
+public class RestApplication extends Application {
+  // Add implementation-specific details here
+}

modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf-cdi/beans.mustache

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://java.sun.com/xml/ns/javaee"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="
+        http://java.sun.com/xml/ns/javaee
+        http://java.sun.com/xml/ns/javaee/beans_1_0.xsd">
+
+  <!--
+    This is just an empty file so that CDI archive scanning kicks in when
+    implicit archive scanning is disabled (such as on IBM Bluemix)
+  -->
+
+</beans>

samples/server/petstore/jaxrs-cxf-cdi/src/gen/java/io/swagger/api/PetApi.java

@@ -3,78 +3,164 @@
 import java.io.File;
 import io.swagger.model.ModelApiResponse;
 import io.swagger.model.Pet;
+import io.swagger.api.PetApiService;
 
-import java.io.InputStream;
-import java.io.OutputStream;
-import java.util.List;
-import java.util.Map;
 import javax.ws.rs.*;
+import javax.ws.rs.core.Context;
 import javax.ws.rs.core.Response;
+import javax.ws.rs.core.SecurityContext;
+import javax.enterprise.context.RequestScoped;
+import javax.inject.Inject;
+
+import io.swagger.annotations.*;
+
+import org.apache.cxf.jaxrs.ext.multipart.Attachment;
+
+import java.util.List;
+
+@Path("/pet")
+@RequestScoped
 
-import org.apache.cxf.jaxrs.ext.multipart.*;
+@Api(description = "the pet API")
 
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
 
-@Path("/")
-@Api(value = "/", description = "")
-public interface PetApi  {
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaJAXRSCXFCDIServerCodegen", date = "2016-11-17T08:53:42.205Z")
+
+public class PetApi  {
+
+  @Context SecurityContext securityContext;
+
+  @Inject PetApiService delegate;
+
 
     @POST
 
     @Consumes({ "application/json", "application/xml" })
     @Produces({ "application/xml", "application/json" })
-    @ApiOperation(value = "Add a new pet to the store", tags={ "pet",  })
-    public void  addPet(Pet body);
+    @ApiOperation(value = "Add a new pet to the store", notes = "", response = void.class, authorizations = {
+        @Authorization(value = "petstore_auth", scopes = {
+            @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
+            @AuthorizationScope(scope = "read:pets", description = "read your pets")
+        })
+    }, tags={ "pet",  })
+    @ApiResponses(value = { 
+        @ApiResponse(code = 405, message = "Invalid input", response = void.class) })
+    public Response addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true) Pet body) {
+    	return delegate.addPet(body, securityContext);
+    }
 
     @DELETE
     @Path("/{petId}")
 
     @Produces({ "application/xml", "application/json" })
-    @ApiOperation(value = "Deletes a pet", tags={ "pet",  })
-    public void  deletePet(@PathParam("petId") Long petId, @HeaderParam("api_key") String apiKey);
+    @ApiOperation(value = "Deletes a pet", notes = "", response = void.class, authorizations = {
+        @Authorization(value = "petstore_auth", scopes = {
+            @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
+            @AuthorizationScope(scope = "read:pets", description = "read your pets")
+        })
+    }, tags={ "pet",  })
+    @ApiResponses(value = { 
+        @ApiResponse(code = 400, message = "Invalid pet value", response = void.class) })
+    public Response deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathParam("petId") Long petId, @ApiParam(value = "" )@HeaderParam("api_key") String apiKey) {
+    	return delegate.deletePet(petId, apiKey, securityContext);
+    }
 
     @GET
     @Path("/findByStatus")
 
     @Produces({ "application/xml", "application/json" })
-    @ApiOperation(value = "Finds Pets by status", tags={ "pet",  })
-    public Pet  findPetsByStatus(@QueryParam("status")List<String> status);
+    @ApiOperation(value = "Finds Pets by status", notes = "Multiple status values can be provided with comma separated strings", response = Pet.class, responseContainer = "List", authorizations = {
+        @Authorization(value = "petstore_auth", scopes = {
+            @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
+            @AuthorizationScope(scope = "read:pets", description = "read your pets")
+        })
+    }, tags={ "pet",  })
+    @ApiResponses(value = { 
+        @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
+        @ApiResponse(code = 400, message = "Invalid status value", response = Pet.class, responseContainer = "List") })
+    public Response findPetsByStatus(@ApiParam(value = "Status values that need to be considered for filter",required=true, allowableValues="available, pending, sold")  @QueryParam("status") List<String> status) {
+    	return delegate.findPetsByStatus(status, securityContext);
+    }
 
     @GET
     @Path("/findByTags")
 
     @Produces({ "application/xml", "application/json" })
-    @ApiOperation(value = "Finds Pets by tags", tags={ "pet",  })
-    public Pet  findPetsByTags(@QueryParam("tags")List<String> tags);
+    @ApiOperation(value = "Finds Pets by tags", notes = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", response = Pet.class, responseContainer = "List", authorizations = {
+        @Authorization(value = "petstore_auth", scopes = {
+            @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
+            @AuthorizationScope(scope = "read:pets", description = "read your pets")
+        })
+    }, tags={ "pet",  })
+    @ApiResponses(value = { 
+        @ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
+        @ApiResponse(code = 400, message = "Invalid tag value", response = Pet.class, responseContainer = "List") })
+    public Response findPetsByTags(@ApiParam(value = "Tags to filter by",required=true)  @QueryParam("tags") List<String> tags) {
+    	return delegate.findPetsByTags(tags, securityContext);
+    }
 
     @GET
     @Path("/{petId}")
 
     @Produces({ "application/xml", "application/json" })
-    @ApiOperation(value = "Find pet by ID", tags={ "pet",  })
-    public Pet  getPetById(@PathParam("petId") Long petId);
+    @ApiOperation(value = "Find pet by ID", notes = "Returns a single pet", response = Pet.class, authorizations = {
+        @Authorization(value = "api_key")
+    }, tags={ "pet",  })
+    @ApiResponses(value = { 
+        @ApiResponse(code = 200, message = "successful operation", response = Pet.class),
+        @ApiResponse(code = 400, message = "Invalid ID supplied", response = Pet.class),
+        @ApiResponse(code = 404, message = "Pet not found", response = Pet.class) })
+    public Response getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathParam("petId") Long petId) {
+    	return delegate.getPetById(petId, securityContext);
+    }
 
     @PUT
 
     @Consumes({ "application/json", "application/xml" })
     @Produces({ "application/xml", "application/json" })
-    @ApiOperation(value = "Update an existing pet", tags={ "pet",  })
-    public void  updatePet(Pet body);
+    @ApiOperation(value = "Update an existing pet", notes = "", response = void.class, authorizations = {
+        @Authorization(value = "petstore_auth", scopes = {
+            @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
+            @AuthorizationScope(scope = "read:pets", description = "read your pets")
+        })
+    }, tags={ "pet",  })
+    @ApiResponses(value = { 
+        @ApiResponse(code = 400, message = "Invalid ID supplied", response = void.class),
+        @ApiResponse(code = 404, message = "Pet not found", response = void.class),
+        @ApiResponse(code = 405, message = "Validation exception", response = void.class) })
+    public Response updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true) Pet body) {
+    	return delegate.updatePet(body, securityContext);
+    }
 
     @POST
     @Path("/{petId}")
     @Consumes({ "application/x-www-form-urlencoded" })
     @Produces({ "application/xml", "application/json" })
-    @ApiOperation(value = "Updates a pet in the store with form data", tags={ "pet",  })
-    public void  updatePetWithForm(@PathParam("petId") Long petId, @Multipart(value = "name", required = false)  String name, @Multipart(value = "status", required = false)  String status);
+    @ApiOperation(value = "Updates a pet in the store with form data", notes = "", response = void.class, authorizations = {
+        @Authorization(value = "petstore_auth", scopes = {
+            @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
+            @AuthorizationScope(scope = "read:pets", description = "read your pets")
+        })
+    }, tags={ "pet",  })
+    @ApiResponses(value = { 
+        @ApiResponse(code = 405, message = "Invalid input", response = void.class) })
+    public Response updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathParam("petId") Long petId, @Multipart(value = "name", required = false)  String name, @Multipart(value = "status", required = false)  String status) {
+    	return delegate.updatePetWithForm(petId, name, status, securityContext);
+    }
 
     @POST
     @Path("/{petId}/uploadImage")
     @Consumes({ "multipart/form-data" })
     @Produces({ "application/json" })
-    @ApiOperation(value = "uploads an image", tags={ "pet" })
-    public ModelApiResponse  uploadFile(@PathParam("petId") Long petId, @Multipart(value = "additionalMetadata", required = false)  String additionalMetadata,  @Multipart(value = "file", required = false) InputStream fileInputStream,
-   @Multipart(value = "file" , required = false) Attachment fileDetail);
+    @ApiOperation(value = "uploads an image", notes = "", response = ModelApiResponse.class, authorizations = {
+        @Authorization(value = "petstore_auth", scopes = {
+            @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
+            @AuthorizationScope(scope = "read:pets", description = "read your pets")
+        })
+    }, tags={ "pet" })
+    @ApiResponses(value = { 
+        @ApiResponse(code = 200, message = "successful operation", response = ModelApiResponse.class) })
+    public Response uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathParam("petId") Long petId, @Multipart(value = "additionalMetadata", required = false)  String additionalMetadata,  @Multipart(value = "file", required = false) InputStream fileInputStream, @Multipart(value = "file" , required = false) Attachment fileDetail) {
+    	return delegate.uploadFile(petId, additionalMetadata, inputStream, fileDetail, securityContext);
+    }
 }
-

samples/server/petstore/jaxrs-cxf-cdi/src/gen/java/io/swagger/api/PetApiService.java

@@ -16,7 +16,7 @@
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.SecurityContext;
 
-@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaJAXRSCXFCDIServerCodegen", date = "2016-11-16T23:03:38.470+08:00")
+@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaJAXRSCXFCDIServerCodegen", date = "2016-11-17T08:53:42.205Z")
 public interface PetApiService {
       public Response addPet(Pet body, SecurityContext securityContext);
       public Response deletePet(Long petId, String apiKey, SecurityContext securityContext);