Created a new simplified API for creating policies
[policy/api.git] / main / src / main / java / org / onap / policy / api / main / rest / provider / PolicyProvider.java
index d7f152e..99dcd71 100644 (file)
 \r
 package org.onap.policy.api.main.rest.provider;\r
 \r
+import java.util.ArrayList;\r
 import java.util.List;\r
 import java.util.Map;\r
 import javax.ws.rs.core.Response;\r
 import org.apache.commons.lang3.tuple.Pair;\r
-import org.onap.policy.api.main.parameters.ApiParameterGroup;\r
-import org.onap.policy.common.parameters.ParameterService;\r
+import org.onap.policy.models.base.PfConceptKey;\r
 import org.onap.policy.models.base.PfModelException;\r
 import org.onap.policy.models.pdp.concepts.PdpGroup;\r
 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;\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.ToscaPolicyIdentifier;\r
@@ -45,18 +42,13 @@ import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  *\r
  * @author Chenfei Gao (cgao@research.att.com)\r
  */\r
-public class PolicyProvider {\r
-\r
-    private PolicyModelsProvider modelsProvider;\r
+public class PolicyProvider extends CommonModelProvider {\r
 \r
     /**\r
      * Default constructor.\r
      */\r
     public PolicyProvider() 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
@@ -74,21 +66,16 @@ public class PolicyProvider {
     public ToscaServiceTemplate fetchPolicies(String policyTypeId, String policyTypeVersion,\r
             String policyId, String policyVersion) throws PfModelException {\r
 \r
-        validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
+        ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder()\r
+                .name(policyId).version(policyVersion)\r
+                .type(policyTypeId).typeVersion(policyTypeVersion).build();\r
+        ToscaServiceTemplate serviceTemplate = modelsProvider.getFilteredPolicies(policyFilter);\r
 \r
-        ToscaServiceTemplate serviceTemplate;\r
-        if (policyId == null || policyVersion == null) {\r
-            ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder()\r
-                    .name(policyId).version(policyVersion)\r
-                    .type(policyTypeId).typeVersion(policyTypeVersion).build();\r
-            serviceTemplate = modelsProvider.getFilteredPolicies(policyFilter);\r
-        } else {\r
-            serviceTemplate = modelsProvider.getPolicies(policyId, policyVersion);\r
+        if (!hasPolicy(serviceTemplate)) {\r
+            throw new PfModelException(Response.Status.NOT_FOUND,\r
+                    constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, policyVersion));\r
         }\r
 \r
-        validatePolicyTypeMatch(policyTypeId, policyTypeVersion, serviceTemplate);\r
-\r
-        close();\r
         return serviceTemplate;\r
     }\r
 \r
@@ -106,16 +93,16 @@ public class PolicyProvider {
     public ToscaServiceTemplate fetchLatestPolicies(String policyTypeId, String policyTypeVersion,\r
             String policyId) throws PfModelException {\r
 \r
-        validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
-\r
         ToscaPolicyFilter policyFilter = ToscaPolicyFilter.builder()\r
                 .name(policyId).version(ToscaPolicyFilter.LATEST_VERSION)\r
                 .type(policyTypeId).typeVersion(policyTypeVersion).build();\r
         ToscaServiceTemplate serviceTemplate = modelsProvider.getFilteredPolicies(policyFilter);\r
 \r
-        validatePolicyTypeMatch(policyTypeId, policyTypeVersion, serviceTemplate);\r
+        if (!hasPolicy(serviceTemplate)) {\r
+            throw new PfModelException(Response.Status.NOT_FOUND,\r
+                    constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, null));\r
+        }\r
 \r
-        close();\r
         return serviceTemplate;\r
     }\r
 \r
@@ -133,19 +120,8 @@ public class PolicyProvider {
     public Map<Pair<String, String>, List<ToscaPolicy>> fetchDeployedPolicies(\r
             String policyTypeId, String policyTypeVersion, String policyId) throws PfModelException {\r
 \r
-        validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
-\r
-        ToscaPolicyIdentifier policyIdentifier = new ToscaPolicyIdentifier();\r
-        policyIdentifier.setName(policyId);\r
-        PdpGroupFilter pdpGroupFilter = PdpGroupFilter.builder()\r
-                .policyType(new ToscaPolicyTypeIdentifier(policyTypeId, policyTypeVersion))\r
-                .policy(policyIdentifier).build();\r
-        List<PdpGroup> pdpGroups = modelsProvider.getFilteredPdpGroups(pdpGroupFilter);\r
-\r
-        //TODO: I don't know how to get policies matching policyId that are deployed in those PDP groups\r
-\r
-        close();\r
-        return null;\r
+        return collectDeployedPolicies(policyId, new PfConceptKey(policyTypeId, policyTypeVersion),\r
+                modelsProvider::getPolicyList, List::addAll, new ArrayList<>());\r
     }\r
 \r
     /**\r
@@ -165,10 +141,21 @@ public class PolicyProvider {
         validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
         validatePolicyTypeMatch(policyTypeId, policyTypeVersion, body);\r
 \r
-        ToscaServiceTemplate serviceTemplate = modelsProvider.createPolicies(body);\r
+        return modelsProvider.createPolicies(body);\r
+    }\r
 \r
-        close();\r
-        return serviceTemplate;\r
+    /**\r
+     * Creates one or more new policies.\r
+     *\r
+     * @param body the entity body of policy\r
+     *\r
+     * @return the ToscaServiceTemplate object\r
+     *\r
+     * @throws PfModelException the PfModel parsing exception\r
+     */\r
+    public ToscaServiceTemplate createPolicies(ToscaServiceTemplate body) throws PfModelException {\r
+\r
+        return modelsProvider.createPolicies(body);\r
     }\r
 \r
     /**\r
@@ -186,17 +173,16 @@ public class PolicyProvider {
     public ToscaServiceTemplate deletePolicy(String policyTypeId, String policyTypeVersion,\r
                                  String policyId, String policyVersion) throws PfModelException {\r
 \r
-        validatePolicyTypeExist(policyTypeId, policyTypeVersion);\r
-\r
-        ToscaServiceTemplate serviceTemplate = modelsProvider.getPolicies(policyId, policyVersion);\r
-\r
-        validatePolicyTypeMatch(policyTypeId, policyTypeVersion, serviceTemplate);\r
         validateDeleteEligibility(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
 \r
-        ToscaServiceTemplate deletedServiceTemplate = modelsProvider.deletePolicy(policyId, policyVersion);\r
+        ToscaServiceTemplate serviceTemplate = modelsProvider.deletePolicy(policyId, policyVersion);\r
 \r
-        close();\r
-        return deletedServiceTemplate;\r
+        if (!hasPolicy(serviceTemplate)) {\r
+            throw new PfModelException(Response.Status.NOT_FOUND,\r
+                    constructResourceNotFoundMessage(policyTypeId, policyTypeVersion, policyId, policyVersion));\r
+        }\r
+\r
+        return serviceTemplate;\r
     }\r
 \r
     /**\r
@@ -209,10 +195,10 @@ public class PolicyProvider {
      */\r
     private void validatePolicyTypeExist(String policyTypeId, String policyTypeVersion) throws PfModelException {\r
 \r
-        try {\r
-            modelsProvider.getPolicyTypes(policyTypeId, policyTypeVersion);\r
-        } catch (Exception e) {\r
-            throw new PfModelException(Response.Status.NOT_FOUND, "specified policy type does not exist", e);\r
+        ToscaServiceTemplate serviceTemplate = modelsProvider.getPolicyTypes(policyTypeId, policyTypeVersion);\r
+        if (!hasPolicyType(serviceTemplate)) {\r
+            throw new PfModelException(Response.Status.NOT_FOUND,\r
+                    "policy type with ID " + policyTypeId + ":" + policyTypeVersion + " does not exist");\r
         }\r
     }\r
 \r
@@ -230,14 +216,17 @@ public class PolicyProvider {
 \r
         List<Map<String, ToscaPolicy>> policies = serviceTemplate.getToscaTopologyTemplate().getPolicies();\r
         for (Map<String, ToscaPolicy> policy : policies) {\r
-            if (policy.size() != 1) {\r
+            if (policy.size() > 1) {\r
                 throw new PfModelException(Response.Status.BAD_REQUEST,\r
                         "one policy block contains more than one policies");\r
             }\r
             ToscaPolicy policyContent = policy.values().iterator().next();\r
-            if (!policyTypeId.equalsIgnoreCase(policyContent.getType())\r
-                    || !policyTypeVersion.equalsIgnoreCase(policyContent.getTypeVersion())) {\r
-                throw new PfModelException(Response.Status.BAD_REQUEST, "policy type does not match");\r
+            if (!policyTypeId.equalsIgnoreCase(policyContent.getType())) {\r
+                throw new PfModelException(Response.Status.BAD_REQUEST, "policy type id does not match");\r
+            }\r
+            if (policyContent.getTypeVersion() != null\r
+                    && !policyTypeVersion.equalsIgnoreCase(policyContent.getTypeVersion())) {\r
+                throw new PfModelException(Response.Status.BAD_REQUEST, "policy type version does not match");\r
             }\r
         }\r
     }\r
@@ -255,27 +244,35 @@ public class PolicyProvider {
     private void validateDeleteEligibility(String policyTypeId, String policyTypeVersion,\r
             String policyId, String policyVersion) throws PfModelException {\r
 \r
+        List<ToscaPolicyTypeIdentifier> policyTypes = new ArrayList<>();\r
+        policyTypes.add(new ToscaPolicyTypeIdentifier(policyTypeId, policyTypeVersion));\r
+        List<ToscaPolicyIdentifier> policies = new ArrayList<>();\r
+        policies.add(new ToscaPolicyIdentifier(policyId, policyVersion));\r
         PdpGroupFilter pdpGroupFilter = PdpGroupFilter.builder()\r
-                .policyType(new ToscaPolicyTypeIdentifier(policyTypeId, policyTypeVersion))\r
-                .policy(new ToscaPolicyIdentifier(policyId, policyVersion)).build();\r
+                .policyTypeList(policyTypes).policyList(policies).build();\r
 \r
         List<PdpGroup> pdpGroups = modelsProvider.getFilteredPdpGroups(pdpGroupFilter);\r
+\r
         if (!pdpGroups.isEmpty()) {\r
-            throw new PfModelException(Response.Status.CONFLICT, "the policy has been deployed in pdp group");\r
+            throw new PfModelException(Response.Status.CONFLICT,\r
+                    constructDeletePolicyViolationMessage(policyId, policyVersion, pdpGroups));\r
         }\r
     }\r
 \r
     /**\r
-     * Closes the connection to database.\r
+     * Constructs returned message for not found resource.\r
      *\r
-     * @throws PfModelException the PfModel parsing exception\r
+     * @param policyTypeId the ID of policy type\r
+     * @param policyTypeVersion the version of policy type\r
+     * @param policyId the ID of policy\r
+     * @param policyVersion the version of policy\r
+     *\r
+     * @return constructed message\r
      */\r
-    private void close() throws PfModelException {\r
-        try {\r
-            modelsProvider.close();\r
-        } catch (Exception e) {\r
-            throw new PfModelException(\r
-                    Response.Status.INTERNAL_SERVER_ERROR, "error closing connection to database", e);\r
-        }\r
+    private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion,\r
+            String policyId, String policyVersion) {\r
+\r
+        return "policy with ID " + policyId + ":" + policyVersion\r
+                + " and type " + policyTypeId + ":" + policyTypeVersion + " does not exist";\r
     }\r
 }\r