Implement validation and hierarchical get
[policy/models.git] / models-tosca / src / main / java / org / onap / policy / models / tosca / authorative / provider / AuthorativeToscaProvider.java
index 4bf0146..6e60303 100644 (file)
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2019 Nordix Foundation.
+ *  Copyright (C) 2019-2020 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.
@@ -25,11 +26,15 @@ import java.util.Collections;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.TreeMap;
+
+import javax.ws.rs.core.Response.Status;
 
 import lombok.NonNull;
 
 import org.onap.policy.models.base.PfConceptKey;
 import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.base.PfModelRuntimeException;
 import org.onap.policy.models.dao.PfDao;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
@@ -39,6 +44,8 @@ import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
 import org.onap.policy.models.tosca.simple.provider.SimpleToscaProvider;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * This class provides the provision of information on TOSCA concepts in the database to callers.
@@ -46,6 +53,8 @@ import org.onap.policy.models.tosca.simple.provider.SimpleToscaProvider;
  * @author Liam Fallon (liam.fallon@est.tech)
  */
 public class AuthorativeToscaProvider {
+    private static final Logger LOGGER = LoggerFactory.getLogger(AuthorativeToscaProvider.class);
+
     /**
      * Get policy types.
      *
@@ -58,7 +67,14 @@ public class AuthorativeToscaProvider {
     public ToscaServiceTemplate getPolicyTypes(@NonNull final PfDao dao, final String name, final String version)
             throws PfModelException {
 
-        return new SimpleToscaProvider().getPolicyTypes(dao, name, version).toAuthorative();
+        LOGGER.debug("->getPolicyTypes: name={}, version={}", name, version);
+
+        JpaToscaServiceTemplate jpaServiceTemplate = new SimpleToscaProvider().getPolicyTypes(dao, name, version);
+
+        ToscaServiceTemplate serviceTemplate = jpaServiceTemplate.toAuthorative();
+
+        LOGGER.debug("<-getPolicyTypes: name={}, version={}, serviceTemplate={}", name, version, serviceTemplate);
+        return serviceTemplate;
     }
 
     /**
@@ -73,8 +89,19 @@ public class AuthorativeToscaProvider {
     public List<ToscaPolicyType> getPolicyTypeList(@NonNull final PfDao dao, final String name, final String version)
             throws PfModelException {
 
-        return (asConceptList(
-                new SimpleToscaProvider().getPolicyTypes(dao, name, version).toAuthorative().getPolicyTypes()));
+        LOGGER.debug("->getPolicyTypeList: name={}, version={}", name, version);
+
+        List<ToscaPolicyType> policyTypeList;
+
+        try {
+            policyTypeList = new ArrayList<>(new SimpleToscaProvider().getPolicyTypes(dao, name, version)
+                    .toAuthorative().getPolicyTypes().values());
+        } catch (PfModelRuntimeException pfme) {
+            return handlePfModelRuntimeException(pfme);
+        }
+
+        LOGGER.debug("<-getPolicyTypeList: name={}, version={}, policyTypeList={}", name, version, policyTypeList);
+        return policyTypeList;
     }
 
     /**
@@ -88,14 +115,17 @@ public class AuthorativeToscaProvider {
     public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull final PfDao dao,
             @NonNull final ToscaPolicyTypeFilter filter) throws PfModelException {
 
+        LOGGER.debug("->getFilteredPolicyTypes: filter={}", filter);
+
         ToscaServiceTemplate serviceTemplate =
                 new SimpleToscaProvider().getPolicyTypes(dao, null, null).toAuthorative();
 
-        List<ToscaPolicyType> filteredPolicyTypes = asConceptList(serviceTemplate.getPolicyTypes());
+        List<ToscaPolicyType> filteredPolicyTypes = new ArrayList<>(serviceTemplate.getPolicyTypes().values());
         filteredPolicyTypes = filter.filter(filteredPolicyTypes);
 
         serviceTemplate.setPolicyTypes(asConceptMap(filteredPolicyTypes));
 
+        LOGGER.debug("<-getFilteredPolicyTypes: filter={}, serviceTemplate={}", filter, serviceTemplate);
         return serviceTemplate;
     }
 
@@ -110,7 +140,14 @@ public class AuthorativeToscaProvider {
     public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull final PfDao dao,
             @NonNull final ToscaPolicyTypeFilter filter) throws PfModelException {
 
-        return filter.filter(getPolicyTypeList(dao, null, null));
+        LOGGER.debug("->getFilteredPolicyTypeList: filter={}", filter);
+
+        List<ToscaPolicyType> filteredPolicyTypeList = filter.filter(getPolicyTypeList(dao, null, null));
+
+        LOGGER.debug("<-getFilteredPolicyTypeList: filter={}, filteredPolicyTypeList={}", filter,
+                filteredPolicyTypeList);
+
+        return filteredPolicyTypeList;
     }
 
     /**
@@ -124,8 +161,13 @@ public class AuthorativeToscaProvider {
     public ToscaServiceTemplate createPolicyTypes(@NonNull final PfDao dao,
             @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 
-        return new SimpleToscaProvider().createPolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate))
-                .toAuthorative();
+        LOGGER.debug("->createPolicyTypes: serviceTemplate={}", serviceTemplate);
+
+        ToscaServiceTemplate createdServiceTempalate = new SimpleToscaProvider()
+                .createPolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
+
+        LOGGER.debug("<-createPolicyTypes: createdServiceTempalate={}", createdServiceTempalate);
+        return createdServiceTempalate;
     }
 
     /**
@@ -139,8 +181,13 @@ public class AuthorativeToscaProvider {
     public ToscaServiceTemplate updatePolicyTypes(@NonNull final PfDao dao,
             @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 
-        return new SimpleToscaProvider().updatePolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate))
-                .toAuthorative();
+        LOGGER.debug("->updatePolicyTypes: serviceTempalate={}", serviceTemplate);
+
+        ToscaServiceTemplate updatedServiceTempalate = new SimpleToscaProvider()
+                .updatePolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
+
+        LOGGER.debug("<-updatePolicyTypes: updatedServiceTempalate={}", updatedServiceTempalate);
+        return updatedServiceTempalate;
     }
 
     /**
@@ -155,7 +202,14 @@ public class AuthorativeToscaProvider {
     public ToscaServiceTemplate deletePolicyType(@NonNull final PfDao dao, @NonNull final String name,
             @NonNull final String version) throws PfModelException {
 
-        return new SimpleToscaProvider().deletePolicyType(dao, new PfConceptKey(name, version)).toAuthorative();
+        LOGGER.debug("->deletePolicyType: name={}, version={}", name, version);
+
+        ToscaServiceTemplate deletedServiceTempalate =
+                new SimpleToscaProvider().deletePolicyType(dao, new PfConceptKey(name, version)).toAuthorative();
+
+        LOGGER.debug("<-deletePolicyType: name={}, version={}, deletedServiceTempalate={}", name, version,
+                deletedServiceTempalate);
+        return deletedServiceTempalate;
     }
 
     /**
@@ -169,8 +223,13 @@ public class AuthorativeToscaProvider {
      */
     public ToscaServiceTemplate getPolicies(@NonNull final PfDao dao, final String name, final String version)
             throws PfModelException {
+        LOGGER.debug("->getPolicies: name={}, version={}", name, version);
+
+        ToscaServiceTemplate gotServiceTempalate =
+                new SimpleToscaProvider().getPolicies(dao, name, version).toAuthorative();
 
-        return new SimpleToscaProvider().getPolicies(dao, name, version).toAuthorative();
+        LOGGER.debug("<-getPolicies: name={}, version={}, gotServiceTempalate={}", name, version, gotServiceTempalate);
+        return gotServiceTempalate;
     }
 
     /**
@@ -184,9 +243,19 @@ public class AuthorativeToscaProvider {
      */
     public List<ToscaPolicy> getPolicyList(@NonNull final PfDao dao, final String name, final String version)
             throws PfModelException {
+        LOGGER.debug("->getPolicyList: name={}, version={}", name, version);
 
-        return asConceptList(new SimpleToscaProvider().getPolicies(dao, name, version).toAuthorative()
-                .getToscaTopologyTemplate().getPolicies());
+        List<ToscaPolicy> policyList;
+
+        try {
+            policyList = asConceptList(new SimpleToscaProvider().getPolicies(dao, name, version).toAuthorative()
+                    .getToscaTopologyTemplate().getPolicies());
+        } catch (PfModelRuntimeException pfme) {
+            return handlePfModelRuntimeException(pfme);
+        }
+
+        LOGGER.debug("<-getPolicyList: name={}, version={}, policyTypeList={}", name, version, policyList);
+        return policyList;
     }
 
     /**
@@ -200,13 +269,18 @@ public class AuthorativeToscaProvider {
     public ToscaServiceTemplate getFilteredPolicies(@NonNull final PfDao dao, @NonNull final ToscaPolicyFilter filter)
             throws PfModelException {
 
-        ToscaServiceTemplate serviceTemplate = new SimpleToscaProvider().getPolicies(dao, null, null).toAuthorative();
+        LOGGER.debug("->getFilteredPolicies: filter={}", filter);
+        String version = ToscaPolicyFilter.LATEST_VERSION.equals(filter.getVersion()) ? null : filter.getVersion();
+
+        ToscaServiceTemplate serviceTemplate =
+                new SimpleToscaProvider().getPolicies(dao, filter.getName(), version).toAuthorative();
 
         List<ToscaPolicy> filteredPolicies = asConceptList(serviceTemplate.getToscaTopologyTemplate().getPolicies());
         filteredPolicies = filter.filter(filteredPolicies);
 
-        serviceTemplate.getToscaTopologyTemplate().setPolicies(asConceptMap(filteredPolicies));
+        serviceTemplate.getToscaTopologyTemplate().setPolicies(asConceptMapList(filteredPolicies));
 
+        LOGGER.debug("<-getFilteredPolicies: filter={}, serviceTemplate={}", filter, serviceTemplate);
         return serviceTemplate;
     }
 
@@ -221,7 +295,13 @@ public class AuthorativeToscaProvider {
     public List<ToscaPolicy> getFilteredPolicyList(@NonNull final PfDao dao, @NonNull final ToscaPolicyFilter filter)
             throws PfModelException {
 
-        return filter.filter(getPolicyList(dao, null, null));
+        LOGGER.debug("->getFilteredPolicyList: filter={}", filter);
+        String version = ToscaPolicyFilter.LATEST_VERSION.equals(filter.getVersion()) ? null : filter.getVersion();
+
+        List<ToscaPolicy> policyList = filter.filter(getPolicyList(dao, filter.getName(), version));
+
+        LOGGER.debug("<-getFilteredPolicyList: filter={}, policyList={}", filter, policyList);
+        return policyList;
     }
 
     /**
@@ -235,8 +315,13 @@ public class AuthorativeToscaProvider {
     public ToscaServiceTemplate createPolicies(@NonNull final PfDao dao,
             @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 
-        return new SimpleToscaProvider().createPolicies(dao, new JpaToscaServiceTemplate(serviceTemplate))
-                .toAuthorative();
+        LOGGER.debug("->createPolicies: serviceTempalate={}", serviceTemplate);
+
+        ToscaServiceTemplate createdServiceTempalate = new SimpleToscaProvider()
+                .createPolicies(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
+
+        LOGGER.debug("<-createPolicies: createdServiceTempalate={}", createdServiceTempalate);
+        return createdServiceTempalate;
     }
 
     /**
@@ -250,8 +335,13 @@ public class AuthorativeToscaProvider {
     public ToscaServiceTemplate updatePolicies(@NonNull final PfDao dao,
             @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 
-        return new SimpleToscaProvider().updatePolicies(dao, new JpaToscaServiceTemplate(serviceTemplate))
-                .toAuthorative();
+        LOGGER.debug("->updatePolicies: serviceTempalate={}", serviceTemplate);
+
+        ToscaServiceTemplate updatedServiceTempalate = new SimpleToscaProvider()
+                .updatePolicies(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
+
+        LOGGER.debug("<-updatePolicies: updatedServiceTempalate={}", updatedServiceTempalate);
+        return updatedServiceTempalate;
     }
 
     /**
@@ -266,7 +356,14 @@ public class AuthorativeToscaProvider {
     public ToscaServiceTemplate deletePolicy(@NonNull final PfDao dao, @NonNull final String name,
             @NonNull final String version) throws PfModelException {
 
-        return new SimpleToscaProvider().deletePolicy(dao, new PfConceptKey(name, version)).toAuthorative();
+        LOGGER.debug("->deletePolicy: name={}, version={}", name, version);
+
+        ToscaServiceTemplate deletedServiceTempalate =
+                new SimpleToscaProvider().deletePolicy(dao, new PfConceptKey(name, version)).toAuthorative();
+
+        LOGGER.debug("<-deletePolicy: name={}, version={}, deletedServiceTempalate={}", name, version,
+                deletedServiceTempalate);
+        return deletedServiceTempalate;
     }
 
     /**
@@ -276,10 +373,6 @@ public class AuthorativeToscaProvider {
      * @return the plain list
      */
     private <T> List<T> asConceptList(final List<Map<String, T>> listOfMaps) {
-        if (listOfMaps == null) {
-            return Collections.emptyList();
-        }
-
         List<T> returnList = new ArrayList<>();
         for (Map<String, T> conceptMap : listOfMaps) {
             for (T concept : conceptMap.values()) {
@@ -293,15 +386,46 @@ public class AuthorativeToscaProvider {
     /**
      * Return the contents of a list of concepts as a list of maps of concepts.
      *
-     * @param comceptList the concept list
-     * @return the concept map
+     * @param conceptList the concept list
+     * @return the list of concept map
+     */
+    private <T extends ToscaEntity> List<Map<String, T>> asConceptMapList(List<T> conceptList) {
+        List<Map<String, T>> toscaEntityMapList = new ArrayList<>();
+        for (T concept : conceptList) {
+            Map<String, T> conceptMap = new TreeMap<>();
+            conceptMap.put(concept.getName(), concept);
+            toscaEntityMapList.add(conceptMap);
+        }
+
+        return toscaEntityMapList;
+    }
+
+    /**
+     * Return the contents of a list of concepts as map of concepts.
+     *
+     * @param conceptList the concept list
+     * @return the list of concept map
      */
-    private <T extends ToscaEntity> List<Map<String, T>> asConceptMap(List<T> conceptList) {
+    private <T extends ToscaEntity> Map<String, T> asConceptMap(List<T> conceptList) {
         Map<String, T> conceptMap = new LinkedHashMap<>();
         for (T concept : conceptList) {
             conceptMap.put(concept.getName(), concept);
         }
 
-        return Collections.singletonList(conceptMap);
+        return conceptMap;
+    }
+
+    /**
+     * Handle a PfModelRuntimeException on a list call.
+     *
+     * @param pfme the model exception
+     * @return an empty list on 404
+     */
+    private <T extends ToscaEntity> List<T> handlePfModelRuntimeException(final PfModelRuntimeException pfme) {
+        if (Status.NOT_FOUND.equals(pfme.getErrorResponse().getResponseCode())) {
+            return Collections.emptyList();
+        } else {
+            throw pfme;
+        }
     }
 }