2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022 Bell Canada. All rights reserved.
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.pap.main.service;
23 import java.util.ArrayList;
24 import java.util.Collections;
25 import java.util.List;
27 import java.util.Optional;
28 import java.util.stream.Collectors;
29 import javax.ws.rs.core.Response;
30 import lombok.RequiredArgsConstructor;
31 import org.onap.policy.models.base.PfConceptKey;
32 import org.onap.policy.models.base.PfModelException;
33 import org.onap.policy.models.base.PfModelRuntimeException;
34 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
35 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
36 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
37 import org.onap.policy.models.tosca.authorative.concepts.ToscaTypedEntityFilter;
38 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
39 import org.onap.policy.models.tosca.simple.provider.SimpleToscaProvider;
40 import org.onap.policy.models.tosca.utils.ToscaUtils;
41 import org.onap.policy.pap.main.repository.ToscaServiceTemplateRepository;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
44 import org.springframework.stereotype.Service;
45 import org.springframework.transaction.annotation.Transactional;
48 @Transactional(readOnly = true)
49 @RequiredArgsConstructor
50 public class ToscaServiceTemplateService {
52 private static final Logger LOGGER = LoggerFactory.getLogger(ToscaServiceTemplateService.class);
54 private final ToscaServiceTemplateRepository serviceTemplateRepository;
59 * @param name the name of the policy to get, null to get all policies
60 * @param version the version of the policy to get, null to get all versions of a policy
61 * @return the policies found
62 * @throws PfModelException on errors getting policies
64 public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
66 LOGGER.debug("->getPolicyList: name={}, version={}", name, version);
68 List<ToscaPolicy> policyList;
71 List<Map<String, ToscaPolicy>> policies = getToscaServiceTemplate(name, version, "policy").toAuthorative()
72 .getToscaTopologyTemplate().getPolicies();
73 policyList = policies.stream().flatMap(policy -> policy.values().stream()).collect(Collectors.toList());
74 } catch (PfModelRuntimeException pfme) {
75 return handlePfModelRuntimeException(pfme);
76 } catch (Exception exc) {
77 String errorMsg = "Failed to fetch policy with name " + name + " and version " + version + ".";
78 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMsg, exc);
81 LOGGER.debug("<-getPolicyList: name={}, version={}, policyList={}", name, version, policyList);
86 * Get filtered policies.
88 * @param filter the filter for the policies to get
89 * @return the policies found
90 * @throws PfModelException on errors getting policies
92 public List<ToscaPolicy> getFilteredPolicyList(ToscaTypedEntityFilter<ToscaPolicy> filter) throws PfModelException {
93 String version = ToscaTypedEntityFilter.LATEST_VERSION.equals(filter.getVersion()) ? null : filter.getVersion();
94 return filter.filter(getPolicyList(filter.getName(), version));
100 * @param name the name of the policy type to get, set to null to get all policy types
101 * @param version the version of the policy type to get, set to null to get all versions
102 * @return the policy types found
103 * @throws PfModelException on errors getting policy types
105 public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
107 LOGGER.debug("->getPolicyTypeList: name={}, version={}", name, version);
109 List<ToscaPolicyType> policyTypeList;
112 policyTypeList = new ArrayList<>(
113 getToscaServiceTemplate(name, version, "policyType").toAuthorative().getPolicyTypes().values());
114 } catch (PfModelRuntimeException pfme) {
115 return handlePfModelRuntimeException(pfme);
116 } catch (Exception exc) {
117 String errorMsg = "Failed to fetch policy type with name " + name + " and version " + version + ".";
118 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMsg, exc);
121 LOGGER.debug("<-getPolicyTypeList: name={}, version={}, policyTypeList={}", name, version, policyTypeList);
122 return policyTypeList;
125 private JpaToscaServiceTemplate getToscaServiceTemplate(final String name, final String version, final String type)
126 throws PfModelException {
128 Optional<JpaToscaServiceTemplate> serviceTemplate = serviceTemplateRepository
129 .findById(new PfConceptKey(JpaToscaServiceTemplate.DEFAULT_NAME, JpaToscaServiceTemplate.DEFAULT_VERSION));
130 if (serviceTemplate.isEmpty()) {
131 throw new PfModelRuntimeException(Response.Status.NOT_FOUND, "service template not found in database");
134 LOGGER.debug("<-getServiceTemplate: serviceTemplate={}", serviceTemplate.get());
135 JpaToscaServiceTemplate dbServiceTemplate = serviceTemplate.get();
137 JpaToscaServiceTemplate returnServiceTemplate;
138 if (type.equals("policy")) {
139 returnServiceTemplate = getToscaPolicies(name, version, dbServiceTemplate);
141 returnServiceTemplate = getToscaPolicyTypes(name, version, dbServiceTemplate);
143 return returnServiceTemplate;
146 private JpaToscaServiceTemplate getToscaPolicies(final String name, final String version,
147 JpaToscaServiceTemplate dbServiceTemplate) throws PfModelException {
148 if (!ToscaUtils.doPoliciesExist(dbServiceTemplate)) {
149 throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
150 "policies for " + name + ":" + version + " do not exist");
153 JpaToscaServiceTemplate returnServiceTemplate =
154 new SimpleToscaProvider().getCascadedPolicies(dbServiceTemplate, name, version);
156 LOGGER.debug("<-getPolicies: name={}, version={}, serviceTemplate={}", name, version, returnServiceTemplate);
157 return returnServiceTemplate;
160 private JpaToscaServiceTemplate getToscaPolicyTypes(final String name, final String version,
161 JpaToscaServiceTemplate dbServiceTemplate) throws PfModelException {
162 if (!ToscaUtils.doPolicyTypesExist(dbServiceTemplate)) {
163 throw new PfModelRuntimeException(Response.Status.NOT_FOUND,
164 "policy types for " + name + ":" + version + " do not exist");
167 JpaToscaServiceTemplate returnServiceTemplate =
168 new SimpleToscaProvider().getCascadedPolicyTypes(dbServiceTemplate, name, version);
170 LOGGER.debug("<-getPolicyTypes: name={}, version={}, serviceTemplate={}", name, version, returnServiceTemplate);
171 return returnServiceTemplate;
175 * Handle a PfModelRuntimeException on a list call.
177 * @param pfme the model exception
178 * @return an empty list on 404
180 private <T extends ToscaEntity> List<T> handlePfModelRuntimeException(final PfModelRuntimeException pfme) {
181 if (Response.Status.NOT_FOUND.equals(pfme.getErrorResponse().getResponseCode())) {
182 LOGGER.trace("request did not find any results", pfme);
183 return Collections.emptyList();