[Java][Jersey2] Fix typo and script, Log enhancements, HTTP signature, deserialization

CI/samples.ci/client/petstore/java/test-manual/jersey2-java8/JSONComposedSchemaTest.java

@@ -0,0 +1,68 @@
+package org.openapitools.client;
+
+import org.openapitools.client.model.Mammal;
+import org.openapitools.client.model.AppleReq;
+import org.openapitools.client.model.BananaReq;
+import org.openapitools.client.model.FruitReq;
+import org.openapitools.client.model.BasquePig;
+import org.openapitools.client.model.Pig;
+import org.openapitools.client.model.Whale;
+import org.openapitools.client.model.Zebra;
+import java.lang.Exception;
+
+import org.junit.*;
+import static org.junit.Assert.*;
+
+
+public class JSONComposedSchemaTest {
+    JSON json = null;
+    Mammal mammal = null;
+
+    @Before
+    public void setup() {
+        json = new JSON();
+        mammal = new Mammal();
+    }
+
+    /**
+     * Validate a oneOf schema can be deserialized into the expected class.
+     * The oneOf schema does not have a discriminator. 
+     */
+    @Test
+    public void testOneOfSchemaWithoutDiscriminator() throws Exception {
+        // BananaReq and AppleReq have explicitly defined properties that are different by name.
+        // There is no discriminator property.
+        String str = "{ \"cultivar\": \"golden delicious\", \"mealy\": false }";
+        FruitReq o = json.getContext(null).readValue(str, FruitReq.class);
+        assertTrue(o.getActualInstance() instanceof AppleReq);
+    }
+
+    /**
+     * Validate a oneOf schema can be deserialized into the expected class.
+     * The oneOf schema has a discriminator. 
+     */
+    @Test
+    public void testOneOfSchemaWithDiscriminator() throws Exception {
+        // Mammal can be one of whale, pig and zebra.
+        // pig has sub-classes.
+        String str = "{ \"className\": \"whale\", \"hasBaleen\": true, \"hasTeeth\": false }";
+        /*
+        DISABLING unit test for now until ambiguity of discriminator is resolved.
+
+        // Note that the 'zebra' schema does not have any explicit property defined AND
+        // it has additionalProperties: true. Hence without a discriminator the above
+        // JSON payload would match both 'whale' and 'zebra'. This is because the 'hasBaleen'
+        // and 'hasTeeth' would be considered additional (undeclared) properties for 'zebra'.
+        Mammal o = json.getContext(null).readValue(str, Mammal.class);
+        assertTrue(o.getActualInstance() instanceof Whale);
+
+        str = "{ \"className\": \"zebra\" }";
+        o = json.getContext(null).readValue(str, Mammal.class);
+        assertTrue(o.getActualInstance() instanceof Zebra);
+
+        str = "{ \"className\": \"BasquePig\" }";
+        o = json.getContext(null).readValue(str, Mammal.class);
+        assertTrue(o.getActualInstance() instanceof BasquePig);
+        */
+    }
+}

bin/java-petstore-jersey2-java8.sh

@@ -35,9 +35,9 @@ find samples/client/petstore/java/jersey2-java8 -maxdepth 1 -type f ! -name "REA
 java $JAVA_OPTS -jar $executable $ags
 
 # copy additional manually written unit-tests
-mkdir samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client
-mkdir samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/auth
-mkdir samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/model
+mkdir -p samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client
+mkdir -p samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/auth
+mkdir -p samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/model
 
 cp CI/samples.ci/client/petstore/java/test-manual/common/StringUtilTest.java samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/StringUtilTest.java
 cp CI/samples.ci/client/petstore/java/test-manual/jersey2/ApiClientTest.java samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/ApiClientTest.java

bin/openapi3/java-petstore-jersey2-java8.json

@@ -0,0 +1,5 @@
+{
+    "library": "jersey2",
+    "artifactId": "petstore-openapi3-jersey2-java8",
+    "dateLibrary": "java8"
+}

