Changes for Checkstyle 8.32
[policy/models.git] / models-pdp / src / main / java / org / onap / policy / models / pdp / persistence / provider / PdpProvider.java
index a32f5a4..7ea7cd3 100644 (file)
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
  *  Copyright (C) 2019 Nordix Foundation.
+ *  Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * 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.models.pdp.persistence.provider;
 
 import java.util.ArrayList;
-import java.util.Collections;
-import java.util.LinkedHashMap;
 import java.util.List;
-import java.util.Map;
-
 import javax.ws.rs.core.Response;
-
 import lombok.NonNull;
-
-import org.apache.commons.lang3.tuple.Pair;
 import org.onap.policy.models.base.PfConceptKey;
+import org.onap.policy.models.base.PfKey;
 import org.onap.policy.models.base.PfModelException;
 import org.onap.policy.models.base.PfModelRuntimeException;
+import org.onap.policy.models.base.PfReferenceKey;
 import org.onap.policy.models.base.PfValidationResult;
 import org.onap.policy.models.dao.PfDao;
+import org.onap.policy.models.pdp.concepts.Pdp;
 import org.onap.policy.models.pdp.concepts.PdpGroup;
+import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
 import org.onap.policy.models.pdp.concepts.PdpStatistics;
 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
+import org.onap.policy.models.pdp.persistence.concepts.JpaPdp;
 import org.onap.policy.models.pdp.persistence.concepts.JpaPdpGroup;
