Read unknown enum values using default value (#557)

* Rename DeploymentStatusEnum to DeploymentStatus
ClouDesire · Sep 7, 2020 · 20392eb · 20392eb
1 parent 3c269f0
commit 20392eb
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 74 deletions.
diff --git a/base-api-client/src/main/java/com/cloudesire/platform/apiclient/ObjectMapperFactory.java b/base-api-client/src/main/java/com/cloudesire/platform/apiclient/ObjectMapperFactory.java
@@ -62,6 +62,8 @@ private static Map<DeserializationFeature, Boolean> defaultDeserialization()
     {
         Map<DeserializationFeature, Boolean> map = new EnumMap<>( DeserializationFeature.class );
         map.put( DeserializationFeature.READ_ENUMS_USING_TO_STRING, true );
+        map.put( DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL, true );
+        map.put( DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE, true );
         map.put( DeserializationFeature.FAIL_ON_NUMBERS_FOR_ENUMS, true );
         map.put( DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false );
         return map;

diff --git a/...to/src/main/java/com/cloudesire/platform/apiclient/dto/model/dto/BaseSubscriptionDTO.java b/...to/src/main/java/com/cloudesire/platform/apiclient/dto/model/dto/BaseSubscriptionDTO.java
@@ -1,6 +1,6 @@
 package com.cloudesire.platform.apiclient.dto.model.dto;
 
-import com.cloudesire.platform.apiclient.dto.model.enums.DeploymentStatusEnum;
+import com.cloudesire.platform.apiclient.dto.model.enums.DeploymentStatus;
 import io.swagger.annotations.ApiModelProperty;
 import org.hibernate.validator.constraints.Length;
 
@@ -26,7 +26,7 @@ public abstract class BaseSubscriptionDTO extends NamedEntityDTO
     private Date endDate;
 
     @ApiModelProperty( value = "Current status of the subscription", readOnly = true )
-    private DeploymentStatusEnum deploymentStatus;
+    private DeploymentStatus deploymentStatus;
 
     @Valid
     private Set<UrlEntityDTO> virtualMachineInstance = new HashSet<>();
@@ -147,12 +147,12 @@ public void setEndDate( Date endDate )
         this.endDate = endDate;
     }
 
-    public DeploymentStatusEnum getDeploymentStatus()
+    public DeploymentStatus getDeploymentStatus()
     {
         return deploymentStatus;
     }
 
-    public void setDeploymentStatus( DeploymentStatusEnum deploymentStatus )
+    public void setDeploymentStatus( DeploymentStatus deploymentStatus )
     {
         this.deploymentStatus = deploymentStatus;
     }

diff --git a/...o/src/main/java/com/cloudesire/platform/apiclient/dto/model/dto/SubscriptionPatchDTO.java b/...o/src/main/java/com/cloudesire/platform/apiclient/dto/model/dto/SubscriptionPatchDTO.java
@@ -1,6 +1,6 @@
 package com.cloudesire.platform.apiclient.dto.model.dto;
 
-import com.cloudesire.platform.apiclient.dto.model.enums.DeploymentStatusEnum;
+import com.cloudesire.platform.apiclient.dto.model.enums.DeploymentStatus;
 import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 
@@ -21,7 +21,7 @@ public class SubscriptionPatchDTO extends DTO
     private Map<UrlEntityDTO, String> configurationParameters;
 
     @ApiModelProperty( "Deployment status of the subscription" )
-    private DeploymentStatusEnum deploymentStatus;
+    private DeploymentStatus deploymentStatus;
 
     @ApiModelProperty( hidden = true )
     @Deprecated
@@ -101,12 +101,12 @@ public SubscriptionPatchDTO setConfigurationParameters( Map<UrlEntityDTO, String
         return this;
     }
 
-    public DeploymentStatusEnum getDeploymentStatus()
+    public DeploymentStatus getDeploymentStatus()
     {
         return deploymentStatus;
     }
 
-    public SubscriptionPatchDTO setDeploymentStatus( DeploymentStatusEnum deploymentStatus )
+    public SubscriptionPatchDTO setDeploymentStatus( DeploymentStatus deploymentStatus )
     {
         this.deploymentStatus = deploymentStatus;
         return this;

diff --git a/...dto/src/main/java/com/cloudesire/platform/apiclient/dto/model/enums/DeploymentStatus.java b/...dto/src/main/java/com/cloudesire/platform/apiclient/dto/model/enums/DeploymentStatus.java
@@ -0,0 +1,28 @@
+package com.cloudesire.platform.apiclient.dto.model.enums;
+
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
+@ApiModel( "Deployment status of a subscription" )
+public enum DeploymentStatus
+{
+    @ApiModelProperty( "Waiting for deploy" )
+    PENDING,
+    DEPLOYED,
+    UNDEPLOYED,
+    STOPPED,
+    FAILED,
+    @ApiModelProperty( "Requires approval by admin" )
+    REQUIRES_APPROVAL,
+    @ApiModelProperty( "Undeploy request has been sent" )
+    UNDEPLOY_SENT,
+    @ApiModelProperty( "Requires post-configuration" )
+    POST_CONFIGURATION,
+    @ApiModelProperty( "Waiting for invoice payment" )
+    WAITING_PAYMENT,
+    @ApiModelProperty( "Invoice payment time expired" )
+    PAYMENT_EXPIRED,
+    @JsonEnumDefaultValue
+    UNKNOWN
+}
diff --git a/...src/main/java/com/cloudesire/platform/apiclient/dto/model/enums/DeploymentStatusEnum.java b/...src/main/java/com/cloudesire/platform/apiclient/dto/model/enums/DeploymentStatusEnum.java
diff --git a/...src/main/java/com/cloudesire/platform/apiclient/dto/model/filters/SubscriptionFilter.java b/...src/main/java/com/cloudesire/platform/apiclient/dto/model/filters/SubscriptionFilter.java
@@ -1,7 +1,7 @@
 package com.cloudesire.platform.apiclient.dto.model.filters;
 
 import com.cloudesire.platform.apiclient.dto.model.dto.PageRequestDTO;
-import com.cloudesire.platform.apiclient.dto.model.enums.DeploymentStatusEnum;
+import com.cloudesire.platform.apiclient.dto.model.enums.DeploymentStatus;
 import com.cloudesire.platform.apiclient.dto.model.enums.OrderType;
 import com.cloudesire.platform.apiclient.dto.model.enums.ProductType;
 import io.swagger.annotations.ApiModelProperty;
@@ -18,7 +18,7 @@ public final class SubscriptionFilter extends PageRequestDTO
     private Map<String, String> metadata;
 
     @ApiModelProperty( "Filter by deployment status" )
-    private Set<DeploymentStatusEnum> status;
+    private Set<DeploymentStatus> status;
 
     @ApiModelProperty( "Filter by Order type" )
     private OrderType type;
@@ -48,12 +48,12 @@ public void setMetadata( Map<String, String> metadata )
         this.metadata = metadata;
     }
 
-    public Set<DeploymentStatusEnum> getStatus()
+    public Set<DeploymentStatus> getStatus()
     {
         return status;
     }
 
-    public void setStatus( Set<DeploymentStatusEnum> status )
+    public void setStatus( Set<DeploymentStatus> status )
     {
         this.status = status;
     }

diff --git a/...e-api-client/src/main/java/com/cloudesire/platform/apiclient/query/SubscriptionQuery.java b/...e-api-client/src/main/java/com/cloudesire/platform/apiclient/query/SubscriptionQuery.java
@@ -1,6 +1,6 @@
 package com.cloudesire.platform.apiclient.query;
 
-import com.cloudesire.platform.apiclient.dto.model.enums.DeploymentStatusEnum;
+import com.cloudesire.platform.apiclient.dto.model.enums.DeploymentStatus;
 import com.cloudesire.platform.apiclient.dto.model.enums.OrderType;
 import com.cloudesire.platform.apiclient.dto.model.enums.ProductType;
 import org.apache.commons.lang3.StringUtils;
@@ -31,7 +31,7 @@ public SubscriptionQuery setFilter( String value )
         return this;
     }
 
-    public SubscriptionQuery setStatus( DeploymentStatusEnum... values )
+    public SubscriptionQuery setStatus( DeploymentStatus... values )
     {
         String value = StringUtils.join( values, ',' );
         put( STATUS, value );