2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020, 2022-2023 Nordix Foundation.
4 * Modifications Copyright (C) 2020-2021 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.utils;
24 import jakarta.ws.rs.core.Response;
25 import java.util.Map.Entry;
26 import lombok.AccessLevel;
27 import lombok.NoArgsConstructor;
28 import lombok.NonNull;
29 import org.onap.policy.common.parameters.BeanValidationResult;
30 import org.onap.policy.models.base.PfConceptContainer;
31 import org.onap.policy.models.base.PfConceptKey;
32 import org.onap.policy.models.base.PfModelRuntimeException;
33 import org.onap.policy.models.base.Validated;
34 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
35 import org.onap.policy.models.tosca.simple.concepts.JpaToscaEntityType;
36 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
37 import org.onap.policy.models.tosca.simple.concepts.JpaToscaTopologyTemplate;
40 * This utility class provides methods to manage service templates.
42 @NoArgsConstructor(access = AccessLevel.PRIVATE)
43 public final class ToscaServiceTemplateUtils {
46 * Add a service template fragment to a service template. All entities in the service template fragment must either
47 * a) not exist on the original service template or b) be identical to entities on the original service template.
49 * @param originalTemplate the original service template
50 * @param fragmentTemplate the fragment being added to the original service template
51 * @return JpaToscaServiceTemplate
53 public static JpaToscaServiceTemplate addFragment(@NonNull final JpaToscaServiceTemplate originalTemplate,
54 @NonNull final JpaToscaServiceTemplate fragmentTemplate) {
56 var result = new BeanValidationResult("incoming fragment", fragmentTemplate);
58 if (originalTemplate.compareToWithoutEntities(fragmentTemplate) != 0) {
59 Validated.addResult(result, "service template",
60 originalTemplate.getKey(),
61 "does not equal existing service template");
64 var compositeTemplate = new JpaToscaServiceTemplate(originalTemplate);
66 compositeTemplate.setDataTypes(
67 addFragmentEntitites(compositeTemplate.getDataTypes(), fragmentTemplate.getDataTypes(), result));
68 compositeTemplate.setPolicyTypes(
69 addFragmentEntitites(compositeTemplate.getPolicyTypes(), fragmentTemplate.getPolicyTypes(), result));
70 compositeTemplate.setNodeTypes(
71 addFragmentEntitites(compositeTemplate.getNodeTypes(), fragmentTemplate.getNodeTypes(), result));
73 if (originalTemplate.getTopologyTemplate() != null && fragmentTemplate.getTopologyTemplate() != null) {
74 if (originalTemplate.getTopologyTemplate()
75 .compareToWithoutEntities(fragmentTemplate.getTopologyTemplate()) == 0) {
76 compositeTemplate.getTopologyTemplate()
77 .setPolicies(addFragmentEntitites(compositeTemplate.getTopologyTemplate().getPolicies(),
78 fragmentTemplate.getTopologyTemplate().getPolicies(), result));
79 compositeTemplate.getTopologyTemplate()
80 .setNodeTemplates(addFragmentEntitites(compositeTemplate.getTopologyTemplate().getNodeTemplates(),
81 fragmentTemplate.getTopologyTemplate().getNodeTemplates(), result));
83 Validated.addResult(result, "topology template",
84 originalTemplate.getTopologyTemplate().getKey(),
85 "does not equal existing topology template");
87 } else if (fragmentTemplate.getTopologyTemplate() != null) {
88 compositeTemplate.setTopologyTemplate(new JpaToscaTopologyTemplate(fragmentTemplate.getTopologyTemplate()));
91 if (result.isValid()) {
92 result.addResult(compositeTemplate.validate("composite template"));
95 if (!result.isValid()) {
96 String message = result.getResult();
97 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, message);
100 return compositeTemplate;
104 * Check entities from a fragment container can be added to an original container.
106 * @param <E> The type of TOSCA entity
107 * @param <J> The type of the JPA TOSCA entity
108 * @param <S> The type of container
110 * @param compositeContainer the original container
111 * @param fragmentContainer the fragment being added to the original container
112 * @return the composite container with the result
114 private static <E extends ToscaEntity, J extends JpaToscaEntityType<E>, S extends PfConceptContainer<J, E>>
115 S addFragmentEntitites(final S compositeContainer, final S fragmentContainer,
116 final BeanValidationResult result) {
118 if (compositeContainer == null) {
119 return fragmentContainer;
122 if (fragmentContainer == null) {
123 return compositeContainer;
126 var result2 = new BeanValidationResult("incoming fragment", fragmentContainer);
127 var originalContainerMap = compositeContainer.getConceptMap();
128 var fragmentContainerMap = fragmentContainer.getConceptMap();
130 for (Entry<PfConceptKey, J> fragmentEntry : fragmentContainerMap.entrySet()) {
131 J containerEntity = originalContainerMap.get(fragmentEntry.getKey());
132 if (containerEntity != null && containerEntity.compareTo(fragmentEntry.getValue()) != 0) {
133 Validated.addResult(result, "entity", fragmentEntry.getKey(), "does not equal existing entity");
137 if (!result2.isClean()) {
138 result.addResult(result2);
141 originalContainerMap.putAll(fragmentContainerMap);
143 return compositeContainer;