Changes for Checkstyle 8.32
[policy/models.git] / models-tosca / src / main / java / org / onap / policy / models / tosca / authorative / provider / AuthorativeToscaProvider.java
index 274130a..c1d46bf 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.
@@ -24,12 +25,15 @@ import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
-
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.Response.Status;
 import lombok.NonNull;
-
+import org.apache.commons.collections4.CollectionUtils;
 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;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
@@ -37,6 +41,9 @@ 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.onap.policy.models.tosca.utils.ToscaServiceTemplateUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * This class provides the provision of information on TOSCA concepts in the database to callers.
@@ -44,6 +51,11 @@ 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);
+
+    // TODO: In next release this locking mechanism should be removed and replaced with proper session handling
+    private static final Object providerLockObject = "providerLockObject";
+
     /**
      * Get policy types.
      *
@@ -54,9 +66,18 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors getting policy types
      */
     public ToscaServiceTemplate getPolicyTypes(@NonNull final PfDao dao, final String name, final String version)
-            throws PfModelException {
+        throws PfModelException {
+
+        synchronized (providerLockObject) {
+            LOGGER.debug("->getPolicyTypes: name={}, version={}", name, version);
 
-        return new SimpleToscaProvider().getPolicyTypes(dao, name, version).toAuthorative();
+            JpaToscaServiceTemplate jpaServiceTemplate = new SimpleToscaProvider().getPolicyTypes(dao, name, version);
+
+            ToscaServiceTemplate serviceTemplate = jpaServiceTemplate.toAuthorative();
+
+            LOGGER.debug("<-getPolicyTypes: name={}, version={}, serviceTemplate={}", name, version, serviceTemplate);
+            return serviceTemplate;
+        }
     }
 
     /**
@@ -69,10 +90,23 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors getting policy types
      */
     public List<ToscaPolicyType> getPolicyTypeList(@NonNull final PfDao dao, final String name, final String version)
-            throws PfModelException {
+        throws PfModelException {
+
+        synchronized (providerLockObject) {
+            LOGGER.debug("->getPolicyTypeList: name={}, version={}", name, version);
+
+            List<ToscaPolicyType> policyTypeList;
 
-        return (asConceptList(
-                new SimpleToscaProvider().getPolicyTypes(dao, name, version).toAuthorative().getPolicyTypes()));
+            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;
+        }
     }
 
     /**
@@ -84,8 +118,37 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors getting policy types
      */
     public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull final PfDao dao,
-            @NonNull final ToscaPolicyTypeFilter filter) throws PfModelException {
-        return new SimpleToscaProvider().getFilteredPolicyTypes(dao, filter).toAuthorative();
+        @NonNull final ToscaPolicyTypeFilter filter) throws PfModelException {
+
+        synchronized (providerLockObject) {
+            LOGGER.debug("->getFilteredPolicyTypes: filter={}", filter);
+            SimpleToscaProvider simpleToscaProvider = new SimpleToscaProvider();
+
+            final JpaToscaServiceTemplate dbServiceTemplate = simpleToscaProvider.getPolicyTypes(dao, null, null);
+
+            List<ToscaPolicyType> filteredPolicyTypes = dbServiceTemplate.getPolicyTypes().toAuthorativeList();
+            filteredPolicyTypes = filter.filter(filteredPolicyTypes);
+
+            if (CollectionUtils.isEmpty(filteredPolicyTypes)) {
+                throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
+                    "policy types for filter " + filter.toString() + " do not exist");
+            }
+
+            JpaToscaServiceTemplate filteredServiceTemplate = new JpaToscaServiceTemplate();
+
+            for (ToscaPolicyType policyType : filteredPolicyTypes) {
+                JpaToscaServiceTemplate cascadedServiceTemplate = simpleToscaProvider
+                    .getCascadedPolicyTypes(dbServiceTemplate, policyType.getName(), policyType.getVersion());
+
+                filteredServiceTemplate =
+                    ToscaServiceTemplateUtils.addFragment(filteredServiceTemplate, cascadedServiceTemplate);
+            }
+
+            ToscaServiceTemplate returnServiceTemplate = filteredServiceTemplate.toAuthorative();
+
+            LOGGER.debug("<-getFilteredPolicyTypes: filter={}, serviceTemplate={}", filter, returnServiceTemplate);
+            return returnServiceTemplate;
+        }
     }
 
     /**
@@ -97,10 +160,16 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors getting policy types
      */
     public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull final PfDao dao,