bin/openapi3/java-petstore-jersey2-java8.sh

@@ -0,0 +1,44 @@
+#!/bin/sh
+
+SCRIPT="$0"
+echo "# START SCRIPT: $SCRIPT"
+
+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/openapi-generator-cli/target/openapi-generator-cli.jar"
+
+if [ ! -f "$executable" ]
+then
+  mvn -B clean package
+fi
+
+# if you've executed sbt assembly previously it will use that instead.
+export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
+yaml="modules/openapi-generator/src/test/resources/3_0/python-experimental/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml"
+ags="generate --artifact-id petstore-openapi3-jersey2-java8 -i $yaml -g java -c bin/openapi3/java-petstore-jersey2-java8.json -o samples/openapi3/client/petstore/java/jersey2-java8 --additional-properties hideGenerationTimestamp=true --additional-properties serverPort=8082 $@"
+
+echo "Removing files and folders under samples/openapi3/client/petstore/java/jersey2-java8/src/main"
+rm -rf samples/openapi3/client/petstore/java/jersey2-java8/src/main
+find samples/openapi3/client/petstore/java/jersey2-java8 -maxdepth 1 -type f ! -name "README.md" -exec rm {} +
+java $JAVA_OPTS -jar $executable $ags
+
+# copy additional manually written unit-tests
+mkdir -p samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client
+mkdir -p samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/auth
+mkdir -p samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/model
+
+cp CI/samples.ci/client/petstore/java/test-manual/jersey2-java8/JSONTest.java samples/openapi3/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/JSONTest.java
+cp CI/samples.ci/client/petstore/java/test-manual/jersey2-java8/JSONComposedSchemaTest.java samples/openapi3/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/JSONComposedSchemaTest.java

bin/utils/ensure-up-to-date

