Changes for cascaded get in policy models
[policy/api.git] / main / src / main / java / org / onap / policy / api / main / rest / provider / PolicyTypeProvider.java
index 24b8b1b..9c9c41c 100644 (file)
@@ -2,7 +2,8 @@
  * ============LICENSE_START=======================================================\r
  * ONAP Policy API\r
  * ================================================================================\r
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.\r
+ * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.\r
+ * Modifications Copyright (C) 2020 Nordix Foundation.\r
  * ================================================================================\r
  * Licensed under the Apache License, Version 2.0 (the "License");\r
  * you may not use this file except in compliance with the License.\r
 \r
 package org.onap.policy.api.main.rest.provider;\r
 \r
-import java.util.ArrayList;\r
-import java.util.List;\r
-import javax.ws.rs.core.Response;\r
-import org.onap.policy.api.main.parameters.ApiParameterGroup;\r
-import org.onap.policy.common.parameters.ParameterService;\r
 import org.onap.policy.models.base.PfModelException;\r
-import org.onap.policy.models.provider.PolicyModelsProvider;\r
-import org.onap.policy.models.provider.PolicyModelsProviderFactory;\r
-import org.onap.policy.models.provider.PolicyModelsProviderParameters;\r
-import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;\r
-import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;\r
 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;\r
 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
 \r
@@ -41,18 +32,13 @@ import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  *\r
  * @author Chenfei Gao (cgao@research.att.com)\r
  */\r