-            @NonNull final ToscaPolicyTypeFilter filter) throws PfModelException {
+        @NonNull final ToscaPolicyTypeFilter filter) throws PfModelException {
 
-        return (asConceptList(
-                new SimpleToscaProvider().getFilteredPolicyTypes(dao, filter).toAuthorative().getPolicyTypes()));
+        LOGGER.debug("->getFilteredPolicyTypeList: filter={}", filter);
+
+        List<ToscaPolicyType> filteredPolicyTypeList = filter.filter(getPolicyTypeList(dao, null, null));
+
+        LOGGER.debug("<-getFilteredPolicyTypeList: filter={}, filteredPolicyTypeList={}", filter,
+            filteredPolicyTypeList);
+
+        return filteredPolicyTypeList;
     }
 
     /**
@@ -112,10 +181,17 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors creating policy types
      */
     public ToscaServiceTemplate createPolicyTypes(@NonNull final PfDao dao,
-            @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
+        @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
+
+        synchronized (providerLockObject) {
+            LOGGER.debug("->createPolicyTypes: serviceTemplate={}", serviceTemplate);
+
+            ToscaServiceTemplate createdServiceTempalate = new SimpleToscaProvider()
+                .createPolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
 
-        return new SimpleToscaProvider().createPolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate))
-                .toAuthorative();
+            LOGGER.debug("<-createPolicyTypes: createdServiceTempalate={}", createdServiceTempalate);
+            return createdServiceTempalate;
+        }
     }
 
     /**
@@ -127,10 +203,17 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors updating policy types
      */
     public ToscaServiceTemplate updatePolicyTypes(@NonNull final PfDao dao,
-            @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
+        @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
+
+        synchronized (providerLockObject) {
+            LOGGER.debug("->updatePolicyTypes: serviceTempalate={}", serviceTemplate);
+
+            ToscaServiceTemplate updatedServiceTempalate = new SimpleToscaProvider()
+                .updatePolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
 
-        return new SimpleToscaProvider().updatePolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate))
-                .toAuthorative();
+            LOGGER.debug("<-updatePolicyTypes: updatedServiceTempalate={}", updatedServiceTempalate);
+            return updatedServiceTempalate;
+        }
     }
 
     /**
@@ -143,9 +226,18 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors deleting policy types
      */
     public ToscaServiceTemplate deletePolicyType(@NonNull final PfDao dao, @NonNull final String name,
-            @NonNull final String version) throws PfModelException {
+        @NonNull final String version) throws PfModelException {
+
+        synchronized (providerLockObject) {
+            LOGGER.debug("->deletePolicyType: name={}, version={}", name, version);
 
-        return new SimpleToscaProvider().deletePolicyType(dao, new PfConceptKey(name, version)).toAuthorative();
+            ToscaServiceTemplate deletedServiceTempalate =
+                new SimpleToscaProvider().deletePolicyType(dao, new PfConceptKey(name, version)).toAuthorative();
+
+            LOGGER.debug("<-deletePolicyType: name={}, version={}, deletedServiceTempalate={}", name, version,
+                deletedServiceTempalate);
+            return deletedServiceTempalate;
+        }
     }
 
     /**
@@ -157,10 +249,19 @@ public class AuthorativeToscaProvider {
      * @return the policies found
      * @throws PfModelException on errors getting policies
      */
