Add changes for safe delete in policy-models
[policy/api.git] / main / src / main / java / org / onap / policy / api / main / rest / provider / LegacyGuardPolicyProvider.java
index f627493..80c57d3 100644 (file)
@@ -2,7 +2,8 @@
  * ============LICENSE_START=======================================================
  * ONAP Policy API
  * ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2020 Nordix Foundation.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 
 package org.onap.policy.api.main.rest.provider;
 
-import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicy;
-import org.onap.policy.models.tosca.simple.concepts.ToscaServiceTemplate;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import javax.ws.rs.core.Response;
+
+import org.apache.commons.lang3.tuple.Pair;
+import org.onap.policy.models.base.PfConceptKey;
+import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
+import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
 
 /**
  * Class to provide all kinds of legacy guard policy operations.
  *
  * @author Chenfei Gao (cgao@research.att.com)
  */
-public class LegacyGuardPolicyProvider {
+public class LegacyGuardPolicyProvider extends CommonModelProvider {
 
-    private static final String DELETE_OK = "Successfully deleted";
+    private static final Map<String, PfConceptKey> GUARD_POLICY_TYPE_MAP = new LinkedHashMap<>();
+
+    static {
+        GUARD_POLICY_TYPE_MAP.put("guard.frequency.",
+                new PfConceptKey("onap.policies.controlloop.guard.FrequencyLimiter:1.0.0"));
+        GUARD_POLICY_TYPE_MAP.put("guard.minmax.", new PfConceptKey("onap.policies.controlloop.guard.MinMax:1.0.0"));
+        GUARD_POLICY_TYPE_MAP.put("guard.blacklist.",
+                new PfConceptKey("onap.policies.controlloop.guard.Blacklist:1.0.0"));
+    }
+
+    /**
+     * Default constructor.
+     */
+    public LegacyGuardPolicyProvider() throws PfModelException {
+        super();
+    }
 
     /**
      * Retrieves a list of guard policies matching specified ID and version.
@@ -40,11 +66,28 @@ public class LegacyGuardPolicyProvider {
      * @param policyId the ID of policy
      * @param policyVersion the version of policy
      *
-     * @return the ToscaServiceTemplate object
+     * @return the map of LegacyGuardPolicyOutput objects
      */
-    public ToscaServiceTemplate fetchGuardPolicies(String policyId, String policyVersion) {
-        // placeholder
-        return new ToscaServiceTemplate();
+    public Map<String, LegacyGuardPolicyOutput> fetchGuardPolicy(String policyId, String policyVersion)
+            throws PfModelException {
+
+        return modelsProvider.getGuardPolicy(policyId, policyVersion);
+    }
+
+    /**
+     * Retrieves a list of deployed guard policies in each pdp group.
+     *
+     * @param policyId the ID of the policy
+     *
+     * @return a list of deployed policies in each pdp group
+     *
+     * @throws PfModelException the PfModel parsing exception
+     */
+    public Map<Pair<String, String>, Map<String, LegacyGuardPolicyOutput>> fetchDeployedGuardPolicies(String policyId)
+            throws PfModelException {
+
+        return collectDeployedPolicies(policyId, getGuardPolicyType(policyId), modelsProvider::getGuardPolicy,
+                Map::putAll, new HashMap<>());
     }
 
     /**
@@ -52,11 +95,11 @@ public class LegacyGuardPolicyProvider {
      *
      * @param body the entity body of policy
      *
-     * @return the ToscaServiceTemplate object
+     * @return the map of LegacyGuardPolicyOutput objectst
      */
-    public ToscaServiceTemplate createGuardPolicy(LegacyGuardPolicy body) {
-        // placeholder
-        return new ToscaServiceTemplate();
+    public Map<String, LegacyGuardPolicyOutput> createGuardPolicy(LegacyGuardPolicyInput body) throws PfModelException {
+
+        return modelsProvider.createGuardPolicy(body);
     }
 
     /**
@@ -65,10 +108,30 @@ public class LegacyGuardPolicyProvider {
      * @param policyId the ID of policy
      * @param policyVersion the version of policy
      *
-     * @return a string message indicating the operation results
+     * @return the map of LegacyGuardPolicyOutput objects
      */
-    public String deleteGuardPolicies(String policyId, String policyVersion) {
-        // placeholder
-        return DELETE_OK;
+    public Map<String, LegacyGuardPolicyOutput> deleteGuardPolicy(String policyId, String policyVersion)
+            throws PfModelException {
+
+        return modelsProvider.deleteGuardPolicy(policyId, policyVersion);
+    }
+
+    /**
+     * Retrieves guard policy type given guard policy ID.
+     *
+     * @param policyId the ID of guard policy
+     *
+     * @return the concept key of guard policy type
+     *
+     * @throws PfModelException the PfModel parsing exception
+     */
+    private PfConceptKey getGuardPolicyType(String policyId) throws PfModelException {
+
+        for (Entry<String, PfConceptKey> guardPolicyTypeEntry : GUARD_POLICY_TYPE_MAP.entrySet()) {
+            if (policyId.startsWith(guardPolicyTypeEntry.getKey())) {
+                return guardPolicyTypeEntry.getValue();
+            }
+        }
+        throw new PfModelException(Response.Status.BAD_REQUEST, "No policy type defined for " + policyId);
     }
 }
\ No newline at end of file