-public class PolicyTypeProvider implements AutoCloseable {\r
-\r
-    private PolicyModelsProvider modelsProvider;\r
+public class PolicyTypeProvider extends CommonModelProvider {\r
 \r
     /**\r
      * Default constructor.\r
      */\r
     public PolicyTypeProvider() throws PfModelException {\r
-\r
-        ApiParameterGroup parameterGroup = ParameterService.get("ApiGroup");\r
-        PolicyModelsProviderParameters providerParameters = parameterGroup.getDatabaseProviderParameters();\r
-        modelsProvider = new PolicyModelsProviderFactory().createPolicyModelsProvider(providerParameters);\r
+        super();\r
     }\r
 \r
     /**\r
@@ -68,16 +54,7 @@ public class PolicyTypeProvider implements AutoCloseable {
     public ToscaServiceTemplate fetchPolicyTypes(String policyTypeId, String policyTypeVersion)\r
             throws PfModelException {\r
 \r
-        ToscaPolicyTypeFilter policyTypeFilter = ToscaPolicyTypeFilter.builder()\r
-                .name(policyTypeId).version(policyTypeVersion).build();\r
-        ToscaServiceTemplate serviceTemplate = modelsProvider.getFilteredPolicyTypes(policyTypeFilter);\r
-\r
-        if (policyTypeId != null && !hasPolicyType(serviceTemplate)) {\r
-            throw new PfModelException(Response.Status.NOT_FOUND,\r
-                    constructResourceNotFoundMessage(policyTypeId, policyTypeVersion));\r
-        }\r
-\r
-        return serviceTemplate;\r
+        return getFilteredPolicyTypes(policyTypeId, policyTypeVersion);\r
     }\r
 \r
     /**\r
@@ -91,15 +68,7 @@ public class PolicyTypeProvider implements AutoCloseable {
      */\r
     public ToscaServiceTemplate fetchLatestPolicyTypes(String policyTypeId) throws PfModelException {\r
 \r
-        ToscaPolicyTypeFilter policyTypeFilter = ToscaPolicyTypeFilter.builder()\r
-                .name(policyTypeId).version(ToscaPolicyTypeFilter.LATEST_VERSION).build();\r
-        ToscaServiceTemplate serviceTemplate = modelsProvider.getFilteredPolicyTypes(policyTypeFilter);\r
-        if (!hasPolicyType(serviceTemplate)) {\r
-            throw new PfModelException(Response.Status.NOT_FOUND,\r
-                    constructResourceNotFoundMessage(policyTypeId, null));\r
-        }\r
-\r
-        return serviceTemplate;\r
+        return getFilteredPolicyTypes(policyTypeId, ToscaPolicyTypeFilter.LATEST_VERSION);\r
     }\r
 \r
     /**\r
@@ -128,100 +97,24 @@ public class PolicyTypeProvider implements AutoCloseable {
     public ToscaServiceTemplate deletePolicyType(String policyTypeId, String policyTypeVersion)\r
             throws PfModelException {\r
 \r
-        validateDeleteEligibility(policyTypeId, policyTypeVersion);\r
-\r
-        ToscaServiceTemplate serviceTemplate = modelsProvider.deletePolicyType(policyTypeId, policyTypeVersion);\r
-\r
-        if (!hasPolicyType(serviceTemplate)) {\r
-            throw new PfModelException(Response.Status.NOT_FOUND,\r
-                    constructResourceNotFoundMessage(policyTypeId, policyTypeVersion));\r
-        }\r
-\r
-        return serviceTemplate;\r
-    }\r
-\r
-    /**\r
-     * Validates whether specified policy type can be deleted based on the rule that\r
-     * policy type parameterized by at least one policies cannot be deleted.\r
-     *\r
-     * @param policyTypeId the ID of policy type\r
-     * @param policyTypeVersion the version of policy type\r
-     *\r
-     * @throws PfModelException the PfModel parsing exception\r
-     */\r
-    private void validateDeleteEligibility(String policyTypeId, String policyTypeVersion) throws PfModelException {\r
-\r
-        ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder()\r
-                .type(policyTypeId).typeVersion(policyTypeVersion).build();\r
-        List<ToscaPolicy> policies = modelsProvider.getFilteredPolicyList(policyFilter);\r
-        if (!policies.isEmpty()) {\r
-            throw new PfModelException(Response.Status.CONFLICT,\r
-                    constructDeleteRuleViolationMessage(policyTypeId, policyTypeVersion, policies));\r
-        }\r
-    }\r
-\r
-    /**\r
-     * Constructs returned message for policy type delete rule violation.\r
-     *\r
-     * @param policyTypeId the ID of policy type\r
-     * @param policyTypeVersion the version of policy type\r
-     * @param policies the list of policies that parameterizes specified policy type\r
-     *\r
-     * @return the constructed message\r
-     */\r
-    private String constructDeleteRuleViolationMessage(\r
-            String policyTypeId, String policyTypeVersion, List<ToscaPolicy> policies) {\r
-\r
-        List<String> policyNameVersionList = new ArrayList<>();\r
-        for (ToscaPolicy policy : policies) {\r
-            policyNameVersionList.add(policy.getName() + ":" + policy.getVersion());\r
-        }\r
-        String parameterizedPolicies = String.join(",", policyNameVersionList);\r
-        return "policy type with ID " + policyTypeId + ":" + policyTypeVersion\r
-                + " cannot be deleted as it is parameterized by policies " + parameterizedPolicies;\r
+        return modelsProvider.deletePolicyType(policyTypeId, policyTypeVersion);\r
     }\r
 \r
     /**\r
-     * Constructs returned message for not found resource.\r
+     * Retrieves the specified version of the policy type.\r
      *\r
-     * @param policyTypeId the ID of policy type\r
-     * @param policyTypeVersion the version of policy type\r
+     * @param policyTypeName the name of the policy type\r
+     * @param policyTypeVersion the version of the policy type\r
      *\r
-     * @return constructed message\r
-     */\r
-    private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion) {\r
-\r
-        return "policy type with ID " + policyTypeId + ":" + policyTypeVersion + " does not exist";\r
-    }\r
-\r
-    /**\r
-     * Checks if service template contains any policy type.\r
-     *\r
-     * @param serviceTemplate the service template to check against\r
-     *\r
-     * @return boolean whether service template contains any policy type\r
-     */\r
-    private boolean hasPolicyType(ToscaServiceTemplate serviceTemplate) {\r
-\r
-        if (serviceTemplate.getPolicyTypes() == null) {\r
-            return false;\r
-        } else if (serviceTemplate.getPolicyTypes().isEmpty()) {\r
-            return false;\r
-        } else if (serviceTemplate.getPolicyTypes().get(0).isEmpty()) {\r
-            return false;\r
-        } else {\r
-            return true;\r
-        }\r
-    }\r
-\r
-    /**\r
-     * Closes the connection to database.\r
+     * @return the TOSCA service template containing the specified version of the policy type\r
      *\r
      * @throws PfModelException the PfModel parsing exception\r
      */\r
-    @Override
-    public void close() throws PfModelException {\r
+    private ToscaServiceTemplate getFilteredPolicyTypes(String policyTypeName, String policyTypeVersion)\r
+            throws PfModelException {\r
 \r
-        modelsProvider.close();\r
+        ToscaPolicyTypeFilter policyTypeFilter =\r
+                ToscaPolicyTypeFilter.builder().name(policyTypeName).version(policyTypeVersion).build();\r
+        return modelsProvider.getFilteredPolicyTypes(policyTypeFilter);\r
     }\r
 }\r