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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.models.tosca.authorative.provider;
24 import java.util.ArrayList;
25 import java.util.Collections;
26 import java.util.List;
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;
50 * This class provides the provision of information on TOSCA concepts in the database to callers.
52 * @author Liam Fallon (liam.fallon@est.tech)
54 public class AuthorativeToscaProvider {
55 private static final Logger LOGGER = LoggerFactory.getLogger(AuthorativeToscaProvider.class);
57 // TODO: In next release this locking mechanism should be removed and replaced with proper session handling
58 private static final Object providerLockObject = "providerLockObject";
61 * Get service templates.
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
69 public List<ToscaServiceTemplate> getServiceTemplateList(PfDao dao, String name, String version)
70 throws PfModelException {
72 synchronized (providerLockObject) {
73 LOGGER.debug("->getServiceTemplateList: name={}, version={}", name, version);
75 List<ToscaServiceTemplate> serviceTemplateList = new ArrayList<>();
78 ToscaServiceTemplate serviceTemplate =
79 new SimpleToscaProvider().getServiceTemplate(dao).toAuthorative();
80 serviceTemplateList.add(serviceTemplate);
81 } catch (PfModelRuntimeException pfme) {
82 return handlePfModelRuntimeException(pfme);
85 LOGGER.debug("<-getServiceTemplateList: name={}, version={}, serviceTemplateList={}", name, version,
87 return serviceTemplateList;
92 * Get filtered service templates.
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
99 public List<ToscaServiceTemplate> getFilteredServiceTemplateList(PfDao pfDao,
100 @NonNull ToscaServiceTemplateFilter filter) throws PfModelException {
102 LOGGER.debug("->getFilteredServiceTemplateList: filter={}", filter);
104 List<ToscaServiceTemplate> filteredServiceTemplateList =
105 filter.filter(getServiceTemplateList(pfDao, null, null));
107 LOGGER.debug("<-getFilteredServiceTemplateList: filter={}, filteredServiceTemplateList={}", filter,
108 filteredServiceTemplateList);
110 return filteredServiceTemplateList;
114 * Create a service template.
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
121 public ToscaServiceTemplate createServiceTemplate(@NonNull final PfDao dao,
122 @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
124 synchronized (providerLockObject) {
125 LOGGER.debug("->createServiceTemplate: serviceTemplate={}", serviceTemplate);
127 ToscaServiceTemplate createdServiceTemplate = new SimpleToscaProvider()
128 .appendToServiceTemplate(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
130 LOGGER.debug("<-createServiceTemplate: createdServiceTemplate={}", createdServiceTemplate);
131 return createdServiceTemplate;
136 * Update a service template.
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
143 public ToscaServiceTemplate updateServiceTemplate(@NonNull final PfDao dao,
144 @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
146 synchronized (providerLockObject) {
147 LOGGER.debug("->updateServiceTemplate: serviceTemplate={}", serviceTemplate);
149 ToscaServiceTemplate updatedServiceTemplate = new SimpleToscaProvider()
150 .appendToServiceTemplate(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
152 LOGGER.debug("<-updateServiceTemplate: updatedServiceTemplate={}", updatedServiceTemplate);
153 return updatedServiceTemplate;
158 * Delete a service template.
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
166 public ToscaServiceTemplate deleteServiceTemplate(@NonNull final PfDao dao, @NonNull final String name,
167 @NonNull final String version) throws PfModelException {
169 synchronized (providerLockObject) {
170 LOGGER.debug("->deleteServiceTemplate: name={}, version={}", name, version);
172 ToscaServiceTemplate deletedServiceTemplate =
173 new SimpleToscaProvider().deleteServiceTemplate(dao).toAuthorative();
175 LOGGER.debug("<-deleteServiceTemplate: name={}, version={}, deletedServiceTemplate={}", name, version,
176 deletedServiceTemplate);
177 return deletedServiceTemplate;
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
190 public ToscaServiceTemplate getPolicyTypes(@NonNull final PfDao dao, final String name, final String version)
191 throws PfModelException {
193 synchronized (providerLockObject) {
194 LOGGER.debug("->getPolicyTypes: name={}, version={}", name, version);
196 JpaToscaServiceTemplate jpaServiceTemplate = new SimpleToscaProvider().getPolicyTypes(dao, name, version);
198 ToscaServiceTemplate serviceTemplate = jpaServiceTemplate.toAuthorative();
200 LOGGER.debug("<-getPolicyTypes: name={}, version={}, serviceTemplate={}", name, version, serviceTemplate);
201 return serviceTemplate;
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
214 public List<ToscaPolicyType> getPolicyTypeList(@NonNull final PfDao dao, final String name, final String version)
215 throws PfModelException {
217 synchronized (providerLockObject) {
218 LOGGER.debug("->getPolicyTypeList: name={}, version={}", name, version);
220 List<ToscaPolicyType> policyTypeList;
223 policyTypeList = new ArrayList<>(new SimpleToscaProvider().getPolicyTypes(dao, name, version)
224 .toAuthorative().getPolicyTypes().values());
225 } catch (PfModelRuntimeException pfme) {
226 return handlePfModelRuntimeException(pfme);
229 LOGGER.debug("<-getPolicyTypeList: name={}, version={}, policyTypeList={}", name, version, policyTypeList);
230 return policyTypeList;
235 * Get filtered policy types.
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
242 public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull final PfDao dao,
243 @NonNull final ToscaPolicyTypeFilter filter) throws PfModelException {
245 synchronized (providerLockObject) {
246 LOGGER.debug("->getFilteredPolicyTypes: filter={}", filter);
247 SimpleToscaProvider simpleToscaProvider = new SimpleToscaProvider();
249 final JpaToscaServiceTemplate dbServiceTemplate = simpleToscaProvider.getPolicyTypes(dao, null, null);
251 List<ToscaPolicyType> filteredPolicyTypes = dbServiceTemplate.getPolicyTypes().toAuthorativeList();
252 filteredPolicyTypes = filter.filter(filteredPolicyTypes);
254 if (CollectionUtils.isEmpty(filteredPolicyTypes)) {
255 throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
256 "policy types for filter " + filter.toString() + " do not exist");
259 JpaToscaServiceTemplate filteredServiceTemplate = new JpaToscaServiceTemplate();
261 for (ToscaPolicyType policyType : filteredPolicyTypes) {
262 JpaToscaServiceTemplate cascadedServiceTemplate = simpleToscaProvider
263 .getCascadedPolicyTypes(dbServiceTemplate, policyType.getName(), policyType.getVersion());
265 filteredServiceTemplate =
266 ToscaServiceTemplateUtils.addFragment(filteredServiceTemplate, cascadedServiceTemplate);
269 ToscaServiceTemplate returnServiceTemplate = filteredServiceTemplate.toAuthorative();
271 LOGGER.debug("<-getFilteredPolicyTypes: filter={}, serviceTemplate={}", filter, returnServiceTemplate);
272 return returnServiceTemplate;
277 * Get filtered policy types.
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
284 public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull final PfDao dao,
285 @NonNull final ToscaPolicyTypeFilter filter) throws PfModelException {
287 LOGGER.debug("->getFilteredPolicyTypeList: filter={}", filter);
289 List<ToscaPolicyType> filteredPolicyTypeList = filter.filter(getPolicyTypeList(dao, null, null));
291 LOGGER.debug("<-getFilteredPolicyTypeList: filter={}, filteredPolicyTypeList={}", filter,
292 filteredPolicyTypeList);
294 return filteredPolicyTypeList;
298 * Create policy types.
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
305 public ToscaServiceTemplate createPolicyTypes(@NonNull final PfDao dao,
306 @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
308 synchronized (providerLockObject) {
309 LOGGER.debug("->createPolicyTypes: serviceTemplate={}", serviceTemplate);
311 ToscaServiceTemplate createdServiceTemplate = new SimpleToscaProvider()
312 .createPolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
314 LOGGER.debug("<-createPolicyTypes: createdServiceTemplate={}", createdServiceTemplate);
315 return createdServiceTemplate;
320 * Update policy types.
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
327 public ToscaServiceTemplate updatePolicyTypes(@NonNull final PfDao dao,
328 @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
330 synchronized (providerLockObject) {
331 LOGGER.debug("->updatePolicyTypes: serviceTemplate={}", serviceTemplate);
333 ToscaServiceTemplate updatedServiceTemplate = new SimpleToscaProvider()
334 .updatePolicyTypes(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
336 LOGGER.debug("<-updatePolicyTypes: updatedServiceTemplate={}", updatedServiceTemplate);
337 return updatedServiceTemplate;
342 * Delete policy type.
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
350 public ToscaServiceTemplate deletePolicyType(@NonNull final PfDao dao, @NonNull final String name,
351 @NonNull final String version) throws PfModelException {
353 synchronized (providerLockObject) {
354 LOGGER.debug("->deletePolicyType: name={}, version={}", name, version);
356 ToscaServiceTemplate deletedServiceTemplate =
357 new SimpleToscaProvider().deletePolicyType(dao, new PfConceptKey(name, version)).toAuthorative();
359 LOGGER.debug("<-deletePolicyType: name={}, version={}, deletedServiceTemplate={}", name, version,
360 deletedServiceTemplate);
361 return deletedServiceTemplate;
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
374 public ToscaServiceTemplate getPolicies(@NonNull final PfDao dao, final String name, final String version)
375 throws PfModelException {
377 synchronized (providerLockObject) {
378 LOGGER.debug("->getPolicies: name={}, version={}", name, version);
380 ToscaServiceTemplate gotServiceTemplate =
381 new SimpleToscaProvider().getPolicies(dao, name, version).toAuthorative();
383 LOGGER.debug("<-getPolicies: name={}, version={}, gotServiceTemplate={}", name, version,
385 return gotServiceTemplate;
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
398 public List<ToscaPolicy> getPolicyList(@NonNull final PfDao dao, final String name, final String version)
399 throws PfModelException {
401 synchronized (providerLockObject) {
402 LOGGER.debug("->getPolicyList: name={}, version={}", name, version);
404 List<ToscaPolicy> policyList;
407 policyList = asConceptList(new SimpleToscaProvider().getPolicies(dao, name, version).toAuthorative()
408 .getToscaTopologyTemplate().getPolicies());
409 } catch (PfModelRuntimeException pfme) {
410 return handlePfModelRuntimeException(pfme);
413 LOGGER.debug("<-getPolicyList: name={}, version={}, policyList={}", name, version, policyList);
419 * Get filtered policies.
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
426 public ToscaServiceTemplate getFilteredPolicies(@NonNull final PfDao dao, @NonNull final ToscaPolicyFilter filter)
427 throws PfModelException {
429 synchronized (providerLockObject) {
430 LOGGER.debug("->getFilteredPolicies: filter={}", filter);
431 String version = ToscaPolicyFilter.LATEST_VERSION.equals(filter.getVersion()) ? null : filter.getVersion();
433 SimpleToscaProvider simpleToscaProvider = new SimpleToscaProvider();
434 final JpaToscaServiceTemplate dbServiceTemplate =
435 simpleToscaProvider.getPolicies(dao, filter.getName(), version);
437 List<ToscaPolicy> filteredPolicies =
438 dbServiceTemplate.getTopologyTemplate().getPolicies().toAuthorativeList();
439 filteredPolicies = filter.filter(filteredPolicies);
441 if (CollectionUtils.isEmpty(filteredPolicies)) {
442 throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
443 "policies for filter " + filter.toString() + " do not exist");
446 JpaToscaServiceTemplate filteredServiceTemplate = new JpaToscaServiceTemplate();
448 for (ToscaPolicy policy : filteredPolicies) {
449 JpaToscaServiceTemplate cascadedServiceTemplate = simpleToscaProvider
450 .getCascadedPolicies(dbServiceTemplate, policy.getName(), policy.getVersion());
452 filteredServiceTemplate =
453 ToscaServiceTemplateUtils.addFragment(filteredServiceTemplate, cascadedServiceTemplate);
456 ToscaServiceTemplate returnServiceTemplate = filteredServiceTemplate.toAuthorative();
458 LOGGER.debug("<-getFilteredPolicies: filter={}, serviceTemplate={}", filter, returnServiceTemplate);
459 return returnServiceTemplate;
464 * Get filtered policies.
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
471 public List<ToscaPolicy> getFilteredPolicyList(@NonNull final PfDao dao, @NonNull final ToscaPolicyFilter filter)
472 throws PfModelException {
474 LOGGER.debug("->getFilteredPolicyList: filter={}", filter);
475 String version = ToscaPolicyFilter.LATEST_VERSION.equals(filter.getVersion()) ? null : filter.getVersion();
477 List<ToscaPolicy> policyList = filter.filter(getPolicyList(dao, filter.getName(), version));
479 LOGGER.debug("<-getFilteredPolicyList: filter={}, policyList={}", filter, policyList);
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
491 public ToscaServiceTemplate createPolicies(@NonNull final PfDao dao,
492 @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
494 synchronized (providerLockObject) {
495 LOGGER.debug("->createPolicies: serviceTemplate={}", serviceTemplate);
497 ToscaServiceTemplate createdServiceTemplate = new SimpleToscaProvider()
498 .createPolicies(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
500 LOGGER.debug("<-createPolicies: createdServiceTemplate={}", createdServiceTemplate);
501 return createdServiceTemplate;
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
513 public ToscaServiceTemplate updatePolicies(@NonNull final PfDao dao,
514 @NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException {
516 synchronized (providerLockObject) {
517 LOGGER.debug("->updatePolicies: serviceTemplate={}", serviceTemplate);
519 ToscaServiceTemplate updatedServiceTemplate = new SimpleToscaProvider()
520 .updatePolicies(dao, new JpaToscaServiceTemplate(serviceTemplate)).toAuthorative();
522 LOGGER.debug("<-updatePolicies: updatedServiceTemplate={}", updatedServiceTemplate);
523 return updatedServiceTemplate;
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
536 public ToscaServiceTemplate deletePolicy(@NonNull final PfDao dao, @NonNull final String name,
537 @NonNull final String version) throws PfModelException {
539 synchronized (providerLockObject) {
540 LOGGER.debug("->deletePolicy: name={}, version={}", name, version);
542 ToscaServiceTemplate deletedServiceTemplate =
543 new SimpleToscaProvider().deletePolicy(dao, new PfConceptKey(name, version)).toAuthorative();
545 LOGGER.debug("<-deletePolicy: name={}, version={}, deletedServiceTemplate={}", name, version,
546 deletedServiceTemplate);
547 return deletedServiceTemplate;
552 * Return the contents of a list of maps as a plain list.
554 * @param listOfMaps the list of maps
555 * @return the plain list
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);
569 * Handle a PfModelRuntimeException on a list call.
571 * @param pfme the model exception
572 * @return an empty list on 404
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();