feat(plan): API Publisher can ask for a mandatory comment while consu…

…mer is subscribing to the plan

Closes gravitee-io/issues#1660

gravitee-management-api-model/src/main/java/io/gravitee/management/model/NewPlanEntity.java

@@ -59,6 +59,9 @@ public class NewPlanEntity {
     @JsonProperty("excluded_groups")
     private List<String> excludedGroups;
 
+    @JsonProperty("comment_required")
+    private boolean commentRequired;
+
     public String getName() {
         return name;
     }
@@ -147,6 +150,14 @@ public void setSecurityDefinition(String securityDefinition) {
         this.securityDefinition = securityDefinition;
     }
 
+    public boolean isCommentRequired() {
+        return commentRequired;
+    }
+
+    public void setCommentRequired(boolean commentRequired) {
+        this.commentRequired = commentRequired;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;

gravitee-management-api-model/src/main/java/io/gravitee/management/model/PlanEntity.java

@@ -81,6 +81,9 @@ public class PlanEntity {
     @JsonProperty("excluded_groups")
     private List<String> excludedGroups;
 
+    @JsonProperty("comment_required")
+    private boolean commentRequired;
+
     public String getId() {
         return id;
     }
@@ -217,6 +220,14 @@ public void setExcludedGroups(List<String> excludedGroups) {
         this.excludedGroups = excludedGroups;
     }
 
+    public boolean isCommentRequired() {
+        return commentRequired;
+    }
+
+    public void setCommentRequired(boolean commentRequired) {
+        this.commentRequired = commentRequired;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;

gravitee-management-api-model/src/main/java/io/gravitee/management/model/UpdatePlanEntity.java

@@ -54,6 +54,9 @@ public class UpdatePlanEntity {
 
     private String securityDefinition;
 
+    @JsonProperty("comment_required")
+    private boolean commentRequired;
+
     public String getName() {
         return name;
     }
@@ -126,6 +129,14 @@ public void setSecurityDefinition(String securityDefinition) {
         this.securityDefinition = securityDefinition;
     }
 
+    public boolean isCommentRequired() {
+        return commentRequired;
+    }
+
+    public void setCommentRequired(boolean commentRequired) {
+        this.commentRequired = commentRequired;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;

gravitee-management-api-rest/src/main/java/io/gravitee/management/rest/resource/ApplicationSubscriptionsResource.java

@@ -85,6 +85,16 @@ public Response createSubscription(
         if (newSubscriptionEntity == null) {
             newSubscriptionEntity = new NewSubscriptionEntity();
         }
+
+        PlanEntity planEntity = planService.findById(plan);
+
+        if (planEntity.isCommentRequired() &&
+                (newSubscriptionEntity.getRequest() == null || newSubscriptionEntity.getRequest().isEmpty())) {
+            return Response.status(Response.Status.BAD_REQUEST)
+                    .entity("Plan requires a consumer comment when subscribing")
+                    .build();
+        }
+
         newSubscriptionEntity.setApplication(application);
         newSubscriptionEntity.setPlan(plan);
         Subscription subscription = convert(subscriptionService.create(newSubscriptionEntity));

gravitee-management-api-service/src/main/java/io/gravitee/management/service/impl/PlanServiceImpl.java

@@ -161,6 +161,7 @@ public PlanEntity create(NewPlanEntity newPlan) {
             plan.setSecurityDefinition(newPlan.getSecurityDefinition());
             plan.setStatus(Plan.Status.valueOf(newPlan.getStatus().name()));
             plan.setExcludedGroups(newPlan.getExcludedGroups());
+            plan.setCommentRequired(newPlan.isCommentRequired());
 
             if (plan.getSecurity() == Plan.PlanSecurityType.KEY_LESS) {
                 // There is no need for a validation when authentication is KEY_LESS, force to AUTO
@@ -223,6 +224,7 @@ public PlanEntity update(UpdatePlanEntity updatePlan) {
             newPlan.setDescription(updatePlan.getDescription());
             newPlan.setUpdatedAt(new Date());
             newPlan.setSecurityDefinition(updatePlan.getSecurityDefinition());
+            newPlan.setCommentRequired(updatePlan.isCommentRequired());
 
             String planPolicies = objectMapper.writeValueAsString(updatePlan.getPaths());
             newPlan.setDefinition(planPolicies);
@@ -532,6 +534,7 @@ private PlanEntity convert(Plan plan) {
         entity.setPublishedAt(plan.getPublishedAt());
         entity.setValidation(PlanValidationType.valueOf(plan.getValidation().name()));
         entity.setCharacteristics(plan.getCharacteristics());
+        entity.setCommentRequired(plan.isCommentRequired());
 
         return entity;
     }

pom.xml

@@ -38,7 +38,7 @@
         <gravitee-definition.version>1.13.2</gravitee-definition.version>
         <gravitee-common.version>1.13.0</gravitee-common.version>
         <gravitee-plugin.version>1.4.0</gravitee-plugin.version>
-        <gravitee-repository.version>1.20.0</gravitee-repository.version>
+        <gravitee-repository.version>1.21.0-SNAPSHOT</gravitee-repository.version>
         <gravitee-gateway-api.version>1.11.0</gravitee-gateway-api.version>
         <gravitee-fetcher-api.version>1.0.0</gravitee-fetcher-api.version>
         <gravitee-expression-language.version>1.0.0</gravitee-expression-language.version>