Add changes for safe delete in policy-models

[policy/api.git] / main / src / main / java / org / onap / policy / api / main / rest / provider / PolicyTypeProvider.java

diff --git a/main/src/main/java/org/onap/policy/api/main/rest/provider/PolicyTypeProvider.java b/main/src/main/java/org/onap/policy/api/main/rest/provider/PolicyTypeProvider.java
index 5038e31..6c8e73e 100644 (file)
--- a/main/src/main/java/org/onap/policy/api/main/rest/provider/PolicyTypeProvider.java
+++ b/main/src/main/java/org/onap/policy/api/main/rest/provider/PolicyTypeProvider.java
@@ -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
@@ -22,16 +23,25 @@
 \r
 package org.onap.policy.api.main.rest.provider;\r
 \r
-import org.onap.policy.models.tosca.simple.concepts.ToscaServiceTemplate;\r
+import javax.ws.rs.core.Response;\r
+\r
+import org.onap.policy.models.base.PfModelException;\r
+import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;\r
+import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
 \r
 /**\r
  * Class to provide all kinds of policy type operations.\r
  *\r
  * @author Chenfei Gao (cgao@research.att.com)\r
  */\r
-public class PolicyTypeProvider {\r
+public class PolicyTypeProvider extends CommonModelProvider {\r
 \r
-    private static final String DELETE_OK = "Successfully deleted";\r
+    /**\r
+     * Default constructor.\r
+     */\r
+    public PolicyTypeProvider() throws PfModelException {\r
+        super();\r
+    }\r
 \r
     /**\r
      * Retrieves a list of policy types matching specified policy type ID and version.\r
@@ -40,10 +50,40 @@ public class PolicyTypeProvider {
      * @param policyTypeVersion the version of policy type\r
      *\r
      * @return the ToscaServiceTemplate object\r
+     *\r
+     * @throws PfModelException the PfModel parsing exception\r
+     */\r
+    public ToscaServiceTemplate fetchPolicyTypes(String policyTypeId, String policyTypeVersion)\r
+            throws PfModelException {\r
+\r
+        ToscaServiceTemplate serviceTemplate = getFilteredPolicyTypes(policyTypeId, policyTypeVersion);\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
+    }\r
+\r
+    /**\r
+     * Retrieves a list of policy types with the latest versions.\r
+     *\r
+     * @param policyTypeId the ID of policy type\r
+     *\r
+     * @return the ToscaServiceTemplate object\r
+     *\r
+     * @throws PfModelException the PfModel parsing exception\r
      */\r
-    public ToscaServiceTemplate fetchPolicyTypes(String policyTypeId, String policyTypeVersion) {\r
-        // placeholder\r
-        return new ToscaServiceTemplate();\r
+    public ToscaServiceTemplate fetchLatestPolicyTypes(String policyTypeId) throws PfModelException {\r
+\r
+        ToscaServiceTemplate serviceTemplate =\r
+                getFilteredPolicyTypes(policyTypeId, ToscaPolicyTypeFilter.LATEST_VERSION);\r
+        if (!hasPolicyType(serviceTemplate)) {\r
+            throw new PfModelException(Response.Status.NOT_FOUND, constructResourceNotFoundMessage(policyTypeId, null));\r
+        }\r
+\r
+        return serviceTemplate;\r
     }\r
 \r
     /**\r
@@ -51,23 +91,70 @@ public class PolicyTypeProvider {
      *\r
      * @param body the entity body of policy type\r
      *\r
-     * @return the ToscaServiceTemplate objects\r
+     * @return the ToscaServiceTemplate object\r
+     * @throws PfModelException the PfModel parsing exception\r
+     */\r
+    public ToscaServiceTemplate createPolicyType(ToscaServiceTemplate body) throws PfModelException {\r
+\r
+        if (!hasPolicyType(body)) {\r
+            throw new PfModelException(Response.Status.BAD_REQUEST,\r
+                    "no policy types specified in the service template");\r
+        }\r
+\r
+        return modelsProvider.createPolicyTypes(body);\r
+    }\r
+\r
+    /**\r
+     * Delete the policy type matching specified policy type ID and version.\r
+     *\r
+     * @param policyTypeId the ID of policy type\r
+     * @param policyTypeVersion the version of policy type\r
+     *\r
+     * @return the ToscaServiceTemplate object\r
+     *\r
+     * @throws PfModelException the PfModel parsing exception\r
+     */\r
+    public ToscaServiceTemplate deletePolicyType(String policyTypeId, String policyTypeVersion)\r
+            throws PfModelException {\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
+     * Retrieves the specified version of the policy type.\r
+     *\r
+     * @param policyTypeName the name of the policy type\r
+     * @param policyTypeVersion the version of the policy type\r
+     *\r
+     * @return the TOSCA service template containing the specified version of the policy type\r
+     *\r
+     * @throws PfModelException the PfModel parsing exception\r
      */\r
-    public ToscaServiceTemplate createPolicyType(ToscaServiceTemplate body) {\r
-        // placeholder\r
-        return new ToscaServiceTemplate();\r
+    private ToscaServiceTemplate getFilteredPolicyTypes(String policyTypeName, String policyTypeVersion)\r
+            throws PfModelException {\r
+\r
+        ToscaPolicyTypeFilter policyTypeFilter =\r
+                ToscaPolicyTypeFilter.builder().name(policyTypeName).version(policyTypeVersion).build();\r
+        return modelsProvider.getFilteredPolicyTypes(policyTypeFilter);\r
     }\r
 \r
     /**\r
-     * Delete the policy types matching specified policy type ID and version.\r
+     * Constructs returned message for not found resource.\r
      *\r
      * @param policyTypeId the ID of policy type\r
      * @param policyTypeVersion the version of policy type\r
      *\r
-     * @return a string message indicating the operation results\r
+     * @return constructed message\r
      */\r
-    public String deletePolicyTypes(String policyTypeId, String policyTypeVersion) {\r
-        // placeholder\r
-        return DELETE_OK;\r
+    private String constructResourceNotFoundMessage(String policyTypeId, String policyTypeVersion) {\r
+\r
+        return "policy type with ID " + policyTypeId + ":" + policyTypeVersion + " does not exist";\r
     }\r
 }\r