models-tosca/src/main/java/org/onap/policy/models/tosca/utils/ToscaServiceTemplateUtils.java

   1 /*-
   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
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.tosca.utils;
  23
  24 import java.util.Map.Entry;
  25 import javax.ws.rs.core.Response;
  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;
  38
  39 /**
  40  * This utility class provides methods to manage service templates.
  41  */
  42 @NoArgsConstructor(access = AccessLevel.PRIVATE)
  43 public final class ToscaServiceTemplateUtils {
  44
  45     /**
  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.
  48      *
  49      * @param originalTemplate the original service template
  50      * @param fragmentTemplate the fragment being added to the original service template
  51      * @return JpaToscaServiceTemplate
  52      */
  53     public static JpaToscaServiceTemplate addFragment(@NonNull final JpaToscaServiceTemplate originalTemplate,
  54             @NonNull final JpaToscaServiceTemplate fragmentTemplate) {
  55
  56         var result = new BeanValidationResult("incoming fragment", fragmentTemplate);
  57
  58         if (originalTemplate.compareToWithoutEntities(fragmentTemplate) != 0) {
  59             Validated.addResult(result, "service template",
  60                             originalTemplate.getKey(),
  61                             "does not equal existing service template");
  62         }
  63
  64         var compositeTemplate = new JpaToscaServiceTemplate(originalTemplate);
  65
  66         compositeTemplate.setDataTypes(
  67                 addFragmentEntitites(compositeTemplate.getDataTypes(), fragmentTemplate.getDataTypes(), result));
  68         compositeTemplate.setPolicyTypes(
  69                 addFragmentEntitites(compositeTemplate.getPolicyTypes(), fragmentTemplate.getPolicyTypes(), result));
  70
  71         if (originalTemplate.getTopologyTemplate() != null && fragmentTemplate.getTopologyTemplate() != null) {
  72             if (originalTemplate.getTopologyTemplate()
  73                     .compareToWithoutEntities(fragmentTemplate.getTopologyTemplate()) == 0) {
  74                 compositeTemplate.getTopologyTemplate()
  75                         .setPolicies(addFragmentEntitites(compositeTemplate.getTopologyTemplate().getPolicies(),
  76                                 fragmentTemplate.getTopologyTemplate().getPolicies(), result));
  77             } else {
  78                 Validated.addResult(result, "topology template",
  79                                 originalTemplate.getTopologyTemplate().getKey(),
  80                                 "does not equal existing topology template");
  81             }
  82         } else if (fragmentTemplate.getTopologyTemplate() != null) {
  83             compositeTemplate.setTopologyTemplate(new JpaToscaTopologyTemplate(fragmentTemplate.getTopologyTemplate()));
  84         }
  85
  86         if (result.isValid()) {
  87             result.addResult(compositeTemplate.validate("composite template"));
  88         }
  89
  90         if (!result.isValid()) {
  91             String message = result.getResult();
  92             throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE, message);
  93         }
  94
  95         return compositeTemplate;
  96     }
  97
  98     /**
  99      * Check entities from a fragment container can be added to an original container.
 100      *
 101      * @param <E> The type of TOSCA entity
 102      * @param <J> The type of the JPA TOSCA entity
 103      * @param <S> The type of container
 104      *
 105      * @param compositeContainer the original container
 106      * @param fragmentContainer the fragment being added to the original container
 107      * @return the composite container with the result
 108      */
 109     private static <E extends ToscaEntity, J extends JpaToscaEntityType<E>, S extends PfConceptContainer<J, E>>
 110             S addFragmentEntitites(final S compositeContainer, final S fragmentContainer,
 111                     final BeanValidationResult result) {
 112
 113         if (compositeContainer == null) {
 114             return fragmentContainer;
 115         }
 116
 117         if (fragmentContainer == null) {
 118             return compositeContainer;
 119         }
 120
 121         var result2 = new BeanValidationResult("incoming fragment", fragmentContainer);
 122         var originalContainerMap = compositeContainer.getConceptMap();
 123         var fragmentContainerMap = fragmentContainer.getConceptMap();
 124
 125         for (Entry<PfConceptKey, J> fragmentEntry : fragmentContainerMap.entrySet()) {
 126             J containerEntity = originalContainerMap.get(fragmentEntry.getKey());
 127             if (containerEntity != null && containerEntity.compareTo(fragmentEntry.getValue()) != 0) {
 128                 Validated.addResult(result, "entity", fragmentEntry.getKey(), "does not equal existing entity");
 129             }
 130         }
 131
 132         if (!result2.isClean()) {
 133             result.addResult(result2);
 134         }
 135
 136         originalContainerMap.putAll(fragmentContainerMap);
 137
 138         return compositeContainer;
 139     }
 140 }