Modify implementation to allow an API and a Common policies with same and version

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

@@ -1553,6 +1553,9 @@ EnvironmentPropertiesDTO getEnvironmentSpecificAPIProperties(String apiUuid, Str
      */
     String importOperationPolicy(OperationPolicyData operationPolicyData, String organization)
             throws APIManagementException;
+    String importOperationPolicyOfGivenType(OperationPolicyData operationPolicyData, String policyType,
+                                            String organization) throws APIManagementException;
+
 
     /**
      * Add an API specific operation policy

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

@@ -25,6 +25,7 @@ public class OperationPolicy implements Comparable<OperationPolicy> {
 
     private String policyName = "";
     private String policyVersion = "v1";
+    private String policyType = null;
     private String direction = null;
     private Map<String, Object> parameters = null;
     private String policyId = null;
@@ -50,6 +51,16 @@ public void setPolicyVersion(String policyVersion) {
         this.policyVersion = policyVersion;
     }
 
+    public String getPolicyType() {
+
+        return policyType;
+    }
+
+    public void setPolicyType(String policyType) {
+
+        this.policyType = policyType;
+    }
+
     public Map<String, Object> getParameters() {
 
         return parameters;
@@ -98,7 +109,7 @@ public boolean equals(Object o) {
         if (o instanceof OperationPolicy) {
             OperationPolicy policyObj = (OperationPolicy) o;
             return Objects.equals(policyName, policyObj.policyName) && Objects.equals(policyVersion,
-                    policyObj.policyVersion) && Objects.equals(direction, policyObj.direction) && Objects.equals(
+                    policyObj.policyVersion) && Objects.equals(direction, policyObj.direction) && policyType.equals(policyObj.policyType) && Objects.equals(
                     parameters, policyObj.parameters) && Objects.equals(policyId, policyObj.policyId);
         }
         return false;

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

@@ -134,6 +134,7 @@
 import org.wso2.carbon.apimgt.impl.importexport.APIImportExportException;
 import org.wso2.carbon.apimgt.impl.importexport.ExportFormat;
 import org.wso2.carbon.apimgt.impl.importexport.ImportExportAPI;
+import org.wso2.carbon.apimgt.impl.importexport.ImportExportConstants;
 import org.wso2.carbon.apimgt.impl.internal.ServiceReferenceHolder;
 import org.wso2.carbon.apimgt.impl.lifecycle.CheckListItem;
 import org.wso2.carbon.apimgt.impl.lifecycle.LCManagerFactory;
@@ -5280,6 +5281,53 @@ public String getSecuritySchemeOfAPI(String uuid, String organization) throws AP
         }
     }
 
+    public String getPolicyType(OperationPolicy policy, String apiUUId, String tenantDomain)
+            throws APIManagementException {
+        String policyType = null;
+        if (policy.getPolicyId() == null) {
+            policyType = ImportExportConstants.POLICY_TYPE_API;
+        } else {
+            OperationPolicyData basicPolicyData =
+                    getAPISpecificOperationPolicyByPolicyId(policy.getPolicyId(),
+                            apiUUId, tenantDomain, false);
+            if (basicPolicyData.getClonedCommonPolicyId() == null) {
+                policyType = ImportExportConstants.POLICY_TYPE_API;
+            } else {
+                policyType = ImportExportConstants.POLICY_TYPE_COMMON;
+            }
+        }
+        return policyType;
+    }
+
+    public API addPolicyTypeFieldToApi(API api, String tenantDomain)
+            throws APIManagementException {
+
+        Set<URITemplate> uriTemplates = api.getUriTemplates();
+        for (URITemplate uriTemplate : uriTemplates) {
+            List<OperationPolicy> operationPolicies = uriTemplate.getOperationPolicies();
+            if (!operationPolicies.isEmpty()) {
+                for (OperationPolicy operationPolicy : operationPolicies) {
+                    String policyType = getPolicyType(operationPolicy, api.getUuid(),
+                            tenantDomain);
+                    operationPolicy.setPolicyType(policyType);
+                }
+            }
+        }
+        api.setUriTemplates(uriTemplates);
+
+        List<OperationPolicy> apiPolicies = api.getApiPolicies();
+        if (apiPolicies != null && !apiPolicies.isEmpty()) {
+            for (OperationPolicy policy : apiPolicies) {
+                String policyType = getPolicyType(policy, api.getUuid(),
+                        tenantDomain);
+                policy.setPolicyType(policyType);
+            }
+        }
+        api.setApiPolicies(apiPolicies);
+
+        return api;
+    }
+
     @Override
     public boolean isSubscriptionValidationDisabled(String uuid) throws APIManagementException {
         String status = apiMgtDAO.getSubscriptionValidationStatus(uuid);
@@ -5324,6 +5372,7 @@ public API getAPIbyUUID(String uuid, String organization) throws APIManagementEx
                     populateAiConfiguration(api);
                 }
                 populateDefaultVersion(api);
+                api = addPolicyTypeFieldToApi(api, organization);
                 return api;
             } else {
                 String msg = "Failed to get API. API artifact corresponding to artifactId " + uuid + " does not exist";
@@ -7029,6 +7078,88 @@ public String importOperationPolicy(OperationPolicyData importedPolicyData, Stri
 
         return policyId;
     }
+    @Override
+    public String importOperationPolicyOfGivenType(OperationPolicyData importedPolicyData, String policyType,
+                                                   String organization)
+            throws APIManagementException {
+
+        OperationPolicySpecification importedSpec = importedPolicyData.getSpecification();
+        OperationPolicyData existingOperationPolicy;
+
+        String policyId = null;
+        if (policyType == null) {
+            /*To handle scenarios where api is exported from a previous U2 version. API and Common policies with same name
+             and same version is not supported there
+             */
+            policyId = importOperationPolicy(importedPolicyData, organization);
+        } else if (policyType.equalsIgnoreCase(ImportExportConstants.POLICY_TYPE_COMMON)) {
+            existingOperationPolicy = getCommonOperationPolicyByPolicyName(importedSpec.getName(),
+                    importedSpec.getVersion(),organization, false);
+
+            if (existingOperationPolicy != null) {
+                if (existingOperationPolicy.getMd5Hash().equals(importedPolicyData.getMd5Hash())) {
+                    if (log.isDebugEnabled()) {
+                        log.debug("Matching common policy found for imported policy and Md5 hashes match.");
+                    }
+                    policyId = existingOperationPolicy.getPolicyId();
+                } else {
+                    importedSpec.setName(importedSpec.getName() + "_imported");
+                    importedSpec.setDisplayName(importedSpec.getDisplayName() + " Imported");
+                    importedPolicyData.setSpecification(importedSpec);
+                    importedPolicyData.setMd5Hash(APIUtil.getMd5OfOperationPolicy(importedPolicyData));
+                    policyId = addAPISpecificOperationPolicy(importedPolicyData.getApiUUID(), importedPolicyData,
+                            organization);
+                    if (log.isDebugEnabled()) {
+                        log.debug("Even though existing common policy name match with imported policy, "
+                                + "the MD5 hashes does not match in the policy " + existingOperationPolicy.getPolicyId()
+                                + ". A new policy created with ID " + policyId);
+                    }
+                }
+            } else {
+                importedSpec.setName(importedSpec.getName() + "_imported");
+                importedSpec.setDisplayName(importedSpec.getDisplayName() + " Imported");
+                importedPolicyData.setSpecification(importedSpec);
+                importedPolicyData.setMd5Hash(APIUtil.getMd5OfOperationPolicy(importedPolicyData));
+                policyId = addAPISpecificOperationPolicy(importedPolicyData.getApiUUID(), importedPolicyData,
+                        organization);
+                if (log.isDebugEnabled()) {
+                    log.debug(
+                            "There aren't any existing common policy for the imported policy. " +
+                                    "A new policy created with ID " + policyId);
+                }
+            }
+        } else { //api level policy by default
+            existingOperationPolicy =
+                    getAPISpecificOperationPolicyByPolicyName(importedSpec.getName(), importedSpec.getVersion(),
+                            importedPolicyData.getApiUUID(), null, organization, false);
+
+            if (existingOperationPolicy != null) {
+                if (existingOperationPolicy.getMd5Hash().equals(importedPolicyData.getMd5Hash())) {
+                    if (log.isDebugEnabled()) {
+                        log.debug("Matching API specific policy found for imported policy and MD5 hashes match.");
+                    }
+                } else {
+                    if (log.isDebugEnabled()) {
+                        log.debug("Even though existing API specific policy name match with imported policy, "
+                                + "the MD5 hashes does not match in the policy " + existingOperationPolicy.getPolicyId()
+                                + ".Therefore updating the existing policy");
+                    }
+                    updateOperationPolicy(existingOperationPolicy.getPolicyId(), importedPolicyData, organization);
+                }
+                policyId = existingOperationPolicy.getPolicyId();
+            } else {
+                policyId = addAPISpecificOperationPolicy(importedPolicyData.getApiUUID(), importedPolicyData,
+                        organization);
+                if (log.isDebugEnabled()) {
+                    log.debug(
+                            "There aren't any existing policies for the imported policy. A new policy created with ID "
+                                    + policyId);
+                }
+            }
+        }
+
+        return policyId;
+    }
 
     @Override
     public String addAPISpecificOperationPolicy(String apiUUID, OperationPolicyData operationPolicyData,

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/dao/ApiMgtDAO.java

@@ -124,6 +124,7 @@
 import org.wso2.carbon.apimgt.impl.dto.WorkflowDTO;
 import org.wso2.carbon.apimgt.impl.factory.KeyManagerHolder;
 import org.wso2.carbon.apimgt.impl.factory.SQLConstantManagerFactory;
+import org.wso2.carbon.apimgt.impl.importexport.ImportExportConstants;
 import org.wso2.carbon.apimgt.impl.internal.ServiceReferenceHolder;
 import org.wso2.carbon.apimgt.impl.utils.APIMgtDBUtil;
 import org.wso2.carbon.apimgt.impl.utils.APIUtil;
@@ -21179,7 +21180,13 @@ public Set<String> getCommonOperationPolicyNames(String organization) throws API
                 while (rs.next()) {
                     String policyName = rs.getString("POLICY_NAME");
                     String policyVersion = rs.getString("POLICY_VERSION");
-                    policyNames.add(APIUtil.getOperationPolicyFileName(policyName, policyVersion));
+                    policyNames.add(APIUtil.getOperationPolicyFileName(policyName, policyVersion, null));
+                    /*since the only usage of this method is to load the common operation policies from the
+                     specifications and we are keeping only the common policies without appending the string "common"
+                     to the file name, it's not required to append the policyType string
+                     (policyNames.add(APIUtil.getOperationPolicyFileName(policyName, policyVersion,
+                     ImportExportConstants.POLICY_TYPE_COMMON));)here as well.
+                     */
                 }
             }
         } catch (SQLException e) {

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/importexport/ImportExportConstants.java

@@ -316,4 +316,7 @@ public final class ImportExportConstants {
     public static final String EXPORT_POLICY_TYPE_JSON = "JSON";
 
     public static final String POLICY_NAME = "name";
+
+    public static final String POLICY_TYPE_API = "api";
+    public static final String POLICY_TYPE_COMMON = "common";
 }

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/utils/APIUtil.java

@@ -168,6 +168,7 @@
 import org.wso2.carbon.apimgt.impl.dto.ThrottleProperties;
 import org.wso2.carbon.apimgt.impl.dto.WorkflowDTO;
 import org.wso2.carbon.apimgt.impl.gatewayartifactsynchronizer.exception.DataLoadingException;
+import org.wso2.carbon.apimgt.impl.importexport.ImportExportConstants;
 import org.wso2.carbon.apimgt.impl.internal.APIManagerComponent;
 import org.wso2.carbon.apimgt.impl.internal.ServiceReferenceHolder;
 import org.wso2.carbon.apimgt.impl.kmclient.ApacheFeignHttpClient;
@@ -10078,8 +10079,9 @@ public static void loadCommonOperationPolicies(String organization) {
                                 OperationPolicyData policyData = new OperationPolicyData();
                                 policyData.setSpecification(policySpec);
                                 policyData.setOrganization(organization);
+                                //since the directory contains common policies only, files are not renamed with type
                                 String policyFileName = getOperationPolicyFileName(policySpec.getName(),
-                                        policySpec.getVersion());
+                                        policySpec.getVersion(), null);
                                 OperationPolicyDefinition synapsePolicyDefinition =
                                         getOperationPolicyDefinitionFromFile(policyDefinitionLocation,
                                                 policyFileName, APIConstants.SYNAPSE_POLICY_DEFINITION_EXTENSION);
@@ -10399,11 +10401,14 @@ public static OperationPolicyData generateOperationPolicyDataObject(String apiUu
     }
 
 
-    public static String getOperationPolicyFileName(String policyName, String policyVersion) {
+    public static String getOperationPolicyFileName(String policyName, String policyVersion, String policyType) {
         if (StringUtils.isEmpty(policyVersion)) {
             policyVersion = "v1";
         }
-        return policyName + "_" + policyVersion;
+        if (policyType == null) {
+            return policyName + "_" + policyVersion;
+        }
+        return policyName + "_" + policyVersion + "_" + policyType;
     }
 
     public static String getCustomBackendFileName(String apiUUID, String endpointType) {

components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/publisher-api.yaml

@@ -13543,6 +13543,8 @@ components:
         policyVersion:
           type: string
           default: v1
+        policyType:
+          type: string
         policyId:
           type: string
         parameters:

components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1.common/src/gen/java/org/wso2/carbon/apimgt/rest/api/publisher/v1/dto/OperationPolicyDTO.java

@@ -25,6 +25,7 @@ public class OperationPolicyDTO   {
 
     private String policyName = null;
     private String policyVersion = "v1";
+    private String policyType = null;
     private String policyId = null;
     private Map<String, Object> parameters = new HashMap<String, Object>();
 
@@ -63,6 +64,23 @@ public void setPolicyVersion(String policyVersion) {
     this.policyVersion = policyVersion;
   }
 
+  /**
+   **/
+  public OperationPolicyDTO policyType(String policyType) {
+    this.policyType = policyType;
+    return this;
+  }
+
+
+  @ApiModelProperty(value = "")
+  @JsonProperty("policyType")
+  public String getPolicyType() {
+    return policyType;
+  }
+  public void setPolicyType(String policyType) {
+    this.policyType = policyType;
+  }
+
   /**
    **/
   public OperationPolicyDTO policyId(String policyId) {
@@ -109,13 +127,14 @@ public boolean equals(java.lang.Object o) {
     OperationPolicyDTO operationPolicy = (OperationPolicyDTO) o;
     return Objects.equals(policyName, operationPolicy.policyName) &&
         Objects.equals(policyVersion, operationPolicy.policyVersion) &&
+        Objects.equals(policyType, operationPolicy.policyType) &&
         Objects.equals(policyId, operationPolicy.policyId) &&
         Objects.equals(parameters, operationPolicy.parameters);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(policyName, policyVersion, policyId, parameters);
+    return Objects.hash(policyName, policyVersion, policyType, policyId, parameters);
   }
 
   @Override
@@ -125,6 +144,7 @@ public String toString() {
 
     sb.append("    policyName: ").append(toIndentedString(policyName)).append("\n");
     sb.append("    policyVersion: ").append(toIndentedString(policyVersion)).append("\n");
+    sb.append("    policyType: ").append(toIndentedString(policyType)).append("\n");
     sb.append("    policyId: ").append(toIndentedString(policyId)).append("\n");
     sb.append("    parameters: ").append(toIndentedString(parameters)).append("\n");
     sb.append("}");

components/apimgt/org.wso2.carbon.apimgt.rest.api.publisher.v1.common/src/main/java/org/wso2/carbon/apimgt/rest/api/publisher/v1/common/SynapsePolicyAggregator.java

@@ -192,7 +192,7 @@ private static List<String> renderPolicyMapping(List<OperationPolicy> policyList
             if (flow.equals(policy.getDirection())) {
                 Map<String, Object> policyParameters = policy.getParameters();
                 String policyFileName = APIUtil.getOperationPolicyFileName(policy.getPolicyName(),
-                        policy.getPolicyVersion());
+                        policy.getPolicyVersion(), policy.getPolicyType());
                 OperationPolicySpecification policySpecification = ImportUtils
                         .getOperationPolicySpecificationFromFile(policyDirectory, policyFileName);
                 if (policySpecification.getSupportedGateways()