@@ -40,6 +40,7 @@ declare -a samples=(
 "${root}/bin/python-server-all.sh"
 "${root}/bin/openapi3/python-petstore.sh"
 "${root}/bin/openapi3/python-experimental-petstore.sh"
+"${root}/bin/openapi3/java-petstore-jersey2-java8.sh"
 "${root}/bin/php-petstore.sh"
 "${root}/bin/php-silex-petstore-server.sh"
 "${root}/bin/php-symfony-petstore.sh"

modules/openapi-generator/src/main/resources/Java/libraries/jersey2/ApiClient.mustache

@@ -36,6 +36,8 @@ import org.glassfish.jersey.logging.LoggingFeature;
 import org.apache.commons.io.FileUtils;
 import org.glassfish.jersey.filter.LoggingFilter;
 {{/supportJava6}}
+import java.util.logging.Level;
+import java.util.logging.Logger;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Map;
@@ -73,6 +75,8 @@ public class ApiClient {
   protected Map<String, String> defaultHeaderMap = new HashMap<String, String>();
   protected Map<String, String> defaultCookieMap = new HashMap<String, String>();
   protected String basePath = "{{{basePath}}}";
+  private static final Logger log = Logger.getLogger(ApiClient.class.getName());
+
   protected List<ServerConfiguration> servers = new ArrayList<ServerConfiguration>({{#servers}}{{#-first}}Arrays.asList(
 {{/-first}}    new ServerConfiguration(
       "{{{url}}}",
@@ -928,6 +932,9 @@ public class ApiClient {
           }
         } catch (Exception ex) {
           // failed to deserialize, do nothing and try next one (schema)
+          // Logging the error may be useful to troubleshoot why a payload fails to match
+          // the schema.
+          log.log(Level.FINE, "Input data does not match schema '" + schemaName + "'", ex);
         }
       } else {// unknown type
         throw new ApiException(schemaType.getClass() + " is not a GenericType and cannot be handled properly in deserialization.");
@@ -938,7 +945,7 @@ public class ApiClient {
     if (matchCounter > 1 && "oneOf".equals(schema.getSchemaType())) {// more than 1 match for oneOf
       throw new ApiException("Response body is invalid as it matches more than one schema (" + StringUtil.join(matchSchemas, ", ") + ") defined in the oneOf model: " + schema.getClass().getName());
     } else if (matchCounter == 0) { // fail to match any in oneOf/anyOf schemas
-      throw new ApiException("Response body is invalid as it doens't match any schemas (" + StringUtil.join(schema.getSchemas().keySet(), ", ") + ") defined in the oneOf/anyOf model: " + schema.getClass().getName());
+      throw new ApiException("Response body is invalid as it does not match any schemas (" + StringUtil.join(schema.getSchemas().keySet(), ", ") + ") defined in the oneOf/anyOf model: " + schema.getClass().getName());
     } else { // only one matched
       schema.setActualInstance(result);
       return schema;

modules/openapi-generator/src/main/resources/Java/libraries/jersey2/anyof_model.mustache

@@ -1,6 +1,8 @@
 import javax.ws.rs.core.GenericType;
 import javax.ws.rs.core.Response;
 import java.io.IOException;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Map;
@@ -15,6 +17,8 @@ import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
 {{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{>xmlAnnotation}}
 @JsonDeserialize(using={{classname}}.{{classname}}Deserializer.class)
 public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-implements}}, {{{.}}}{{/vendorExtensions.x-implements}} {
+    private static final Logger log = Logger.getLogger({{classname}}.class.getName());
+
     public static class {{classname}}Deserializer extends StdDeserializer<{{classname}}> {
         public {{classname}}Deserializer() {
             this({{classname}}.class);
@@ -37,7 +41,8 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
                 ret.setActualInstance(deserialized);
                 return ret;
             } catch (Exception e) {
-                // deserialization failed, continue
+                // deserialization failed, continue, log to help debugging
+                log.log(Level.FINER, "Input data does not match '{{classname}}'", e);
             }
 
             {{/anyOf}}

modules/openapi-generator/src/main/resources/Java/libraries/jersey2/auth/HttpSignatureAuth.mustache

@@ -17,6 +17,7 @@ import java.util.Locale;
 import java.util.Map;
 import java.util.List;
 import java.security.spec.AlgorithmParameterSpec;
+import java.security.InvalidKeyException;
 
 import org.tomitribe.auth.signatures.Algorithm;
 import org.tomitribe.auth.signatures.Signer;
@@ -204,7 +205,7 @@ public class HttpSignatureAuth implements Authentication {
    * @throws InvalidKeyException Unable to parse the key, or the security provider for this key
    * is not installed.
    */
-  public void setPrivateKey(Key key) throws InvalidKeyException {
+  public void setPrivateKey(Key key) throws InvalidKeyException, ApiException {
     if (key == null) {
       throw new ApiException("Private key (java.security.Key) cannot be null");
     }

modules/openapi-generator/src/main/resources/Java/libraries/jersey2/oneof_model.mustache

@@ -1,6 +1,8 @@
 import javax.ws.rs.core.GenericType;
 import javax.ws.rs.core.Response;
 import java.io.IOException;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Map;
@@ -15,6 +17,8 @@ import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
 {{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{>xmlAnnotation}}
 @JsonDeserialize(using={{classname}}.{{classname}}Deserializer.class)
 public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-implements}}, {{{.}}}{{/vendorExtensions.x-implements}} {
+    private static final Logger log = Logger.getLogger({{classname}}.class.getName());
+
     public static class {{classname}}Deserializer extends StdDeserializer<{{classname}}> {
         public {{classname}}Deserializer() {
             this({{classname}}.class);
@@ -35,8 +39,10 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im
             try {
                 deserialized = tree.traverse(jp.getCodec()).readValueAs({{{.}}}.class);
                 match++;
+                log.log(Level.FINER, "Input data matches schema '{{{.}}}'");
             } catch (Exception e) {
                 // deserialization failed, continue
+                log.log(Level.FINER, "Input data does not match schema '{{{.}}}'", e);
             }
 
             {{/oneOf}}

pom.xml

@@ -703,6 +703,18 @@
                 <module>samples/client/petstore/java/jersey2-java8</module>
             </modules>
         </profile>
+        <profile>
+            <id>java-client-openapi3-jersey2-java8</id>
+            <activation>
+                <property>
+                    <name>env</name>
+                    <value>java</value>
+                </property>
+            </activation>
+            <modules>
+                <module>samples/openapi3/client/petstore/java/jersey2-java8</module>
+            </modules>
+        </profile>
         <profile>
             <id>java-client-okhttp-gson</id>
             <activation>
@@ -1252,6 +1264,7 @@
                 <module>samples/client/petstore/java/feign10x</module>
                 <module>samples/client/petstore/java/jersey1</module>
                 <module>samples/client/petstore/java/jersey2-java8</module>
+                <module>samples/openapi3/client/petstore/java/jersey2-java8</module>
                 <module>samples/client/petstore/java/okhttp-gson</module>
                 <module>samples/client/petstore/java/retrofit2</module>
                 <module>samples/client/petstore/java/retrofit2rx</module>

samples/client/petstore/java/jersey2-java8/src/main/java/org/openapitools/client/ApiClient.java

@@ -28,6 +28,8 @@
 import java.nio.file.Files;
 import java.nio.file.StandardCopyOption;
 import org.glassfish.jersey.logging.LoggingFeature;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Map;
@@ -60,6 +62,8 @@ public class ApiClient {
   protected Map<String, String> defaultHeaderMap = new HashMap<String, String>();
   protected Map<String, String> defaultCookieMap = new HashMap<String, String>();
   protected String basePath = "http://petstore.swagger.io:80/v2";
+  private static final Logger log = Logger.getLogger(ApiClient.class.getName());
+
   protected List<ServerConfiguration> servers = new ArrayList<ServerConfiguration>(Arrays.asList(
     new ServerConfiguration(
       "http://petstore.swagger.io:80/v2",
@@ -845,6 +849,9 @@ public AbstractOpenApiSchema deserializeSchemas(Response response, AbstractOpenA
           }
         } catch (Exception ex) {
           // failed to deserialize, do nothing and try next one (schema)
+          // Logging the error may be useful to troubleshoot why a payload fails to match
+          // the schema.
+          log.log(Level.FINE, "Input data does not match schema '" + schemaName + "'", ex);
         }
       } else {// unknown type
         throw new ApiException(schemaType.getClass() + " is not a GenericType and cannot be handled properly in deserialization.");
@@ -855,7 +862,7 @@ public AbstractOpenApiSchema deserializeSchemas(Response response, AbstractOpenA
     if (matchCounter > 1 && "oneOf".equals(schema.getSchemaType())) {// more than 1 match for oneOf
       throw new ApiException("Response body is invalid as it matches more than one schema (" + StringUtil.join(matchSchemas, ", ") + ") defined in the oneOf model: " + schema.getClass().getName());
     } else if (matchCounter == 0) { // fail to match any in oneOf/anyOf schemas
-      throw new ApiException("Response body is invalid as it doens't match any schemas (" + StringUtil.join(schema.getSchemas().keySet(), ", ") + ") defined in the oneOf/anyOf model: " + schema.getClass().getName());
+      throw new ApiException("Response body is invalid as it does not match any schemas (" + StringUtil.join(schema.getSchemas().keySet(), ", ") + ") defined in the oneOf/anyOf model: " + schema.getClass().getName());
     } else { // only one matched
       schema.setActualInstance(result);
       return schema;

samples/openapi3/client/petstore/java/jersey2-java8/.gitignore

@@ -0,0 +1,21 @@
+*.class
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.ear
+
+# exclude jar for gradle wrapper
+!gradle/wrapper/*.jar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+# build files
+**/target
+target
+.gradle
+build

samples/openapi3/client/petstore/java/jersey2-java8/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md