-    public ToscaServiceTemplate getPolicies(@NonNull final PfDao dao, @NonNull final String name,
-            @NonNull final String version) throws PfModelException {
+    public ToscaServiceTemplate getPolicies(@NonNull final PfDao dao, final String name, final String version)
+        throws PfModelException {
+
+        synchronized (providerLockObject) {
+            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;
+        }
     }
 
     /**
@@ -173,10 +274,23 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors getting policies
      */
     public List<ToscaPolicy> getPolicyList(@NonNull final PfDao dao, final String name, final String version)
-            throws PfModelException {
+        throws PfModelException {
+
+        synchronized (providerLockObject) {
+            LOGGER.debug("->getPolicyList: name={}, version={}", name, version);
+
+            List<ToscaPolicy> policyList;
+
+            try {
+                policyList = asConceptList(new SimpleToscaProvider().getPolicies(dao, name, version).toAuthorative()
+                    .getToscaTopologyTemplate().getPolicies());
+            } catch (PfModelRuntimeException pfme) {
+                return handlePfModelRuntimeException(pfme);
+            }
 
-        return asConceptList(new SimpleToscaProvider().getPolicies(dao, name, version).toAuthorative()
-                .getToscaTopologyTemplate().getPolicies());
+            LOGGER.debug("<-getPolicyList: name={}, version={}, policyTypeList={}", name, version, policyList);
+            return policyList;
+        }
     }
 
     /**
@@ -188,9 +302,40 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors getting policies
      */
     public ToscaServiceTemplate getFilteredPolicies(@NonNull final PfDao dao, @NonNull final ToscaPolicyFilter filter)
-            throws PfModelException {
+        throws PfModelException {
+
+        synchronized (providerLockObject) {
+            LOGGER.debug("->getFilteredPolicies: filter={}", filter);
+            String version = ToscaPolicyFilter.LATEST_VERSION.equals(filter.getVersion()) ? null : filter.getVersion();
+
+            SimpleToscaProvider simpleToscaProvider = new SimpleToscaProvider();
+            final JpaToscaServiceTemplate dbServiceTemplate =
+                simpleToscaProvider.getPolicies(dao, filter.getName(), version);
 
-        return new SimpleToscaProvider().getFilteredPolicies(dao, filter).toAuthorative();
+            List<ToscaPolicy> filteredPolicies =
+                dbServiceTemplate.getTopologyTemplate().getPolicies().toAuthorativeList();
+            filteredPolicies = filter.filter(filteredPolicies);
+
+            if (CollectionUtils.isEmpty(filteredPolicies)) {
+                throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
+                    "policies for filter " + filter.toString() + " do not exist");
+            }
+
+            JpaToscaServiceTemplate filteredServiceTemplate = new JpaToscaServiceTemplate();
+
+            for (ToscaPolicy policy : filteredPolicies) {
+                JpaToscaServiceTemplate cascadedServiceTemplate =
+                    simpleToscaProvider.getCascadedPolicies(dbServiceTemplate, policy.getName(), policy.getVersion());
+
+                filteredServiceTemplate =
+                    ToscaServiceTemplateUtils.addFragment(filteredServiceTemplate, cascadedServiceTemplate);
+            }
+
+            ToscaServiceTemplate returnServiceTemplate = filteredServiceTemplate.toAuthorative();
+
+            LOGGER.debug("<-getFilteredPolicies: filter={}, serviceTemplate={}", filter, returnServiceTemplate);
+            return returnServiceTemplate;
+        }
     }
 
     /**
@@ -202,10 +347,15 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors getting policies
      */
     public List<ToscaPolicy> getFilteredPolicyList(@NonNull final PfDao dao, @NonNull final ToscaPolicyFilter filter)
-            throws PfModelException {
+        throws PfModelException {
+
+        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));
 
-        return asConceptList(new SimpleToscaProvider().getFilteredPolicies(dao, filter).toAuthorative()
-                .getToscaTopologyTemplate().getPolicies());
+        LOGGER.debug("<-getFilteredPolicyList: filter={}, policyList={}", filter, policyList);
+        return policyList;
     }
 
     /**
@@ -217,10 +367,17 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors creating policies
      */
     public ToscaServiceTemplate createPolicies(@NonNull final PfDao dao,
-            @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
+        @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 
-        return new SimpleToscaProvider().createPolicies(dao, new JpaToscaServiceTemplate(serviceTemplate))
-                .toAuthorative();
+        synchronized (providerLockObject) {
+            LOGGER.debug("->createPolicies: serviceTempalate={}", serviceTemplate);
+
+            ToscaServiceTemplate createdServiceTempalate = new SimpleToscaProvider()
+                .createPolicies(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
+
+            LOGGER.debug("<-createPolicies: createdServiceTempalate={}", createdServiceTempalate);
+            return createdServiceTempalate;
+        }
     }
 
     /**
@@ -232,10 +389,17 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors updating policies
      */
     public ToscaServiceTemplate updatePolicies(@NonNull final PfDao dao,
-            @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
+        @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
+
+        synchronized (providerLockObject) {
+            LOGGER.debug("->updatePolicies: serviceTempalate={}", serviceTemplate);
+
+            ToscaServiceTemplate updatedServiceTempalate = new SimpleToscaProvider()
+                .updatePolicies(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
 
-        return new SimpleToscaProvider().updatePolicies(dao, new JpaToscaServiceTemplate(serviceTemplate))
-                .toAuthorative();
+            LOGGER.debug("<-updatePolicies: updatedServiceTempalate={}", updatedServiceTempalate);
+            return updatedServiceTempalate;
+        }
     }
 
     /**
@@ -248,9 +412,18 @@ public class AuthorativeToscaProvider {
      * @throws PfModelException on errors deleting policies
      */
     public ToscaServiceTemplate deletePolicy(@NonNull final PfDao dao, @NonNull final String name,
-            @NonNull final String version) throws PfModelException {
+        @NonNull final String version) throws PfModelException {
+
+        synchronized (providerLockObject) {
+            LOGGER.debug("->deletePolicy: name={}, version={}", name, version);
+
+            ToscaServiceTemplate deletedServiceTempalate =
+                new SimpleToscaProvider().deletePolicy(dao, new PfConceptKey(name, version)).toAuthorative();
 
-        return new SimpleToscaProvider().deletePolicy(dao, new PfConceptKey(name, version)).toAuthorative();
+            LOGGER.debug("<-deletePolicy: name={}, version={}, deletedServiceTempalate={}", name, version,
+                deletedServiceTempalate);
+            return deletedServiceTempalate;
+        }
     }
 
     /**
@@ -260,10 +433,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()) {
@@ -273,4 +442,19 @@ public class AuthorativeToscaProvider {
 
         return returnList;
     }
+
+    /**
+     * 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())) {
+            LOGGER.trace("request did not find any results", pfme);
+            return Collections.emptyList();
+        } else {
+            throw pfme;
+        }
+    }
 }