-import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
+import org.onap.policy.models.pdp.persistence.concepts.JpaPdpSubGroup;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -52,53 +51,34 @@ import org.slf4j.LoggerFactory;
 public class PdpProvider {
     private static final Logger LOGGER = LoggerFactory.getLogger(PdpProvider.class);
 
+    // Recurring string constants
+    private static final String NOT_VALID = "\" is not valid \n";
+
     /**
      * Get PDP groups.
      *
      * @param dao the DAO to use to access the database
-     * @param name the name of the policy to get, null to get all PDP groups
-     * @param version the version of the policy to get, null to get all versions of a PDP group
+     * @param name the name of the PDP group to get, null to get all PDP groups
      * @return the PDP groups found
      * @throws PfModelException on errors getting PDP groups
      */
-    public List<PdpGroup> getPdpGroups(@NonNull final PfDao dao, final String name, final String version)
-            throws PfModelException {
-
-        PfConceptKey jpaPdpGroupKey = new PfConceptKey(name, version);
-        JpaPdpGroup jpaPdpGroup = dao.get(JpaPdpGroup.class, jpaPdpGroupKey);
+    public List<PdpGroup> getPdpGroups(@NonNull final PfDao dao, final String name) throws PfModelException {
 
-        if (jpaPdpGroup != null) {
-            return Collections.singletonList(jpaPdpGroup.toAuthorative());
-        } else {
-            String errorMessage = "PDP group not found: " + jpaPdpGroupKey.getId();
-            LOGGER.warn(errorMessage);
-            throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
-        }
+        return asPdpGroupList(dao.getFiltered(JpaPdpGroup.class, name, PfKey.NULL_KEY_VERSION));
     }
 
     /**
-     * Get latest PDP Groups.
+     * Get filtered PDP groups.
      *
      * @param dao the DAO to use to access the database
-     * @param name the name of the PDP group to get, null to get all PDP groups
+     * @param filter the filter for the PDP groups to get
      * @return the PDP groups found
      * @throws PfModelException on errors getting policies
      */
-    public List<PdpGroup> getLatestPdpGroups(@NonNull final PfDao dao, final String name) throws PfModelException {
-        return new ArrayList<>();
-    }
+    public List<PdpGroup> getFilteredPdpGroups(@NonNull final PfDao dao, @NonNull final PdpGroupFilter filter) {
 
-    /**
-     * Get a filtered list of PDP groups.
-     *
-     * @param dao the DAO to use to access the database
-     * @param pdpType The PDP type filter for the returned PDP groups, null to get policy types across PDP subgroups
-     * @param supportedPolicyTypes a list of policy type name/version pairs that the PDP groups must support.
-     * @return the PDP groups found
-     */
-    public List<PdpGroup> getFilteredPdpGroups(@NonNull final PfDao dao, final String pdpType,
-            @NonNull final List<Pair<String, String>> supportedPolicyTypes) {
-        return new ArrayList<>();
+        return filter.filter(
+                        asPdpGroupList(dao.getFiltered(JpaPdpGroup.class, filter.getName(), PfKey.NULL_KEY_VERSION)));
     }
 
     /**
@@ -113,12 +93,12 @@ public class PdpProvider {
             throws PfModelException {
 
         for (PdpGroup pdpGroup : pdpGroups) {
-            JpaPdpGroup jpaPdpGroup = new JpaPdpGroup();;
+            JpaPdpGroup jpaPdpGroup = new JpaPdpGroup();
             jpaPdpGroup.fromAuthorative(pdpGroup);
 
             PfValidationResult validationResult = jpaPdpGroup.validate(new PfValidationResult());
             if (!validationResult.isOk()) {
-                String errorMessage = "pdp group \"" + jpaPdpGroup.getId() + "\" is not valid \n" + validationResult;
+                String errorMessage = "pdp group \"" + jpaPdpGroup.getId() + NOT_VALID + validationResult;
                 LOGGER.warn(errorMessage);
                 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
             }
@@ -131,7 +111,7 @@ public class PdpProvider {
 
         for (PdpGroup pdpGroup : pdpGroups) {
             JpaPdpGroup jpaPdpGroup =
-                    dao.get(JpaPdpGroup.class, new PfConceptKey(pdpGroup.getName(), pdpGroup.getVersion()));
+                    dao.get(JpaPdpGroup.class, new PfConceptKey(pdpGroup.getName(), PfKey.NULL_KEY_VERSION));
             returnPdpGroups.add(jpaPdpGroup.toAuthorative());
         }
 
@@ -148,22 +128,84 @@ public class PdpProvider {
      */
     public List<PdpGroup> updatePdpGroups(@NonNull final PfDao dao, @NonNull final List<PdpGroup> pdpGroups)
             throws PfModelException {
-        return new ArrayList<>();
-    }
 
+        for (PdpGroup pdpGroup : pdpGroups) {
+            JpaPdpGroup jpaPdpGroup = new JpaPdpGroup();
+            jpaPdpGroup.fromAuthorative(pdpGroup);
+
+            PfValidationResult validationResult = jpaPdpGroup.validate(new PfValidationResult());
+            if (!validationResult.isOk()) {
+                String errorMessage = "pdp group \"" + jpaPdpGroup.getId() + NOT_VALID + validationResult;
+                LOGGER.warn(errorMessage);
+                throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
+            }
+
+            dao.update(jpaPdpGroup);
+        }
+
+        // Return the created PDP groups
+        List<PdpGroup> returnPdpGroups = new ArrayList<>();
+
+        for (PdpGroup pdpGroup : pdpGroups) {
+            JpaPdpGroup jpaPdpGroup =
+                    dao.get(JpaPdpGroup.class, new PfConceptKey(pdpGroup.getName(), PfKey.NULL_KEY_VERSION));
+            returnPdpGroups.add(jpaPdpGroup.toAuthorative());
+        }
+
+        return returnPdpGroups;
+    }
 
     /**
      * Update a PDP subgroup.
      *
      * @param dao the DAO to use to access the database
      * @param pdpGroupName the name of the PDP group of the PDP subgroup
-     * @param pdpGroupVersion the version of the PDP group of the PDP subgroup
      * @param pdpSubGroup the PDP subgroup to be updated
      * @throws PfModelException on errors updating PDP subgroups
      */
     public void updatePdpSubGroup(@NonNull final PfDao dao, @NonNull final String pdpGroupName,
-            @NonNull final String pdpGroupVersion, @NonNull final PdpSubGroup pdpSubGroup) throws PfModelException {
-        // Not implemented yet
+            @NonNull final PdpSubGroup pdpSubGroup) throws PfModelException {
+
+        final PfReferenceKey subGroupKey =
+                new PfReferenceKey(pdpGroupName, PfKey.NULL_KEY_VERSION, pdpSubGroup.getPdpType());
+        final JpaPdpSubGroup jpaPdpSubgroup = new JpaPdpSubGroup(subGroupKey);
+        jpaPdpSubgroup.fromAuthorative(pdpSubGroup);
+
+        PfValidationResult validationResult = jpaPdpSubgroup.validate(new PfValidationResult());
+        if (!validationResult.isOk()) {
+            String errorMessage = "PDP subgroup \"" + jpaPdpSubgroup.getId() + NOT_VALID + validationResult;
+            LOGGER.warn(errorMessage);
+            throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
+        }
+
+        dao.update(jpaPdpSubgroup);
+    }
+
+    /**
+     * Update a PDP.
+     *
+     * @param dao the DAO to use to access the database
+     * @param pdpGroupName the name of the PDP group of the PDP subgroup
+     * @param pdpSubGroup the PDP subgroup to be updated
+     * @param pdp the PDP to be updated
+     * @throws PfModelException on errors updating PDP subgroups
+     */
+    public void updatePdp(@NonNull final PfDao dao, @NonNull final String pdpGroupName,
+            @NonNull final String pdpSubGroup, @NonNull final Pdp pdp) {
+
+        final PfReferenceKey pdpKey =
+                new PfReferenceKey(pdpGroupName, PfKey.NULL_KEY_VERSION, pdpSubGroup, pdp.getInstanceId());
+        final JpaPdp jpaPdp = new JpaPdp(pdpKey);
+        jpaPdp.fromAuthorative(pdp);
+
+        PfValidationResult validationResult = jpaPdp.validate(new PfValidationResult());
+        if (!validationResult.isOk()) {
+            String errorMessage = "PDP \"" + jpaPdp.getId() + NOT_VALID + validationResult;
+            LOGGER.warn(errorMessage);
+            throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
+        }
+
+        dao.update(jpaPdp);
     }
 
     /**
@@ -171,14 +213,24 @@ public class PdpProvider {
      *
      * @param dao the DAO to use to access the database
      * @param name the name of the policy to get, null to get all PDP groups
-     * @param version the version of the policy to get, null to get all versions of a PDP group
      * @return the PDP group deleted
      * @throws PfModelException on errors deleting PDP groups
      */
-    public PdpGroup deletePdpGroup(@NonNull final PfDao dao, @NonNull final String name, @NonNull final String version)
-            throws PfModelException {
-        return new PdpGroup();
+    public PdpGroup deletePdpGroup(@NonNull final PfDao dao, @NonNull final String name) {
+
+        PfConceptKey pdpGroupKey = new PfConceptKey(name, PfKey.NULL_KEY_VERSION);
 
+        JpaPdpGroup jpaDeletePdpGroup = dao.get(JpaPdpGroup.class, pdpGroupKey);
+
+        if (jpaDeletePdpGroup == null) {
+            String errorMessage =
+                    "delete of PDP group \"" + pdpGroupKey.getId() + "\" failed, PDP group does not exist";
+            throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
+        }
+
+        dao.delete(jpaDeletePdpGroup);
+
+        return jpaDeletePdpGroup.toAuthorative();
     }
 
     /**
@@ -186,12 +238,10 @@ public class PdpProvider {
      *
      * @param dao the DAO to use to access the database
      * @param name the name of the PDP group to get statistics for, null to get all PDP groups
-     * @param version the version of the PDP group to get statistics for, null to get all versions of a PDP group
      * @return the statistics found
      * @throws PfModelException on errors getting statistics
      */
-    public List<PdpStatistics> getPdpStatistics(@NonNull final PfDao dao, final String name, final String version)
-            throws PfModelException {
+    public List<PdpStatistics> getPdpStatistics(@NonNull final PfDao dao, final String name) throws PfModelException {
         return new ArrayList<>();
     }
 
@@ -200,27 +250,30 @@ public class PdpProvider {
      *
      * @param dao the DAO to use to access the database
      * @param pdpGroupName the name of the PDP group containing the PDP that the statistics are for
-     * @param pdpGroupVersion the version of the PDP group containing the PDP that the statistics are for
      * @param pdpType the PDP type of the subgroup containing the PDP that the statistics are for
      * @param pdpInstanceId the instance ID of the PDP to update statistics for
+     * @param pdpStatistics the statistics to update
      * @throws PfModelException on errors updating statistics
      */
     public void updatePdpStatistics(@NonNull final PfDao dao, @NonNull final String pdpGroupName,
-            @NonNull final String pdpGroupVersion, @NonNull final String pdpType, @NonNull final String pdpInstanceId,
-            @NonNull final PdpStatistics pdppStatistics) throws PfModelException {
+            @NonNull final String pdpType, @NonNull final String pdpInstanceId,
+            @NonNull final PdpStatistics pdpStatistics) throws PfModelException {
         // Not implemented yet
     }
 
     /**
-     * Get deployed policies.
+     * Convert JPA PDP group list to an authorative PDP group list.
      *
-     * @param dao the DAO to use to access the database
-     * @param name the name of the policy to get deployed policies for, null to get all deployed policies
-     * @return the policies deployed as a map of policy lists keyed by PDP group name and version
-     * @throws PfModelException on errors getting policies
+     * @param foundPdpGroups the list to convert
+     * @return the authorative list
      */
-    public Map<Pair<String, String>, List<ToscaPolicy>> getDeployedPolicyList(@NonNull final PfDao dao,
-            final String name) throws PfModelException {
-        return new LinkedHashMap<>();
+    private List<PdpGroup> asPdpGroupList(List<JpaPdpGroup> jpaPdpGroupList) {
+        List<PdpGroup> pdpGroupList = new ArrayList<>(jpaPdpGroupList.size());
+
+        for (JpaPdpGroup jpaPdpGroup : jpaPdpGroupList) {
+            pdpGroupList.add(jpaPdpGroup.toAuthorative());
+        }
+
+        return pdpGroupList;
     }
 }