Improve SubscriptionBlockedException error handling

wso2 · Mar 12, 2024 · 6072f21 · 6072f21
1 parent a130b0c
commit 6072f21
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/.../main/java/org/wso2/carbon/apimgt/rest/api/store/v1/impl/SubscriptionsApiServiceImpl.java b/.../main/java/org/wso2/carbon/apimgt/rest/api/store/v1/impl/SubscriptionsApiServiceImpl.java
@@ -28,6 +28,7 @@
 import org.wso2.carbon.apimgt.api.APIMgtAuthorizationFailedException;
 import org.wso2.carbon.apimgt.api.MonetizationException;
 import org.wso2.carbon.apimgt.api.SubscriptionAlreadyExistingException;
+import org.wso2.carbon.apimgt.api.SubscriptionBlockedException;
 import org.wso2.carbon.apimgt.api.WorkflowResponse;
 import org.wso2.carbon.apimgt.api.WorkflowStatus;
 import org.wso2.carbon.apimgt.api.model.APIIdentifier;
@@ -247,6 +248,9 @@ public Response subscriptionsPost(SubscriptionDTO body, String xWSO2Tenant, Mess
             RestApiUtil.handleResourceAlreadyExistsError(
                     "Specified subscription already exists for API " + body.getApiId() + ", for application "
                             + body.getApplicationId(), e, log);
+        } catch (SubscriptionBlockedException e) {
+            RestApiUtil.handleOperationBlockedError("Subscription blocked. " + e.getMessage()
+                    + ". Please contact the API publisher.", e, log);
         } catch (URISyntaxException e) {
             if (RestApiUtil.isDueToResourceNotFound(e)) {
                 //this happens when the specified API identifier does not exist
@@ -350,6 +354,9 @@ public Response subscriptionsSubscriptionIdPut(String subscriptionId, Subscripti
             RestApiUtil.handleResourceAlreadyExistsError(
                     "Specified subscription already exists for API " + body.getApiId() + ", for application "
                             + body.getApplicationId(), e, log);
+        } catch (SubscriptionBlockedException e) {
+            RestApiUtil.handleOperationBlockedError("Subscription blocked. " + e.getMessage()
+                    + ". Please contact the API publisher.", e, log);
         } catch (APIManagementException | URISyntaxException e) {
             if (RestApiUtil.isDueToResourceNotFound(e)) {
                 //this happens when the specified API identifier does not exist

diff --git a/...t.rest.api.util/src/main/java/org/wso2/carbon/apimgt/rest/api/util/utils/RestApiUtil.java b/...t.rest.api.util/src/main/java/org/wso2/carbon/apimgt/rest/api/util/utils/RestApiUtil.java
@@ -938,6 +938,20 @@ public static void handleInternalServerError(String msg, Log log)
         throw internalServerErrorException;
     }
 
+    /**
+     * Logs the error, builds a ForbiddenException with specified details and throws it
+     * @param msg error message
+     * @param t Throwable instance
+     * @param log Log instance
+     * @throws ForbiddenException
+     */
+    public static void handleOperationBlockedError(String msg, Throwable t, Log log)
+            throws ForbiddenException{
+        ForbiddenException forbiddenException = buildForbiddenException(msg);
+        log.error(msg,t);
+        throw forbiddenException;
+    }
+
     /**
      * Check whether the HTTP method is allowed for given resources
      *