Skip to content

[Java] Discriminator lookup should not be case insensitive by default #5894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 6 commits into from
Apr 13, 2020
Merged

[Java] Discriminator lookup should not be case insensitive by default #5894

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
45793d3
Add 'discriminatorCaseSensitive' property
sebastien-rosset Apr 10, 2020
f8de4e9
Discriminator value lookup should not be case insensitive
sebastien-rosset Apr 10, 2020
08e46be
fix typo
sebastien-rosset Apr 10, 2020
65ac87b
run scripts
sebastien-rosset Apr 11, 2020
bf1ff59
execute ./bin/utils/export_docs_generators.sh
sebastien-rosset Apr 11, 2020
63ae8ff
fix discriminator mapping, add code comments
sebastien-rosset Apr 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Discriminator value lookup should not be case insensitive
  • Loading branch information
@sebastien-rosset
sebastien-rosset committed Apr 10, 2020
commit f8de4e9cf4b692e1666325e31c17ad6ec6c3a31e
13 changes: 10 additions & 3 deletions modules/openapi-generator/src/main/resources/Java/JSON.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ public class JSON {
public Class getClassForElement(JsonElement readElement) {
Map<String, Class> classByDiscriminatorValue = new HashMap<String, Class>();
{{#mappedModels}}
classByDiscriminatorValue.put("{{mappingName}}".toUpperCase(Locale.ROOT), {{modelName}}.class);
classByDiscriminatorValue.put("{{mappingName}}"{{^discriminatorCaseSensitive}}.toUpperCase(Locale.ROOT){{/discriminatorCaseSensitive}}, {{modelName}}.class);
{{/mappedModels}}
classByDiscriminatorValue.put("{{classname}}".toUpperCase(Locale.ROOT), {{classname}}.class);
classByDiscriminatorValue.put("{{classname}}"{{^discriminatorCaseSensitive}}.toUpperCase(Locale.ROOT){{/discriminatorCaseSensitive}}, {{classname}}.class);
return getClassByDiscriminator(classByDiscriminatorValue,
getDiscriminatorValue(readElement, "{{{propertyBaseName}}}"));
}
Expand All @@ -97,8 +97,15 @@ public class JSON {
return element.getAsString();
}

/**
* Returns the Java class that implements the OpenAPI schema for the specified discriminator value.
*
* @param classByDiscriminatorValue The map of discriminator values to Java classes.
* @param discriminatorValue The value of the OpenAPI discriminator in the input data.
* @return The Java class that implements the OpenAPI schema
*/
private static Class getClassByDiscriminator(Map classByDiscriminatorValue, String discriminatorValue) {
Class clazz = (Class) classByDiscriminatorValue.get(discriminatorValue.toUpperCase(Locale.ROOT));
Class clazz = (Class) classByDiscriminatorValue.get(discriminatorValue{{^discriminatorCaseSensitive}}.toUpperCase(Locale.ROOT){{/discriminatorCaseSensitive}});
if (null == clazz) {
throw new IllegalArgumentException("cannot determine model class of name: <" + discriminatorValue + ">");
}
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/java/feign/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion ...les/client/petstore/java/feign10x/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion ...t/petstore/java/google-api-client/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion ...lient/petstore/java/jersey2-java6/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion ...lient/petstore/java/jersey2-java8/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/java/jersey2/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/java/native/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
21 changes: 16 additions & 5 deletions ...petstore/java/okhttp-gson-parcelableModel/src/main/java/org/openapitools/client/JSON.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
import org.openapitools.client.model.*;
import okio.ByteString;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.io.IOException;
import java.io.StringReader;
import java.lang.reflect.Type;
Expand All @@ -49,17 +51,18 @@ public class JSON {
private OffsetDateTimeTypeAdapter offsetDateTimeTypeAdapter = new OffsetDateTimeTypeAdapter();
private LocalDateTypeAdapter localDateTypeAdapter = new LocalDateTypeAdapter();
private ByteArrayAdapter byteArrayAdapter = new ByteArrayAdapter();
private final Log log = LogFactory.getLog(JSON.class);

public static GsonBuilder createGson() {
GsonFireBuilder fireBuilder = new GsonFireBuilder()
.registerTypeSelector(Animal.class, new TypeSelector() {
@Override
public Class getClassForElement(JsonElement readElement) {
Map<String, Class> classByDiscriminatorValue = new HashMap<String, Class>();
classByDiscriminatorValue.put("Dog".toUpperCase(Locale.ROOT), Dog.class);
classByDiscriminatorValue.put("Cat".toUpperCase(Locale.ROOT), Cat.class);
classByDiscriminatorValue.put("BigCat".toUpperCase(Locale.ROOT), BigCat.class);
classByDiscriminatorValue.put("Animal".toUpperCase(Locale.ROOT), Animal.class);
classByDiscriminatorValue.put("Dog", Dog.class);
classByDiscriminatorValue.put("Cat", Cat.class);
classByDiscriminatorValue.put("BigCat", BigCat.class);
classByDiscriminatorValue.put("Animal", Animal.class);
return getClassByDiscriminator(classByDiscriminatorValue,
getDiscriminatorValue(readElement, "className"));
}
Expand All @@ -77,8 +80,16 @@ private static String getDiscriminatorValue(JsonElement readElement, String disc
return element.getAsString();
}

/**
* Returns the Java class that implements the OpenAPI schema for the specified discriminator value.
*
* @param classByDiscriminatorValue The map of discriminator values to Java classes.
* @param discriminatorValue The value of the OpenAPI discriminator in the input data.
* @return The Java class that implements the OpenAPI schema
*/
private static Class getClassByDiscriminator(Map classByDiscriminatorValue, String discriminatorValue) {
Class clazz = (Class) classByDiscriminatorValue.get(discriminatorValue.toUpperCase(Locale.ROOT));
log.debug("getClassByDiscriminator: {}", discriminatorValue);
Class clazz = (Class) classByDiscriminatorValue.get(discriminatorValue);
if (null == clazz) {
throw new IllegalArgumentException("cannot determine model class of name: <" + discriminatorValue + ">");
}
Expand Down
2 changes: 1 addition & 1 deletion .../java/okhttp-gson-parcelableModel/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
public class Animal implements Parcelable {
public static final String SERIALIZED_NAME_CLASS_NAME = "className";
@SerializedName(SERIALIZED_NAME_CLASS_NAME)
private String className;
protected String className;

public static final String SERIALIZED_NAME_COLOR = "color";
@SerializedName(SERIALIZED_NAME_COLOR)
Expand Down
21 changes: 16 additions & 5 deletions samples/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/JSON.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
import org.openapitools.client.model.*;
import okio.ByteString;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.io.IOException;
import java.io.StringReader;
import java.lang.reflect.Type;
Expand All @@ -49,17 +51,18 @@ public class JSON {
private OffsetDateTimeTypeAdapter offsetDateTimeTypeAdapter = new OffsetDateTimeTypeAdapter();
private LocalDateTypeAdapter localDateTypeAdapter = new LocalDateTypeAdapter();
private ByteArrayAdapter byteArrayAdapter = new ByteArrayAdapter();
private final Log log = LogFactory.getLog(JSON.class);

public static GsonBuilder createGson() {
GsonFireBuilder fireBuilder = new GsonFireBuilder()
.registerTypeSelector(Animal.class, new TypeSelector() {
@Override
public Class getClassForElement(JsonElement readElement) {
Map<String, Class> classByDiscriminatorValue = new HashMap<String, Class>();
classByDiscriminatorValue.put("Dog".toUpperCase(Locale.ROOT), Dog.class);
classByDiscriminatorValue.put("Cat".toUpperCase(Locale.ROOT), Cat.class);
classByDiscriminatorValue.put("BigCat".toUpperCase(Locale.ROOT), BigCat.class);
classByDiscriminatorValue.put("Animal".toUpperCase(Locale.ROOT), Animal.class);
classByDiscriminatorValue.put("Dog", Dog.class);
classByDiscriminatorValue.put("Cat", Cat.class);
classByDiscriminatorValue.put("BigCat", BigCat.class);
classByDiscriminatorValue.put("Animal", Animal.class);
return getClassByDiscriminator(classByDiscriminatorValue,
getDiscriminatorValue(readElement, "className"));
}
Expand All @@ -77,8 +80,16 @@ private static String getDiscriminatorValue(JsonElement readElement, String disc
return element.getAsString();
}

/**
* Returns the Java class that implements the OpenAPI schema for the specified discriminator value.
*
* @param classByDiscriminatorValue The map of discriminator values to Java classes.
* @param discriminatorValue The value of the OpenAPI discriminator in the input data.
* @return The Java class that implements the OpenAPI schema
*/
private static Class getClassByDiscriminator(Map classByDiscriminatorValue, String discriminatorValue) {
Class clazz = (Class) classByDiscriminatorValue.get(discriminatorValue.toUpperCase(Locale.ROOT));
log.debug("getClassByDiscriminator: {}", discriminatorValue);
Class clazz = (Class) classByDiscriminatorValue.get(discriminatorValue);
if (null == clazz) {
throw new IllegalArgumentException("cannot determine model class of name: <" + discriminatorValue + ">");
}
Expand Down
2 changes: 1 addition & 1 deletion .../client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
public class Animal {
public static final String SERIALIZED_NAME_CLASS_NAME = "className";
@SerializedName(SERIALIZED_NAME_CLASS_NAME)
private String className;
protected String className;

public static final String SERIALIZED_NAME_COLOR = "color";
@SerializedName(SERIALIZED_NAME_COLOR)
Expand Down
21 changes: 16 additions & 5 deletions samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/JSON.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
import org.openapitools.client.model.*;
import okio.ByteString;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.io.IOException;
import java.io.StringReader;
import java.lang.reflect.Type;
Expand All @@ -49,17 +51,18 @@ public class JSON {
private OffsetDateTimeTypeAdapter offsetDateTimeTypeAdapter = new OffsetDateTimeTypeAdapter();
private LocalDateTypeAdapter localDateTypeAdapter = new LocalDateTypeAdapter();
private ByteArrayAdapter byteArrayAdapter = new ByteArrayAdapter();
private final Log log = LogFactory.getLog(JSON.class);

public static GsonBuilder createGson() {
GsonFireBuilder fireBuilder = new GsonFireBuilder()
.registerTypeSelector(Animal.class, new TypeSelector() {
@Override
public Class getClassForElement(JsonElement readElement) {
Map<String, Class> classByDiscriminatorValue = new HashMap<String, Class>();
classByDiscriminatorValue.put("Dog".toUpperCase(Locale.ROOT), Dog.class);
classByDiscriminatorValue.put("Cat".toUpperCase(Locale.ROOT), Cat.class);
classByDiscriminatorValue.put("BigCat".toUpperCase(Locale.ROOT), BigCat.class);
classByDiscriminatorValue.put("Animal".toUpperCase(Locale.ROOT), Animal.class);
classByDiscriminatorValue.put("Dog", Dog.class);
classByDiscriminatorValue.put("Cat", Cat.class);
classByDiscriminatorValue.put("BigCat", BigCat.class);
classByDiscriminatorValue.put("Animal", Animal.class);
return getClassByDiscriminator(classByDiscriminatorValue,
getDiscriminatorValue(readElement, "className"));
}
Expand All @@ -77,8 +80,16 @@ private static String getDiscriminatorValue(JsonElement readElement, String disc
return element.getAsString();
}

/**
* Returns the Java class that implements the OpenAPI schema for the specified discriminator value.
*
* @param classByDiscriminatorValue The map of discriminator values to Java classes.
* @param discriminatorValue The value of the OpenAPI discriminator in the input data.
* @return The Java class that implements the OpenAPI schema
*/
private static Class getClassByDiscriminator(Map classByDiscriminatorValue, String discriminatorValue) {
Class clazz = (Class) classByDiscriminatorValue.get(discriminatorValue.toUpperCase(Locale.ROOT));
log.debug("getClassByDiscriminator: {}", discriminatorValue);
Class clazz = (Class) classByDiscriminatorValue.get(discriminatorValue);
if (null == clazz) {
throw new IllegalArgumentException("cannot determine model class of name: <" + discriminatorValue + ">");
}
Expand Down
2 changes: 1 addition & 1 deletion ...client/petstore/java/rest-assured/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
public class Animal {
public static final String SERIALIZED_NAME_CLASS_NAME = "className";
@SerializedName(SERIALIZED_NAME_CLASS_NAME)
private String className;
protected String className;

public static final String SERIALIZED_NAME_COLOR = "color";
@SerializedName(SERIALIZED_NAME_COLOR)
Expand Down
2 changes: 1 addition & 1 deletion ...les/client/petstore/java/resteasy/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion ...etstore/java/resttemplate-withXml/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
@XmlElement(name = "className")
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
@XmlElement(name = "color")
Expand Down
2 changes: 1 addition & 1 deletion ...client/petstore/java/resttemplate/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion ...les/client/petstore/java/retrofit/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
public class Animal {
public static final String SERIALIZED_NAME_CLASS_NAME = "className";
@SerializedName(SERIALIZED_NAME_CLASS_NAME)
private String className;
protected String className;

public static final String SERIALIZED_NAME_COLOR = "color";
@SerializedName(SERIALIZED_NAME_COLOR)
Expand Down
2 changes: 1 addition & 1 deletion ...nt/petstore/java/retrofit2-play24/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion ...nt/petstore/java/retrofit2-play25/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion ...nt/petstore/java/retrofit2-play26/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion ...es/client/petstore/java/retrofit2/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
public class Animal {
public static final String SERIALIZED_NAME_CLASS_NAME = "className";
@SerializedName(SERIALIZED_NAME_CLASS_NAME)
private String className;
protected String className;

public static final String SERIALIZED_NAME_COLOR = "color";
@SerializedName(SERIALIZED_NAME_COLOR)
Expand Down
2 changes: 1 addition & 1 deletion .../client/petstore/java/retrofit2rx/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
public class Animal {
public static final String SERIALIZED_NAME_CLASS_NAME = "className";
@SerializedName(SERIALIZED_NAME_CLASS_NAME)
private String className;
protected String className;

public static final String SERIALIZED_NAME_COLOR = "color";
@SerializedName(SERIALIZED_NAME_COLOR)
Expand Down
2 changes: 1 addition & 1 deletion ...client/petstore/java/retrofit2rx2/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
public class Animal {
public static final String SERIALIZED_NAME_CLASS_NAME = "className";
@SerializedName(SERIALIZED_NAME_CLASS_NAME)
private String className;
protected String className;

public static final String SERIALIZED_NAME_COLOR = "color";
@SerializedName(SERIALIZED_NAME_COLOR)
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/java/vertx/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down
2 changes: 1 addition & 1 deletion ...es/client/petstore/java/webclient/src/main/java/org/openapitools/client/model/Animal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@

public class Animal {
public static final String JSON_PROPERTY_CLASS_NAME = "className";
private String className;
protected String className;

public static final String JSON_PROPERTY_COLOR = "color";
private String color = "red";
Expand Down