2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020 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 java.util.Map.Entry;
25 import javax.ws.rs.core.Response;
26 import lombok.NonNull;
27 import org.onap.policy.common.parameters.BeanValidationResult;
28 import org.onap.policy.models.base.PfConceptContainer;
29 import org.onap.policy.models.base.PfConceptKey;
30 import org.onap.policy.models.base.PfModelRuntimeException;
31 import org.onap.policy.models.base.Validated;
32 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
33 import org.onap.policy.models.tosca.simple.concepts.JpaToscaEntityType;
34 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
35 import org.onap.policy.models.tosca.simple.concepts.JpaToscaTopologyTemplate;
38 * This utility class provides methods to manage service templates.
40 public class ToscaServiceTemplateUtils {
42 * Private constructor to prevent subclassing.
44 private ToscaServiceTemplateUtils() {
45 // Private constructor to prevent subclassing
49 * Add a service template fragment to a service template. All entities in the service template fragment must either
50 * a) not exist on the original service template or b) be identical to entities on the original service template.
52 * @param originalTemplate the original service template
53 * @param fragmentTemplate the fragment being added to the original service template
54 * @return JpaToscaServiceTemplate
56 public static JpaToscaServiceTemplate addFragment(@NonNull final JpaToscaServiceTemplate originalTemplate,
57 @NonNull final JpaToscaServiceTemplate fragmentTemplate) {
59 var result = new BeanValidationResult("incoming fragment", fragmentTemplate);
61 if (originalTemplate.compareToWithoutEntities(fragmentTemplate) != 0) {
62 Validated.addResult(result, "service template",
63 originalTemplate.getKey(),
64 "does not equal existing service template");
67 var compositeTemplate = new JpaToscaServiceTemplate(originalTemplate);
69 compositeTemplate.setDataTypes(
70 addFragmentEntitites(compositeTemplate.getDataTypes(), fragmentTemplate.getDataTypes(), result));
71 compositeTemplate.setPolicyTypes(
72 addFragmentEntitites(compositeTemplate.getPolicyTypes(), fragmentTemplate.getPolicyTypes(), result));
74 if (originalTemplate.getTopologyTemplate() != null && fragmentTemplate.getTopologyTemplate() != null) {
75 if (originalTemplate.getTopologyTemplate()
76 .compareToWithoutEntities(fragmentTemplate.getTopologyTemplate()) == 0) {
77 compositeTemplate.getTopologyTemplate()
78 .setPolicies(addFragmentEntitites(compositeTemplate.getTopologyTemplate().getPolicies(),
79 fragmentTemplate.getTopologyTemplate().getPolicies(), result));
81 Validated.addResult(result, "topology template",
82 originalTemplate.getTopologyTemplate().getKey(),
83 "does not equal existing topology template");
85 } else if (fragmentTemplate.getTopologyTemplate() != null) {
86 compositeTemplate.setTopologyTemplate(new JpaToscaTopologyTemplate(fragmentTemplate.getTopologyTemplate()));
89 if (result.isValid()) {
90 result.addResult(compositeTemplate.validate("composite template"));
93 if (!result.isValid()) {
94 String message = result.getResult();
95 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, message);
98 return compositeTemplate;
102 * Check entities from a fragment container can be added to an original container.
104 * @param <E> The type of TOSCA entity
105 * @param <J> The type of the JPA TOSCA entity
106 * @param <S> The type of container
108 * @param compositeContainer the original container
109 * @param fragmentContainer the fragment being added to the original container
110 * @return the composite container with the result
112 private static <E extends ToscaEntity, J extends JpaToscaEntityType<E>, S extends PfConceptContainer<J, E>>
113 S addFragmentEntitites(final S compositeContainer, final S fragmentContainer,
114 final BeanValidationResult result) {
116 if (compositeContainer == null) {
117 return fragmentContainer;
120 if (fragmentContainer == null) {
121 return compositeContainer;
124 var result2 = new BeanValidationResult("incoming fragment", fragmentContainer);
125 var originalContainerMap = compositeContainer.getConceptMap();
126 var fragmentContainerMap = fragmentContainer.getConceptMap();
128 for (Entry<PfConceptKey, J> fragmentEntry : fragmentContainerMap.entrySet()) {
129 J containerEntity = originalContainerMap.get(fragmentEntry.getKey());
130 if (containerEntity != null && containerEntity.compareTo(fragmentEntry.getValue()) != 0) {
131 Validated.addResult(result, "entity", fragmentEntry.getKey(), "does not equal existing entity");
135 if (!result2.isClean()) {
136 result.addResult(result2);
139 originalContainerMap.putAll(fragmentContainerMap);
141 return compositeContainer;