d20f5d080942f326dc812d3c9167733a18cfa99b
[policy/models.git] / models-tosca / src / main / java / org / onap / policy / models / tosca / authorative / provider / AuthorativeToscaProvider.java
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2019-2020 Nordix Foundation.
4  *  Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
5  * ================================================================================
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  *      http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *
18  * SPDX-License-Identifier: Apache-2.0
19  * ============LICENSE_END=========================================================
20  */
21
22 package org.onap.policy.models.tosca.authorative.provider;
23
24 import java.util.ArrayList;
25 import java.util.Collections;
26 import java.util.List;
27 import java.util.Map;
28 import javax.ws.rs.core.Response;
29 import javax.ws.rs.core.Response.Status;
30 import lombok.NonNull;
31 import org.apache.commons.collections4.CollectionUtils;
32 import org.onap.policy.models.base.PfConceptKey;
33 import org.onap.policy.models.base.PfModelException;
34 import org.onap.policy.models.base.PfModelRuntimeException;
35 import org.onap.policy.models.dao.PfDao;
36 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
37 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
38 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
39 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
40 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
41 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
42 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplateFilter;
43 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
44 import org.onap.policy.models.tosca.simple.provider.SimpleToscaProvider;
45 import org.onap.policy.models.tosca.utils.ToscaServiceTemplateUtils;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
48
49 /**
50  * This class provides the provision of information on TOSCA concepts in the database to callers.
51  *
52  * @author Liam Fallon (liam.fallon@est.tech)
53  */
54 public class AuthorativeToscaProvider {
55     private static final Logger LOGGER = LoggerFactory.getLogger(AuthorativeToscaProvider.class);
56
57     // TODO: In next release this locking mechanism should be removed and replaced with proper session handling
58     private static final Object providerLockObject = "providerLockObject";
59
60     /**
61      * Get service templates.
62      *
63      * @param dao the DAO to use to access the database
64      * @param name the name of the service template to get.
65      * @param version the version of the service template to get.
66      * @return the service templates found
67      * @throws PfModelException on errors getting service templates
68      */
69     public List<ToscaServiceTemplate> getServiceTemplateList(PfDao dao, String name, String version)
70             throws PfModelException {
71
72         synchronized (providerLockObject) {
73             LOGGER.debug("->getServiceTemplateList: name={}, version={}", name, version);
74
75             List<ToscaServiceTemplate> serviceTemplateList = new ArrayList<>();
76
77             try {
78                 ToscaServiceTemplate serviceTemplate =
79                         new SimpleToscaProvider().getServiceTemplate(dao).toAuthorative();
80                 serviceTemplateList.add(serviceTemplate);
81             } catch (PfModelRuntimeException pfme) {
82                 return handlePfModelRuntimeException(pfme);
83             }
84
85             LOGGER.debug("<-getServiceTemplateList: name={}, version={}, serviceTemplateList={}", name, version,
86                     serviceTemplateList);
87             return serviceTemplateList;
88         }
89     }
90
91     /**
92      * Get filtered service templates.
93      *
94      * @param pfDao the DAO to use to access the database
95      * @param filter the filter for the service templates to get
96      * @return the service templates found
97      * @throws PfModelException on errors getting service templates
98      */
99     public List<ToscaServiceTemplate> getFilteredServiceTemplateList(PfDao pfDao,
100             @NonNull ToscaServiceTemplateFilter filter) throws PfModelException {
101
102         LOGGER.debug("->getFilteredServiceTemplateList: filter={}", filter);
103
104         List<ToscaServiceTemplate> filteredServiceTemplateList =
105                 filter.filter(getServiceTemplateList(pfDao, null, null));
106
107         LOGGER.debug("<-getFilteredServiceTemplateList: filter={}, filteredServiceTemplateList={}", filter,
108                 filteredServiceTemplateList);
109
110         return filteredServiceTemplateList;
111     }
112
113     /**
114      * Create a service template.
115      *
116      * @param dao the DAO to use to access the database
117      * @param serviceTemplate the service template to be created.
118      * @return the TOSCA service template that was created
119      * @throws PfModelException on errors creating the service template
120      */
121     public ToscaServiceTemplate createServiceTemplate(@NonNull final PfDao dao,
122             @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
123
124         synchronized (providerLockObject) {
125             LOGGER.debug("->createServiceTemplate: serviceTemplate={}", serviceTemplate);
126
127             ToscaServiceTemplate createdServiceTemplate = new SimpleToscaProvider()
128                     .appendToServiceTemplate(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
129
130             LOGGER.debug("<-createServiceTemplate: createdServiceTemplate={}", createdServiceTemplate);
131             return createdServiceTemplate;
132         }
133     }
134
135     /**
136      * Update a service template.
137      *
138      * @param dao the DAO to use to access the database
139      * @param serviceTemplate the service template to be updated.
140      * @return the TOSCA service template that was updated
141      * @throws PfModelException on errors updating the service template
142      */
143     public ToscaServiceTemplate updateServiceTemplate(@NonNull final PfDao dao,
144             @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
145
146         synchronized (providerLockObject) {
147             LOGGER.debug("->updateServiceTemplate: serviceTemplate={}", serviceTemplate);
148
149             ToscaServiceTemplate updatedServiceTemplate = new SimpleToscaProvider()
150                     .appendToServiceTemplate(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
151
152             LOGGER.debug("<-updateServiceTemplate: updatedServiceTemplate={}", updatedServiceTemplate);
153             return updatedServiceTemplate;
154         }
155     }
156
157     /**
158      * Delete a service template.
159      *
160      * @param dao the DAO to use to access the database
161      * @param name the name of the service template to delete.
162      * @param version the version of the service template to delete.
163      * @return the TOSCA service template that was deleted
164      * @throws PfModelException on errors deleting the control loop
165      */
166     public ToscaServiceTemplate deleteServiceTemplate(@NonNull final PfDao dao, @NonNull final String name,
167             @NonNull final String version) throws PfModelException {
168
169         synchronized (providerLockObject) {
170             LOGGER.debug("->deleteServiceTemplate: name={}, version={}", name, version);
171
172             ToscaServiceTemplate deletedServiceTemplate =
173                     new SimpleToscaProvider().deleteServiceTemplate(dao).toAuthorative();
174
175             LOGGER.debug("<-deleteServiceTemplate: name={}, version={}, deletedServiceTemplate={}", name, version,
176                     deletedServiceTemplate);
177             return deletedServiceTemplate;
178         }
179     }
180
181     /**
182      * Get policy types.
183      *
184      * @param dao the DAO to use to access the database
185      * @param name the name of the policy type to get.
186      * @param version the version of the policy type to get.
187      * @return the policy types found
188      * @throws PfModelException on errors getting policy types
189      */
190     public ToscaServiceTemplate getPolicyTypes(@NonNull final PfDao dao, final String name, final String version)
191             throws PfModelException {
192
193         synchronized (providerLockObject) {
194             LOGGER.debug("->getPolicyTypes: name={}, version={}", name, version);
195
196             JpaToscaServiceTemplate jpaServiceTemplate = new SimpleToscaProvider().getPolicyTypes(dao, name, version);
197
198             ToscaServiceTemplate serviceTemplate = jpaServiceTemplate.toAuthorative();
199
200             LOGGER.debug("<-getPolicyTypes: name={}, version={}, serviceTemplate={}", name, version, serviceTemplate);
201             return serviceTemplate;
202         }
203     }
204
205     /**
206      * Get policy types.
207      *
208      * @param dao the DAO to use to access the database
209      * @param name the name of the policy type to get, set to null to get all policy types
210      * @param version the version of the policy type to get, set to null to get all versions
211      * @return the policy types found
212      * @throws PfModelException on errors getting policy types
213      */
214     public List<ToscaPolicyType> getPolicyTypeList(@NonNull final PfDao dao, final String name, final String version)
215             throws PfModelException {
216
217         synchronized (providerLockObject) {
218             LOGGER.debug("->getPolicyTypeList: name={}, version={}", name, version);
219
220             List<ToscaPolicyType> policyTypeList;
221
222             try {
223                 policyTypeList = new ArrayList<>(new SimpleToscaProvider().getPolicyTypes(dao, name, version)
224                         .toAuthorative().getPolicyTypes().values());
225             } catch (PfModelRuntimeException pfme) {
226                 return handlePfModelRuntimeException(pfme);
227             }
228
229             LOGGER.debug("<-getPolicyTypeList: name={}, version={}, policyTypeList={}", name, version, policyTypeList);
230             return policyTypeList;
231         }
232     }
233
234     /**
235      * Get filtered policy types.
236      *
237      * @param dao the DAO to use to access the database
238      * @param filter the filter for the policy types to get
239      * @return the policy types found
240      * @throws PfModelException on errors getting policy types
241      */
242     public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull final PfDao dao,
243             @NonNull final ToscaPolicyTypeFilter filter) throws PfModelException {
244
245         synchronized (providerLockObject) {
246             LOGGER.debug("->getFilteredPolicyTypes: filter={}", filter);
247             SimpleToscaProvider simpleToscaProvider = new SimpleToscaProvider();
248
249             final JpaToscaServiceTemplate dbServiceTemplate = simpleToscaProvider.getPolicyTypes(dao, null, null);
250
251             List<ToscaPolicyType> filteredPolicyTypes = dbServiceTemplate.getPolicyTypes().toAuthorativeList();
252             filteredPolicyTypes = filter.filter(filteredPolicyTypes);
253
254             if (CollectionUtils.isEmpty(filteredPolicyTypes)) {
255                 throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
256                         "policy types for filter " + filter.toString() + " do not exist");
257             }
258
259             JpaToscaServiceTemplate filteredServiceTemplate = new JpaToscaServiceTemplate();
260
261             for (ToscaPolicyType policyType : filteredPolicyTypes) {
262                 JpaToscaServiceTemplate cascadedServiceTemplate = simpleToscaProvider
263                         .getCascadedPolicyTypes(dbServiceTemplate, policyType.getName(), policyType.getVersion());
264
265                 filteredServiceTemplate =
266                         ToscaServiceTemplateUtils.addFragment(filteredServiceTemplate, cascadedServiceTemplate);
267             }
268
269             ToscaServiceTemplate returnServiceTemplate = filteredServiceTemplate.toAuthorative();
270
271             LOGGER.debug("<-getFilteredPolicyTypes: filter={}, serviceTemplate={}", filter, returnServiceTemplate);
272             return returnServiceTemplate;
273         }
274     }
275
276     /**
277      * Get filtered policy types.
278      *
279      * @param dao the DAO to use to access the database
280      * @param filter the filter for the policy types to get
281      * @return the policy types found
282      * @throws PfModelException on errors getting policy types
283      */
284     public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull final PfDao dao,
285             @NonNull final ToscaPolicyTypeFilter filter) throws PfModelException {
286
287         LOGGER.debug("->getFilteredPolicyTypeList: filter={}", filter);
288
289         List<ToscaPolicyType> filteredPolicyTypeList = filter.filter(getPolicyTypeList(dao, null, null));
290
291         LOGGER.debug("<-getFilteredPolicyTypeList: filter={}, filteredPolicyTypeList={}", filter,
292                 filteredPolicyTypeList);
293
294         return filteredPolicyTypeList;
295     }
296
297     /**
298      * Create policy types.
299      *
300      * @param dao the DAO to use to access the database
301      * @param serviceTemplate the service template containing the definition of the policy types to be created
302      * @return the TOSCA service template containing the created policy types
303      * @throws PfModelException on errors creating policy types
304      */
305     public ToscaServiceTemplate createPolicyTypes(@NonNull final PfDao dao,
306             @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
307
308         synchronized (providerLockObject) {
309             LOGGER.debug("->createPolicyTypes: serviceTemplate={}", serviceTemplate);
310
311             ToscaServiceTemplate createdServiceTemplate = new SimpleToscaProvider()
312                     .createPolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
313
314             LOGGER.debug("<-createPolicyTypes: createdServiceTemplate={}", createdServiceTemplate);
315             return createdServiceTemplate;
316         }
317     }
318
319     /**
320      * Update policy types.
321      *
322      * @param dao the DAO to use to access the database
323      * @param serviceTemplate the service template containing the definition of the policy types to be modified
324      * @return the TOSCA service template containing the modified policy types
325      * @throws PfModelException on errors updating policy types
326      */
327     public ToscaServiceTemplate updatePolicyTypes(@NonNull final PfDao dao,
328             @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
329
330         synchronized (providerLockObject) {
331             LOGGER.debug("->updatePolicyTypes: serviceTemplate={}", serviceTemplate);
332
333             ToscaServiceTemplate updatedServiceTemplate = new SimpleToscaProvider()
334                     .updatePolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
335
336             LOGGER.debug("<-updatePolicyTypes: updatedServiceTemplate={}", updatedServiceTemplate);
337             return updatedServiceTemplate;
338         }
339     }
340
341     /**
342      * Delete policy type.
343      *
344      * @param dao the DAO to use to access the database
345      * @param name the name of the policy type to delete.
346      * @param version the version of the policy type to delete.
347      * @return the TOSCA service template containing the policy type that was deleted
348      * @throws PfModelException on errors deleting policy types
349      */
350     public ToscaServiceTemplate deletePolicyType(@NonNull final PfDao dao, @NonNull final String name,
351             @NonNull final String version) throws PfModelException {
352
353         synchronized (providerLockObject) {
354             LOGGER.debug("->deletePolicyType: name={}, version={}", name, version);
355
356             ToscaServiceTemplate deletedServiceTemplate =
357                     new SimpleToscaProvider().deletePolicyType(dao, new PfConceptKey(name, version)).toAuthorative();
358
359             LOGGER.debug("<-deletePolicyType: name={}, version={}, deletedServiceTemplate={}", name, version,
360                     deletedServiceTemplate);
361             return deletedServiceTemplate;
362         }
363     }
364
365     /**
366      * Get policies.
367      *
368      * @param dao the DAO to use to access the database
369      * @param name the name of the policy to get.
370      * @param version the version of the policy to get.
371      * @return the policies found
372      * @throws PfModelException on errors getting policies
373      */
374     public ToscaServiceTemplate getPolicies(@NonNull final PfDao dao, final String name, final String version)
375             throws PfModelException {
376
377         synchronized (providerLockObject) {
378             LOGGER.debug("->getPolicies: name={}, version={}", name, version);
379
380             ToscaServiceTemplate gotServiceTemplate =
381                     new SimpleToscaProvider().getPolicies(dao, name, version).toAuthorative();
382
383             LOGGER.debug("<-getPolicies: name={}, version={}, gotServiceTemplate={}", name, version,
384                     gotServiceTemplate);
385             return gotServiceTemplate;
386         }
387     }
388
389     /**
390      * Get policies.
391      *
392      * @param dao the DAO to use to access the database
393      * @param name the name of the policy to get, null to get all policies
394      * @param version the version of the policy to get, null to get all versions of a policy
395      * @return the policies found
396      * @throws PfModelException on errors getting policies
397      */
398     public List<ToscaPolicy> getPolicyList(@NonNull final PfDao dao, final String name, final String version)
399             throws PfModelException {
400
401         synchronized (providerLockObject) {
402             LOGGER.debug("->getPolicyList: name={}, version={}", name, version);
403
404             List<ToscaPolicy> policyList;
405
406             try {
407                 policyList = asConceptList(new SimpleToscaProvider().getPolicies(dao, name, version).toAuthorative()
408                         .getToscaTopologyTemplate().getPolicies());
409             } catch (PfModelRuntimeException pfme) {
410                 return handlePfModelRuntimeException(pfme);
411             }
412
413             LOGGER.debug("<-getPolicyList: name={}, version={}, policyList={}", name, version, policyList);
414             return policyList;
415         }
416     }
417
418     /**
419      * Get filtered policies.
420      *
421      * @param dao the DAO to use to access the database
422      * @param filter the filter for the policies to get
423      * @return the policies found
424      * @throws PfModelException on errors getting policies
425      */
426     public ToscaServiceTemplate getFilteredPolicies(@NonNull final PfDao dao, @NonNull final ToscaPolicyFilter filter)
427             throws PfModelException {
428
429         synchronized (providerLockObject) {
430             LOGGER.debug("->getFilteredPolicies: filter={}", filter);
431             String version = ToscaPolicyFilter.LATEST_VERSION.equals(filter.getVersion()) ? null : filter.getVersion();
432
433             SimpleToscaProvider simpleToscaProvider = new SimpleToscaProvider();
434             final JpaToscaServiceTemplate dbServiceTemplate =
435                     simpleToscaProvider.getPolicies(dao, filter.getName(), version);
436
437             List<ToscaPolicy> filteredPolicies =
438                     dbServiceTemplate.getTopologyTemplate().getPolicies().toAuthorativeList();
439             filteredPolicies = filter.filter(filteredPolicies);
440
441             if (CollectionUtils.isEmpty(filteredPolicies)) {
442                 throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
443                         "policies for filter " + filter.toString() + " do not exist");
444             }
445
446             JpaToscaServiceTemplate filteredServiceTemplate = new JpaToscaServiceTemplate();
447
448             for (ToscaPolicy policy : filteredPolicies) {
449                 JpaToscaServiceTemplate cascadedServiceTemplate = simpleToscaProvider
450                         .getCascadedPolicies(dbServiceTemplate, policy.getName(), policy.getVersion());
451
452                 filteredServiceTemplate =
453                         ToscaServiceTemplateUtils.addFragment(filteredServiceTemplate, cascadedServiceTemplate);
454             }
455
456             ToscaServiceTemplate returnServiceTemplate = filteredServiceTemplate.toAuthorative();
457
458             LOGGER.debug("<-getFilteredPolicies: filter={}, serviceTemplate={}", filter, returnServiceTemplate);
459             return returnServiceTemplate;
460         }
461     }
462
463     /**
464      * Get filtered policies.
465      *
466      * @param dao the DAO to use to access the database
467      * @param filter the filter for the policies to get
468      * @return the policies found
469      * @throws PfModelException on errors getting policies
470      */
471     public List<ToscaPolicy> getFilteredPolicyList(@NonNull final PfDao dao, @NonNull final ToscaPolicyFilter filter)
472             throws PfModelException {
473
474         LOGGER.debug("->getFilteredPolicyList: filter={}", filter);
475         String version = ToscaPolicyFilter.LATEST_VERSION.equals(filter.getVersion()) ? null : filter.getVersion();
476
477         List<ToscaPolicy> policyList = filter.filter(getPolicyList(dao, filter.getName(), version));
478
479         LOGGER.debug("<-getFilteredPolicyList: filter={}, policyList={}", filter, policyList);
480         return policyList;
481     }
482
483     /**
484      * Create policies.
485      *
486      * @param dao the DAO to use to access the database
487      * @param serviceTemplate the service template containing the definitions of the new policies to be created.
488      * @return the TOSCA service template containing the policy types that were created
489      * @throws PfModelException on errors creating policies
490      */
491     public ToscaServiceTemplate createPolicies(@NonNull final PfDao dao,
492             @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
493
494         synchronized (providerLockObject) {
495             LOGGER.debug("->createPolicies: serviceTemplate={}", serviceTemplate);
496
497             ToscaServiceTemplate createdServiceTemplate = new SimpleToscaProvider()
498                     .createPolicies(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
499
500             LOGGER.debug("<-createPolicies: createdServiceTemplate={}", createdServiceTemplate);
501             return createdServiceTemplate;
502         }
503     }
504
505     /**
506      * Update policies.
507      *
508      * @param dao the DAO to use to access the database
509      * @param serviceTemplate the service template containing the definitions of the policies to be updated.
510      * @return the TOSCA service template containing the policies that were updated
511      * @throws PfModelException on errors updating policies
512      */
513     public ToscaServiceTemplate updatePolicies(@NonNull final PfDao dao,
514             @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
515
516         synchronized (providerLockObject) {
517             LOGGER.debug("->updatePolicies: serviceTemplate={}", serviceTemplate);
518
519             ToscaServiceTemplate updatedServiceTemplate = new SimpleToscaProvider()
520                     .updatePolicies(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
521
522             LOGGER.debug("<-updatePolicies: updatedServiceTemplate={}", updatedServiceTemplate);
523             return updatedServiceTemplate;
524         }
525     }
526
527     /**
528      * Delete policy.
529      *
530      * @param dao the DAO to use to access the database
531      * @param name the name of the policy to delete.
532      * @param version the version of the policy to delete.
533      * @return the TOSCA service template containing the policy that was deleted
534      * @throws PfModelException on errors deleting policies
535      */
536     public ToscaServiceTemplate deletePolicy(@NonNull final PfDao dao, @NonNull final String name,
537             @NonNull final String version) throws PfModelException {
538
539         synchronized (providerLockObject) {
540             LOGGER.debug("->deletePolicy: name={}, version={}", name, version);
541
542             ToscaServiceTemplate deletedServiceTemplate =
543                     new SimpleToscaProvider().deletePolicy(dao, new PfConceptKey(name, version)).toAuthorative();
544
545             LOGGER.debug("<-deletePolicy: name={}, version={}, deletedServiceTemplate={}", name, version,
546                     deletedServiceTemplate);
547             return deletedServiceTemplate;
548         }
549     }
550
551     /**
552      * Return the contents of a list of maps as a plain list.
553      *
554      * @param listOfMaps the list of maps
555      * @return the plain list
556      */
557     private <T> List<T> asConceptList(final List<Map<String, T>> listOfMaps) {
558         List<T> returnList = new ArrayList<>();
559         for (Map<String, T> conceptMap : listOfMaps) {
560             for (T concept : conceptMap.values()) {
561                 returnList.add(concept);
562             }
563         }
564
565         return returnList;
566     }
567
568     /**
569      * Handle a PfModelRuntimeException on a list call.
570      *
571      * @param pfme the model exception
572      * @return an empty list on 404
573      */
574     private <T extends ToscaEntity> List<T> handlePfModelRuntimeException(final PfModelRuntimeException pfme) {
575         if (Status.NOT_FOUND.equals(pfme.getErrorResponse().getResponseCode())) {
576             LOGGER.trace("request did not find any results", pfme);
577             return Collections.emptyList();
578         } else {
579             throw pfme;
580         }
581     }
582 }