Fixes for JAXRS-CXF Codegen

README.md

@@ -45,7 +45,7 @@ Check out [Swagger-Spec](https://github.com/OAI/OpenAPI-Specification) for addit
       - [Ruby Sinatra](#ruby-sinatra)
       - [Scala Scalatra](#scala-scalatra)
       - [Java JAX-RS (Java JAX-RS (Jersey v1.18)](#java-jax-rs-jersey-v118)
-      - [Java JAX-RS (Apache CXF 3)](#java-jax-rs-apache-cxf-3)
+      - [Java JAX-RS (Apache CXF 2 / 3)](#java-jax-rs-apache-cxf-2--3)
       - [Java Spring MVC](#java-spring-mvc)
       - [Haskell Servant](#haskell-servant)
       - [ASP.NET 5 Web API](#aspnet-5-web-api)
@@ -619,7 +619,7 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
   -o samples/server/petstore/jaxrs-jersey
 ```
 
-### Java JAX-RS (Apache CXF 3)
+### Java JAX-RS (Apache CXF 2 / 3)
 
 ```
 java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
@@ -628,6 +628,23 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
   -o samples/server/petstore/jaxrs-cxf
 ```
 
+This Codegen only generate a minimalist server stub. You must add the CXF dependency to your classpath (eg: with Maven)
+If you are using CXF v2.x, you must provided a custom ```ResourceComparator``` class. This class will help CXF to choose the good resource interface for mapping an incomming request. The default behavior of CXF v2.x is not correct when many resources interface have the same global path.
+See: See http://cxf.apache.org/docs/jax-rs-basics.html#JAX-RSBasics-Customselectionbetweenmultipleresources
+
+You can found this class here: https://github.com/hiveship/CXF2-resource-comparator/blob/master/src/main/java/CXFInterfaceComparator.java
+TODO: This class could be directly generated by the Codegen.
+
+You must register this class into your JAX-RS configuration file:
+```xml
+         <jaxrs:resourceComparator>
+   			<bean class="your.package.CXFInterfaceComparator"/>
+		</jaxrs:resourceComparator> 
+```
+
+This is no longer necessary if you are using CXF >=v3.x
+
+
 ### Java Spring MVC
 
 ```

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

@@ -2,20 +2,23 @@
 package io.swagger.codegen.languages;
 
 import java.io.File;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 
 import io.swagger.codegen.CliOption;
 import io.swagger.codegen.CodegenConstants;
+import io.swagger.codegen.CodegenModel;
 import io.swagger.codegen.CodegenOperation;
+import io.swagger.codegen.CodegenProperty;
 import io.swagger.models.Operation;
 
 public class JavaCXFServerCodegen extends AbstractJavaJAXRSServerCodegen
-{
+{	
 	public JavaCXFServerCodegen()
 	{
         super();
-
+        supportsInheritance = true;
         sourceFolder = "src/gen/java";
         invokerPackage = "io.swagger.api";
         artifactId = "swagger-jaxrs-server";
@@ -28,6 +31,11 @@ public JavaCXFServerCodegen()
 
         additionalProperties.put("title", title);
 
+        typeMapping.put("date", "LocalDate");
+        typeMapping.put("DateTime", "javax.xml.datatype.XMLGregorianCalendar"); // Map DateTime fields to Java standart class 'XMLGregorianCalendar'
+
+        importMapping.put("LocalDate", "org.joda.time.LocalDate");
+
         super.embeddedTemplateDir = templateDir = JAXRS_TEMPLATE_DIRECTORY_NAME + File.separator + "cxf";
 
         for ( int i = 0; i < cliOptions.size(); i++ ) {
@@ -36,36 +44,55 @@ public JavaCXFServerCodegen()
                 break;
             }
         }
-
-        cliOptions.add(new CliOption(CodegenConstants.IMPL_FOLDER, CodegenConstants.IMPL_FOLDER_DESC));
+
+        CliOption library = new CliOption(CodegenConstants.LIBRARY, "library template (sub-template) to use");
+        library.setDefault(DEFAULT_LIBRARY);
+
+        Map<String, String> supportedLibraries = new LinkedHashMap<String,String>();
+
+        supportedLibraries.put(DEFAULT_LIBRARY, "CXF");
+        library.setEnum(supportedLibraries);
+
+        cliOptions.add(library);
+        cliOptions.add(new CliOption(CodegenConstants.IMPL_FOLDER, CodegenConstants.IMPL_FOLDER_DESC));	
         cliOptions.add(new CliOption("title", "a title describing the application"));
 	}
-
+	
 	@Override
 	public void processOpts()
 	{
 		super.processOpts();
 		sourceFolder = "gen" + File.separator + "java";
-
-		modelTemplateFiles.clear();
-		modelTemplateFiles.put("entityModel.mustache", ".java");
-
-		supportingFiles.clear();
+		supportingFiles.clear(); // Don't need extra files provided by AbstractJAX-RS & Java Codegen
+      
+		//TODO
+		//final String invokerFolder = (sourceFolder + '/' + invokerPackage).replace(".", "/");
+        //supportingFiles.add(new SupportingFile("CXF2InterfaceComparator.mustache", invokerFolder, "CXF2InterfaceComparator.java"));
 	} 
 
 	@Override
 	public String getName()
 	{
 		return "jaxrs-cxf";
 	}
-
 
     @Override
     public void addOperationToGroup(String tag, String resourcePath, Operation operation, CodegenOperation co, Map<String, List<CodegenOperation>> operations) {
         super.addOperationToGroup(tag, resourcePath, operation, co, operations);        
         co.subresourceOperation = !co.path.isEmpty();
     }
-
+
+    @Override
+    public void postProcessModelProperty(CodegenModel model, CodegenProperty property) {
+        super.postProcessModelProperty(model, property);
+        model.imports.remove("ApiModelProperty");
+        model.imports.remove("ApiModel");
+        model.imports.remove("JsonSerialize");
+        model.imports.remove("ToStringSerializer");
+        model.imports.remove("JsonValue");
+        model.imports.remove("JsonProperty");
+    }
+
     @Override
     public String getHelp()
     {

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

@@ -13,7 +13,7 @@
 
 import java.util.*;
 
-public class JavaInflectorServerCodegen extends JavaClientCodegen implements CodegenConfig {
+public class JavaInflectorServerCodegen extends JavaClientCodegen {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(JavaInflectorServerCodegen.class);
 

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

@@ -0,0 +1,120 @@
+package {{package}};
+
+
+import java.lang.reflect.Method;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import javax.ws.rs.HttpMethod;
+import javax.ws.rs.Path;
+
+import org.apache.cxf.jaxrs.ext.ResourceComparator;
+import org.apache.cxf.jaxrs.model.ClassResourceInfo;
+import org.apache.cxf.jaxrs.model.OperationResourceInfo;
+import org.apache.cxf.message.Message;
+
+/**
+ * This class only help CXF to decide which resource interface is more suitable. It used Java reflexion to iterate over Java methods but it *DO NOT* select the target method.
+ */
+public class CXFInterfaceComparator implements ResourceComparator {
+
+   private static final Logger LOGGER = LoggerFactory.getLogger(CXFInterfaceComparator.class);
+
+   @Override
+   public int compare(ClassResourceInfo cri1, ClassResourceInfo cri2, Message message) {
+      String requestVerb = (String) message.get(Message.HTTP_REQUEST_METHOD);
+      String requestURI = (String) message.get(Message.REQUEST_URI);
+      String requestPath = requestURI.replace((String) message.get(Message.BASE_PATH), "");
+
+      // remove "/"at the end of requestPath if present
+      if (requestPath.endsWith("/")){
+         requestPath = requestPath.substring(0, requestPath.length()-1);
+      }
+
+      if (analyseInterface(cri1, requestPath, requestVerb)) {
+         return -1; // Indicate that 'cri1' interface should be preferred
+      } else if (analyseInterface(cri2, requestPath, requestVerb)) {
+         return 1; // Indicate that 'cri2' interface should be preferred
+      } else {
+         return 0; // Nothing match, leave CXF decision
+      }
+   }
+
+   /**
+    * Analyse each methods provided to check if there is a match with the
+    * message request path and request HTTP verb.
+    *
+    * @param cri
+    *            the interface to be analysed
+    * @param requestPath
+    *            the path of the request. Do not contains the host and base
+    *            path
+    * @return true if a method match the request, false otherwise
+    */
+   private static boolean analyseInterface(ClassResourceInfo cri, String requestPath, String requestVerb) {
+      assert cri.getServiceClass() != null;
+      assert cri.getServiceClass().getInterfaces() != null;
+      assert cri.getServiceClass().getInterfaces()[0] != null;
+      assert cri.getServiceClass().getInterfaces()[0].getMethods().length > 0;
+
+      Method[] methods = cri.getServiceClass().getInterfaces()[0].getMethods();
+      // Java reflexion. Check all the methods of an interface.
+      for (Method method : methods) {
+         Path pathAnnotation = method.getAnnotation(javax.ws.rs.Path.class);
+         if (pathAnnotation != null && pathAnnotation.value() != null) {
+            String pathValue = pathAnnotation.value();
+            String methodHttpVerb = getMethodHttpVerb(method);
+
+            // Always authorize OPTIONS request if the path is matching a method declaration
+            if (requestVerb.equals(HttpMethod.OPTIONS) && match(pathValue,requestPath)) {
+               return true;
+            }
+            // Also check the HTTP verb since a single path can be match do multiple request, depending of the HTTP request verb.
+            if (requestVerb.equals(methodHttpVerb) && match(pathValue, requestPath)) {
+               return true;
+            }
+         }
+      }
+      return false;
+   }
+
+   private static String getMethodHttpVerb(Method method) {
+      if (method.getAnnotation(javax.ws.rs.POST.class) != null) {
+         return HttpMethod.POST;
+      } else if (method.getAnnotation(javax.ws.rs.GET.class) != null) {
+         return HttpMethod.GET;
+      } else if (method.getAnnotation(javax.ws.rs.PUT.class) != null) {
+         return HttpMethod.PUT;
+      } else if (method.getAnnotation(javax.ws.rs.OPTIONS.class) != null) {
+         return HttpMethod.OPTIONS;
+      } else if (method.getAnnotation(javax.ws.rs.DELETE.class) != null) {
+         return HttpMethod.DELETE;
+      } else if (method.getAnnotation(javax.ws.rs.HEAD.class) != null) {
+         return HttpMethod.HEAD;
+      }
+      assert false;
+      return null;
+   }
+
+   /**
+    * Check whether if the pathValue match with the requestPath parameter.
+    * Every path params are considered to be declared as '{param}'. The tokens to start and close path params declaration are '{' and '}'.
+    *
+    * @param valueFromAnnotation
+    * @param valueFromRequest
+    * @return true if there is a match, false otherwise
+    */
+   private static boolean match(String valueFromAnnotation, String valueFromRequest) {
+      String patternFinal = valueFromAnnotation.replaceAll("\\{(.*?)\\}", "([^/]*)").replace("/", "\\/");
+      Matcher matcher = Pattern.compile(patternFinal).matcher(valueFromRequest);
+      if (matcher.matches()) {
+         return true;
+      }
+      return false;
+   }
+
+   @Override
+   public int compare(OperationResourceInfo ori1, OperationResourceInfo ori2, Message message) {
+      return 0; // Leave CXF decision
+   }
+}

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

@@ -6,16 +6,15 @@ package {{package}};
 import javax.ws.rs.*;
 import javax.ws.rs.core.Response;
 
-@Path("{{contextPath}}")
+@Path("/")
 public interface {{classname}}  {
 {{#operations}}
 {{#operation}}
     @{{httpMethod}}
     {{#subresourceOperation}}@Path("{{path}}"){{/subresourceOperation}}
     {{#hasConsumes}}@Consumes({ {{#consumes}}"{{mediaType}}"{{#hasMore}}, {{/hasMore}}{{/consumes}} }){{/hasConsumes}}
     {{#hasProduces}}@Produces({ {{#produces}}"{{mediaType}}"{{#hasMore}}, {{/hasMore}}{{/produces}} }){{/hasProduces}}
-    public Response {{nickname}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{#hasMore}},
-    {{/hasMore}}{{/allParams}});
+    public Response {{nickname}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{#hasMore}},{{/hasMore}}{{/allParams}});
 {{/operation}}
 }
 {{/operations}}

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

@@ -0,0 +1,16 @@
+import javax.xml.bind.annotation.XmlEnum;
+import javax.xml.bind.annotation.XmlType;
+
+@XmlType(name="{{classname}}")
+@XmlEnum
+public enum {{classname}} {
+    {{#allowableValues}}{{.}}{{^-last}}, {{/-last}}{{#-last}};{{/-last}}{{/allowableValues}}
+
+    public String value() {
+        return name();
+    }
+
+    public static {{classname}} fromValue(String v) {
+        return valueOf(v);
+    }
+}

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

@@ -1,15 +1,14 @@
 package {{package}};
 
-{{#imports}}import{{import}};
+{{#imports}}import {{import}};
 {{/imports}}
 
-{{#serializableModel}}import java.io.Serializable;{{/serializableModel}}
 {{#models}}
 {{#model}}{{#description}}
 /**
  * {{description}}
  **/{{/description}}
-{{#isEnum}}{{>enumOuterClass}}{{/isEnum}}
+{{#isEnum}}{{>enumClass}}{{/isEnum}}
 {{^isEnum}}{{>pojo}}{{/isEnum}}
 {{/model}}
 {{/models}}