[Java][Jersey2] Add JsonTypeName annotation

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java

@@ -49,9 +49,11 @@ public class CodegenModel implements IJsonSchemaValidationProperties {
     public Set<String> oneOf = new TreeSet<String>();
     public Set<String> allOf = new TreeSet<String>();
 
+    // The schema name as written in the OpenAPI document.
     public String name;
     // The language-specific name of the class that implements this schema.
     // The name of the class is derived from the OpenAPI schema name with formatting rules applied.
+    // The classname is derived from the OpenAPI schema name, with sanitization and escaping rules applied. 
     public String classname;
     // The value of the 'title' attribute in the OpenAPI document.
     public String title;
@@ -215,6 +217,17 @@ public void setClassVarName(String classVarName) {
         this.classVarName = classVarName;
     }
 
+    /**
+     * Return true if the classname property is sanitized, false if it is the same as the OpenAPI schema name.
+     * The OpenAPI schema name may be any valid JSON schema name, including non-ASCII characters.
+     * The name of the class may have to be sanitized with character escaping.
+     * 
+     * @return true if the classname property is sanitized
+     */
+    public boolean getIsClassnameSanitized() {
+        return !classname.equals(name);
+    }
+
     public String getClassname() {
         return classname;
     }

modules/openapi-generator/src/main/resources/Java/typeInfoAnnotation.mustache

@@ -5,4 +5,7 @@
   {{#discriminator.mappedModels}}
   @JsonSubTypes.Type(value = {{modelName}}.class, name = "{{^vendorExtensions.x-discriminator-value}}{{mappingName}}{{/vendorExtensions.x-discriminator-value}}{{#vendorExtensions.x-discriminator-value}}{{{vendorExtensions.x-discriminator-value}}}{{/vendorExtensions.x-discriminator-value}}"),
   {{/discriminator.mappedModels}}
+  {{#isClassnameSanitized}}
+  @JsonSubTypes.Type(value = {{classname}}.class, name = "{{name}}"),
+  {{/isClassnameSanitized}}
 }){{/jackson}}

modules/openapi-generator/src/test/resources/3_0/schema-with-special-characters.yaml

@@ -0,0 +1,59 @@
+openapi: 3.0.3
+info:
+  description: test
+  version: 1.0.0
+  title: test
+paths:
+  /test:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/MySchemaName._-Characters'
+      responses:
+        '200':
+          description: the response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MySchemaName._-Characters'
+components:
+  schemas:
+    Parent:
+      properties:
+        prop1:
+          type: string
+      discriminator:
+        propertyName: prop1
+    # Note: the name below with non-ASCII characters is a valid JSON schema name,
+    # however currently OpenAPI generator does not allow special characters beyond [.-_]
+    #
+    # The set of allowed characters for OpenAPI schema names is specified in RFC 8259
+    # at https://tools.ietf.org/html/rfc8259.
+    # The OpenAPI schema uses the JSON schema specification, which references RFC 8259.
+    # A string is a sequence of zero or more Unicode characters [UNICODE].
+    # Note that this citation references the latest version of Unicode
+    # rather than a specific release. Any character may be escaped.
+    # MySchemaNameWithUnusual#$12.3!@#%🍇🍅😀🏄🏾‍♂️Characters:
+    MySchemaName._-Characters:
+      description:
+        A schema name that has letters, numbers, punctuation and non-ASCII characters.
+        The sanitization rules should make it possible to generate a language-specific
+        classname with allowed characters in that programming language. 
+      allOf:
+        - $ref: '#/components/schemas/Parent'
+        - type: object
+          properties:
+            prop2:
+              type: string
+    # Below is a schema with the same name, except special characters have been removed.
+    #MySchemaNameCharacters:
+    #  description:
+    #    A schema with same name as above, without the special characters. 
+    #  allOf:
+    #    - $ref: '#/components/schemas/Parent'
+    #    - type: object
+    #      properties:
+    #        prop2:
+    #          type: string

samples/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/JSONTest.java

@@ -1,6 +1,7 @@
 package org.openapitools.client;
 
 import org.openapitools.client.model.Order;
+import org.openapitools.client.model.SpecialModelName;
 
 import java.lang.Exception;
 import java.util.Date;
@@ -71,4 +72,19 @@ public void testCustomDate() throws Exception {
         Order o = json.getContext(null).readValue(str, Order.class);
         assertEquals(dateStr, dateFormat.format(o.getShipDate()));
     }
+
+    /**
+     * Validate a schema with special characters can be deserialized. 
+     */
+    @Test
+    public void testSchemaWithSpecialCharacters() throws Exception {
+        String str = "{ \"$special[property.name]\": 12345 }";
+        // The name of the OpenAPI schema is '_special_model.name_'.
+        // After sanitization rules are applied the name of the class is 'SpecialModelName'.
+        // The class deserialization should be successful because
+        // of the @JsonSubTypes annotation.
+        SpecialModelName o = json.getContext(null).readValue(str, SpecialModelName.class);
+        assertNotNull(o);
+        assertEquals((long)12345, (long)o.get$SpecialPropertyName());
+    }    
 }

samples/openapi3/client/petstore/java/jersey2-java8/src/test/java/org/openapitools/client/JSONTest.java

@@ -1,6 +1,7 @@
 package org.openapitools.client;
 
 import org.openapitools.client.model.Order;
+import org.openapitools.client.model.SpecialModelName;
 
 import java.lang.Exception;
 import java.util.Date;
@@ -71,4 +72,19 @@ public void testCustomDate() throws Exception {
         Order o = json.getContext(null).readValue(str, Order.class);
         assertEquals(dateStr, dateFormat.format(o.getShipDate()));
     }
+
+    /**
+     * Validate a schema with special characters can be deserialized. 
+     */
+    @Test
+    public void testSchemaWithSpecialCharacters() throws Exception {
+        String str = "{ \"$special[property.name]\": 12345 }";
+        // The name of the OpenAPI schema is '_special_model.name_'.
+        // After sanitization rules are applied the name of the class is 'SpecialModelName'.
+        // The class deserialization should be successful because
+        // of the @JsonSubTypes annotation.
+        SpecialModelName o = json.getContext(null).readValue(str, SpecialModelName.class);
+        assertNotNull(o);
+        assertEquals((long)12345, (long)o.get$SpecialPropertyName());
+    }    
 }