Add subcription approval capability to publisher portal (wso2#12472)

Add subscription approval workflow API.

Author: shilmyhasan

components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/APIProvider.java

@@ -630,6 +630,15 @@ public enum ExceptionCodes implements ErrorHandler {
             "Operation type/http method is not specified for the operation/resource", 400,
             "Operation type/http method is not specified for the operation/resource: %s", false),
 
+    FAILED_TO_RETRIEVE_WORKFLOW_BY_EXTERNAL_REFERENCE_ID(902033, "Failed to rettrieve workflow request by the " +
+            "external workflow reference", 500,
+            "Failed to retrieve workflow request by the external workflow reference"),
+    FAILED_TO_RETRIEVE_WORKFLOWS(902034, "Error while retrieving workflow requests.", 500,
+            "Error while retrieving workflow requests."),
+    WORKFLOW_PAYLOAD_MISSING(902035, "Payload is missing", 400,
+            "Payload is missing in the workflow request"),
+    WORKFLOW_STATUS_NOT_DEFINED(902036, "Workflow status not defined", 400,
+            "Workflow status is not defined"),
     RESOURCE_URI_TEMPLATE_NOT_DEFINED(902032, "Resource URI template value not defined", 400,
             "Resource URI template value (target) not defined", false);
     private final long errorCode;

components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/ExceptionCodes.java

@@ -1,26 +1,29 @@
 /*
-*  Copyright (c) 2005-2011, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
-*
-*  WSO2 Inc. licenses this file to you under the Apache License,
-*  Version 2.0 (the "License"); you may not use this file except
-*  in compliance with the License.
-*  You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing,
-* software distributed under the License is distributed on an
-* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-* KIND, either express or implied.  See the License for the
-* specific language governing permissions and limitations
-* under the License.
-*/
+ *  Copyright (c) 2005-2011, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ *
+ *  WSO2 Inc. licenses this file to you under the Apache License,
+ *  Version 2.0 (the "License"); you may not use this file except
+ *  in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
 
 package org.wso2.carbon.apimgt.api.dto;
 
-import org.wso2.carbon.apimgt.api.WorkflowStatus;
+import org.json.simple.JSONObject;
+import org.wso2.carbon.apimgt.api.model.WorkflowStatus;
 
 import java.io.Serializable;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * This is the DTO that will be used for storing workflow related contextual information.
@@ -33,9 +36,6 @@ public class WorkflowDTO implements Serializable {
 
     private String workflowType;
 
-    //Used to hold the status of the workflow. When a workflow is initially executed, it will be in the CREATED state.
-    //It will then move to the APPROVED or REJECTED states depending on the output of the workflow execution.
-    private WorkflowStatus status;
 
     private long createdTime;
 
@@ -55,28 +55,37 @@ public class WorkflowDTO implements Serializable {
 
     private String callbackUrl;
 
-    public String getCallbackUrl() {
-        return callbackUrl;
+    private JSONObject metadata;
+
+    private JSONObject properties;
+
+    public WorkflowDTO() {
+        metadata = new JSONObject();
+        properties = new JSONObject();
     }
 
-    public void setCallbackUrl(String callbackUrl) {
-        this.callbackUrl = callbackUrl;
+    public String getProperties(String key) {
+        return properties.get(key).toString();
     }
 
-    /**
-     * Returns the status of the Workflow.
-     * @return - Enum, the workflow status (Ex: CREATED, APPROVED, REJECTED)
-     */
-    public WorkflowStatus getStatus() {
-        return status;
+    public void setProperties(String key, String value) {
+        properties.put(key, value);
     }
 
-    public void setStatus(WorkflowStatus status) {
-        this.status = status;
+    //to pass any additional parameters. This can be used to pass parameters to the executor's complete() method
+    private Map<String, String> attributes = new HashMap<String, String>();
+
+    public String getCallbackUrl() {
+        return callbackUrl;
+    }
+
+    public void setCallbackUrl(String callbackUrl) {
+        this.callbackUrl = callbackUrl;
     }
 
     /**
      * Returns the reference id of the workflow.
+     *
      * @return - The workflow reference id.
      */
     public String getExternalWorkflowReference() {
@@ -89,6 +98,7 @@ public void setExternalWorkflowReference(String externalWorkflowReference) {
 
     /**
      * Returns the workflow description.
+     *
      * @return - The workflow description.
      */
     public String getWorkflowDescription() {
@@ -146,4 +156,54 @@ public String getTenantDomain() {
     public void setTenantDomain(String tenantDomain) {
         this.tenantDomain = tenantDomain;
     }
+
+    public Map<String, String> getAttributes() {
+        return attributes;
+    }
+
+    public void setAttributes(Map<String, String> attributes) {
+        this.attributes = attributes;
+    }
+
+    public String getMetadata(String key) {
+        return metadata.get(key).toString();
+    }
+
+    public void setMetadata(String key, String value) {
+        metadata.put(key, value);
+    }
+
+    public JSONObject getMetadata() {
+        return metadata;
+    }
+
+    public void setMetadata(JSONObject metadata) {
+        this.metadata = metadata;
+    }
+
+    public JSONObject getProperties() {
+        return properties;
+    }
+
+    public void setProperties(JSONObject properties) {
+        this.properties = properties;
+    }
+
+    @Override
+    public String toString() {
+        return "WorkflowDTO{" +
+                "workflowReference='" + workflowReference + '\'' +
+                ", workflowType='" + workflowType + '\'' +
+                ", createdTime=" + createdTime +
+                ", updatedTime=" + updatedTime +
+                ", workflowDescription='" + workflowDescription + '\'' +
+                ", tenantId=" + tenantId +
+                ", tenantDomain='" + tenantDomain + '\'' +
+                ", externalWorkflowReference='" + externalWorkflowReference + '\'' +
+                ", callbackUrl='" + callbackUrl + '\'' +
+                ", metadata=" + metadata +
+                ", properties=" + properties +
+                ", attributes=" + attributes +
+                '}';
+    }
 }

components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/dto/WorkflowDTO.java

@@ -0,0 +1,23 @@
+/*
+*  Copyright (c) 2005-2011, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+*
+*  WSO2 Inc. licenses this file to you under the Apache License,
+*  Version 2.0 (the "License"); you may not use this file except
+*  in compliance with the License.
+*  You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an
+* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+* KIND, either express or implied.  See the License for the
+* specific language governing permissions and limitations
+* under the License.
+*/
+
+package org.wso2.carbon.apimgt.api.model;
+
+public enum WorkflowStatus {
+    CREATED, APPROVED, REJECTED, REGISTERED
+}

components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/model/WorkflowStatus.java

@@ -7518,4 +7518,16 @@ public void updateSoapToRestSequences(String organization, String apiId, List<SO
             throw new APIManagementException("Error while sequences to the api  " + apiId, e);
         }        
     }
+
+    @Override
+    public org.wso2.carbon.apimgt.api.dto.WorkflowDTO retrieveWorkflow(
+            String workflowReferenceID) throws APIManagementException {
+        try {
+            org.wso2.carbon.apimgt.api.dto.WorkflowDTO workflowDTO = apiMgtDAO.retrieveWorkflow(workflowReferenceID);
+            return workflowDTO;
+        } catch (APIManagementException e) {
+            throw new APIManagementException("Error while resuming workflow " + workflowReferenceID, e);
+        }
+    }
+
 }

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIProviderImpl.java

@@ -56,6 +56,8 @@
 public class APIMConfigServiceImpl implements APIMConfigService {
 
     private static final Log log = LogFactory.getLog(APIMConfigServiceImpl.class);
+    private static final String SUBSCRIPTION_APPROVAL_VIEW_SCOPE = "apim:subscription_approval_view";
+    private static final String SUBSCRIPTION_APPROVAL_MANAGE_SCOPE = "apim:subscription_approval_manage";
     protected SystemConfigurationsDAO systemConfigurationsDAO;
 
     public APIMConfigServiceImpl() {
@@ -195,7 +197,9 @@ private String addMissingScopes(String systemConfig) {
                 "apim:admin_tier_view",
                 "apim:admin_tier_manage",
                 "apim:keymanagers_manage",
-                "apim:api_category"
+                "apim:api_category",
+                SUBSCRIPTION_APPROVAL_VIEW_SCOPE,
+                SUBSCRIPTION_APPROVAL_MANAGE_SCOPE
             };
 
         ArrayList<String> missingScopesList = new ArrayList<>(Arrays.asList(scopesToCheck));
@@ -227,7 +231,12 @@ private String addMissingScopes(String systemConfig) {
         for (String missingScope : missingScopesList) {
             JsonObject newScope = new JsonObject();
             newScope.addProperty("Name", missingScope);
-            newScope.addProperty("Roles", "admin");
+            if (missingScope.equals(SUBSCRIPTION_APPROVAL_VIEW_SCOPE) ||
+                    missingScope.equals(SUBSCRIPTION_APPROVAL_MANAGE_SCOPE)) {
+                newScope.addProperty("Roles", "admin,Internal/publisher");
+            } else {
+                newScope.addProperty("Roles", "admin");
+            }
             scopeArray.add(newScope);
         }