2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2020 Nordix Foundation.
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.models.tosca.utils;
23 import java.util.Collection;
25 import java.util.function.Function;
27 import javax.ws.rs.core.Response;
29 import lombok.NonNull;
31 import org.apache.commons.collections4.CollectionUtils;
32 import org.onap.policy.models.base.PfConcept;
33 import org.onap.policy.models.base.PfConceptContainer;
34 import org.onap.policy.models.base.PfConceptKey;
35 import org.onap.policy.models.base.PfKey;
36 import org.onap.policy.models.base.PfModelRuntimeException;
37 import org.onap.policy.models.base.PfNameVersion;
38 import org.onap.policy.models.base.PfValidationMessage;
39 import org.onap.policy.models.base.PfValidationResult;
40 import org.onap.policy.models.base.PfValidationResult.ValidationResult;
41 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
42 import org.onap.policy.models.tosca.simple.concepts.JpaToscaEntityType;
43 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
46 * Utility class for TOSCA concepts.
48 * @author Liam Fallon (liam.fallon@est.tech)
50 public final class ToscaUtils {
51 private static final String ROOT_KEY_NAME_SUFFIX = ".Root";
54 private static final Set<PfConceptKey> PREDEFINED_TOSCA_DATA_TYPES = Set.of(
55 new PfConceptKey("string", PfKey.NULL_KEY_VERSION),
56 new PfConceptKey("integer", PfKey.NULL_KEY_VERSION),
57 new PfConceptKey("float", PfKey.NULL_KEY_VERSION),
58 new PfConceptKey("boolean", PfKey.NULL_KEY_VERSION),
59 new PfConceptKey("timestamp", PfKey.NULL_KEY_VERSION),
60 new PfConceptKey("null", PfKey.NULL_KEY_VERSION),
61 new PfConceptKey("list", PfKey.NULL_KEY_VERSION),
62 new PfConceptKey("map", PfKey.NULL_KEY_VERSION),
63 new PfConceptKey("scalar-unit.size", PfKey.NULL_KEY_VERSION),
64 new PfConceptKey("scalar-unit.time", PfKey.NULL_KEY_VERSION),
65 new PfConceptKey("scalar-unit.frequency", PfKey.NULL_KEY_VERSION),
66 new PfConceptKey("tosca.datatypes.TimeInterval", PfKey.NULL_KEY_VERSION)
71 * Private constructor to prevent subclassing.
73 private ToscaUtils() {
74 // Private constructor to prevent subclassing
78 * Get the predefined policy types.
80 * @return the predefined policy types
82 public static Collection<PfConceptKey> getPredefinedDataTypes() {
83 return PREDEFINED_TOSCA_DATA_TYPES;
87 * Assert that data types have been specified correctly.
89 * @param serviceTemplate the service template containing data types to be checked
91 public static void assertDataTypesExist(final JpaToscaServiceTemplate serviceTemplate) {
92 assertExist(serviceTemplate, ToscaUtils::checkDataTypesExist);
96 * Assert that policy types have been specified correctly.
98 * @param serviceTemplate the service template containing policy types to be checked
100 public static void assertPolicyTypesExist(final JpaToscaServiceTemplate serviceTemplate) {
101 assertExist(serviceTemplate, ToscaUtils::checkPolicyTypesExist);
105 * Assert that policies have been specified correctly.
107 * @param serviceTemplate the service template containing policy types to be checked
109 public static void assertPoliciesExist(final JpaToscaServiceTemplate serviceTemplate) {
110 assertExist(serviceTemplate, ToscaUtils::checkPoliciesExist);
114 * Check that data types have been specified correctly.
116 * @param serviceTemplate the service template containing data types to be checked
118 public static boolean doDataTypesExist(final JpaToscaServiceTemplate serviceTemplate) {
119 return doExist(serviceTemplate, ToscaUtils::checkDataTypesExist);
123 * Check that policy types have been specified correctly.
125 * @param serviceTemplate the service template containing policy types to be checked
127 public static boolean doPolicyTypesExist(final JpaToscaServiceTemplate serviceTemplate) {
128 return doExist(serviceTemplate, ToscaUtils::checkPolicyTypesExist);
132 * Check that policies have been specified correctly.
134 * @param serviceTemplate the service template containing policy types to be checked
136 public static boolean doPoliciesExist(final JpaToscaServiceTemplate serviceTemplate) {
138 return doExist(serviceTemplate, ToscaUtils::checkPoliciesExist);
142 * Assert that something have been specified correctly.
144 * @param serviceTemplate the service template containing policy types to be checked
146 public static void assertExist(final JpaToscaServiceTemplate serviceTemplate,
147 final Function<JpaToscaServiceTemplate, String> checkerFunction) {
148 String message = checkerFunction.apply(serviceTemplate);
149 if (message != null) {
150 throw new PfModelRuntimeException(Response.Status.NOT_FOUND, message);
155 * Check that something have been specified correctly.
157 * @param serviceTemplate the service template containing policy types to be checked
159 public static boolean doExist(final JpaToscaServiceTemplate serviceTemplate,
160 final Function<JpaToscaServiceTemplate, String> checkerFunction) {
161 return checkerFunction.apply(serviceTemplate) == null;
165 * Check if data types have been specified correctly.
167 public static String checkDataTypesExist(final JpaToscaServiceTemplate serviceTemplate) {
168 if (serviceTemplate.getDataTypes() == null) {
169 return "no data types specified on service template";
172 if (serviceTemplate.getDataTypes().getConceptMap().isEmpty()) {
173 return "list of data types specified on service template is empty";
180 * Check if policy types have been specified correctly.
182 public static String checkPolicyTypesExist(final JpaToscaServiceTemplate serviceTemplate) {
183 if (serviceTemplate.getPolicyTypes() == null) {
184 return "no policy types specified on service template";
187 if (serviceTemplate.getPolicyTypes().getConceptMap().isEmpty()) {
188 return "list of policy types specified on service template is empty";
195 * Check if policies have been specified correctly.
197 public static String checkPoliciesExist(final JpaToscaServiceTemplate serviceTemplate) {
198 if (serviceTemplate.getTopologyTemplate() == null) {
199 return "topology template not specified on service template";
202 if (serviceTemplate.getTopologyTemplate().getPolicies() == null) {
203 return "no policies specified on topology template of service template";
206 if (serviceTemplate.getTopologyTemplate().getPolicies().getConceptMap().isEmpty()) {
207 return "list of policies specified on topology template of service template is empty";
214 * getLatestPolicyTypeVersion Find all the ancestors of an entity type.
216 * @param entityTypes the set of entity types that exist
217 * @param entityType the entity type for which to get the parents
218 * @param result the result of the ancestor search with any warnings or errors
219 * @return the entity set containing the ancestors of the incoming entity
221 public static Collection<JpaToscaEntityType<ToscaEntity>> getEntityTypeAncestors(
222 @NonNull PfConceptContainer<? extends PfConcept, ? extends PfNameVersion> entityTypes,
223 @NonNull JpaToscaEntityType<?> entityType, @NonNull final PfValidationResult result) {
225 PfConceptKey parentEntityTypeKey = entityType.getDerivedFrom();
226 if (parentEntityTypeKey == null || parentEntityTypeKey.getName().endsWith(ROOT_KEY_NAME_SUFFIX)) {
227 return CollectionUtils.emptyCollection();
230 if (entityType.getKey().equals(parentEntityTypeKey)) {
231 result.addValidationMessage(new PfValidationMessage(entityType.getKey(), ToscaUtils.class,
232 ValidationResult.INVALID, "entity cannot be an ancestor of itself"));
233 throw new PfModelRuntimeException(Response.Status.CONFLICT, result.toString());
236 @SuppressWarnings("unchecked")
237 Set<JpaToscaEntityType<ToscaEntity>> ancestorEntitySet = (Set<JpaToscaEntityType<ToscaEntity>>) entityTypes
238 .getAll(parentEntityTypeKey.getName(), parentEntityTypeKey.getVersion());
240 if (ancestorEntitySet.isEmpty()) {
241 result.addValidationMessage(new PfValidationMessage(entityType.getKey(), ToscaUtils.class,
242 ValidationResult.INVALID, "parent " + parentEntityTypeKey.getId() + " of entity not found"));
244 for (JpaToscaEntityType<?> filteredEntityType : ancestorEntitySet) {
245 ancestorEntitySet.addAll(getEntityTypeAncestors(entityTypes, filteredEntityType, result));
248 return ancestorEntitySet;
252 * Get the entity tree from a concept container for a given entity key.
254 * @param entityTypes the concept container containing entity types
255 * @param entityName the name of the entity
256 * @param entityVersion the version of the entity
258 public static void getEntityTree(
259 @NonNull final PfConceptContainer<? extends PfConcept, ? extends PfNameVersion> entityTypes,
260 final String entityName, final String entityVersion) {
262 PfValidationResult result = new PfValidationResult();
264 @SuppressWarnings("unchecked")
265 Set<JpaToscaEntityType<?>> filteredEntitySet =
266 (Set<JpaToscaEntityType<?>>) entityTypes.getAll(entityName, entityVersion);
267 for (JpaToscaEntityType<?> filteredEntityType : filteredEntitySet) {
268 filteredEntitySet.addAll(ToscaUtils.getEntityTypeAncestors(entityTypes, filteredEntityType, result));
271 if (!result.isValid()) {
272 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, result.toString());
275 entityTypes.getConceptMap().entrySet()
276 .removeIf(entityEntry -> !filteredEntitySet.contains(entityEntry.getValue()));