models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaTopologyTemplate.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2020,2023 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019-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.simple.concepts;
  23
  24 import com.google.gson.annotations.SerializedName;
  25 import java.util.Collections;
  26 import java.util.LinkedHashMap;
  27 import java.util.List;
  28 import java.util.Map;
  29 import javax.persistence.CascadeType;
  30 import javax.persistence.Column;
  31 import javax.persistence.ElementCollection;
  32 import javax.persistence.EmbeddedId;
  33 import javax.persistence.Entity;
  34 import javax.persistence.FetchType;
  35 import javax.persistence.Inheritance;
  36 import javax.persistence.InheritanceType;
  37 import javax.persistence.JoinColumn;
  38 import javax.persistence.JoinColumns;
  39 import javax.persistence.Lob;
  40 import javax.persistence.OneToOne;
  41 import javax.persistence.Table;
  42 import lombok.Data;
  43 import lombok.EqualsAndHashCode;
  44 import lombok.NonNull;
  45 import org.apache.commons.lang3.ObjectUtils;
  46 import org.onap.policy.common.parameters.annotations.NotBlank;
  47 import org.onap.policy.common.parameters.annotations.NotNull;
  48 import org.onap.policy.common.parameters.annotations.Valid;
  49 import org.onap.policy.models.base.PfAuthorative;
  50 import org.onap.policy.models.base.PfConcept;
  51 import org.onap.policy.models.base.PfKey;
  52 import org.onap.policy.models.base.PfReferenceKey;
  53 import org.onap.policy.models.base.PfUtils;
  54 import org.onap.policy.models.base.validation.annotations.VerifyKey;
  55 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  56 import org.onap.policy.models.tosca.authorative.concepts.ToscaParameter;
  57 import org.onap.policy.models.tosca.authorative.concepts.ToscaTopologyTemplate;
  58
  59 /**
  60  * This class holds a TOSCA topology template. Note: Only the policy specific parts of the TOSCA topology template are
  61  * implemented.
  62  *
  63  * @author Liam Fallon (liam.fallon@est.tech)
  64  */
  65 @Entity
  66 @Table(name = "ToscaTopologyTemplate")
  67 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
  68 @Data
  69 @EqualsAndHashCode(callSuper = false)
  70 public class JpaToscaTopologyTemplate extends PfConcept implements PfAuthorative<ToscaTopologyTemplate> {
  71     private static final long serialVersionUID = 8969698734673232603L;
  72
  73     public static final String DEFAULT_LOCAL_NAME = "ToscaTopologyTemplateSimple";
  74
  75     @EmbeddedId
  76     @VerifyKey
  77     @NotNull
  78     private PfReferenceKey key;
  79
  80     @Column(name = "description")
  81     @NotBlank
  82     private String description;
  83
  84     // @formatter:off
  85     @ElementCollection
  86     @Lob
  87     private Map<@NotNull String, @NotNull @Valid JpaToscaParameter> inputs;
  88
  89     @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
  90     @JoinColumns({
  91         @JoinColumn(name = "nodeTemplatesName", referencedColumnName = "name"),
  92         @JoinColumn(name = "nodeTemplatessVersion", referencedColumnName = "version")
  93     })
  94     @SerializedName("data_types")
  95     @Valid
  96     private JpaToscaNodeTemplates nodeTemplates;
  97
  98     @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
  99     @JoinColumns({
 100         @JoinColumn(name = "policyName",    referencedColumnName = "name"),
 101         @JoinColumn(name = "policyVersion", referencedColumnName = "version")
 102
 103     })
 104     // @formatter:on
 105     @Valid
 106     private JpaToscaPolicies policies;
 107
 108     /**
 109      * The Default Constructor creates a {@link JpaToscaTopologyTemplate} object with a null key.
 110      */
 111     public JpaToscaTopologyTemplate() {
 112         this(new PfReferenceKey(JpaToscaServiceTemplate.DEFAULT_NAME, JpaToscaServiceTemplate.DEFAULT_VERSION,
 113                 DEFAULT_LOCAL_NAME));
 114     }
 115
 116     /**
 117      * The Key Constructor creates a {@link JpaToscaTopologyTemplate} object with the given concept key.
 118      *
 119      * @param key the key
 120      */
 121     public JpaToscaTopologyTemplate(@NonNull final PfReferenceKey key) {
 122         this.key = key;
 123     }
 124
 125     /**
 126      * Copy constructor.
 127      *
 128      * @param copyConcept the concept to copy from
 129      */
 130     public JpaToscaTopologyTemplate(final JpaToscaTopologyTemplate copyConcept) {
 131         super(copyConcept);
 132         this.key = new PfReferenceKey(copyConcept.key);
 133         this.description = copyConcept.description;
 134         this.inputs = PfUtils.mapMap(copyConcept.inputs, JpaToscaParameter::new);
 135         this.nodeTemplates =
 136                 (copyConcept.nodeTemplates != null ? new JpaToscaNodeTemplates(copyConcept.nodeTemplates) : null);
 137         this.policies = (copyConcept.policies != null ? new JpaToscaPolicies(copyConcept.policies) : null);
 138     }
 139
 140     /**
 141      * Authorative constructor.
 142      *
 143      * @param authorativeConcept the authorative concept to copy from
 144      */
 145     public JpaToscaTopologyTemplate(final ToscaTopologyTemplate authorativeConcept) {
 146         this.fromAuthorative(authorativeConcept);
 147     }
 148
 149     @Override
 150     public ToscaTopologyTemplate toAuthorative() {
 151         final var toscaTopologyTemplate = new ToscaTopologyTemplate();
 152
 153         toscaTopologyTemplate.setDescription(description);
 154
 155         if (inputs != null) {
 156             Map<String, ToscaParameter> inputMap = new LinkedHashMap<>();
 157
 158             for (Map.Entry<String, JpaToscaParameter> entry : inputs.entrySet()) {
 159                 inputMap.put(entry.getKey(), entry.getValue().toAuthorative());
 160             }
 161
 162             toscaTopologyTemplate.setInputs(inputMap);
 163         }
 164
 165         if (nodeTemplates != null) {
 166             toscaTopologyTemplate.setNodeTemplates(new LinkedHashMap<>());
 167             List<Map<String, ToscaNodeTemplate>> nodeTemplateMapList = nodeTemplates.toAuthorative();
 168             for (Map<String, ToscaNodeTemplate> nodeTemplateMap : nodeTemplateMapList) {
 169                 toscaTopologyTemplate.getNodeTemplates().putAll(nodeTemplateMap);
 170             }
 171         }
 172
 173         if (policies != null) {
 174             toscaTopologyTemplate.setPolicies(policies.toAuthorative());
 175         }
 176
 177         return toscaTopologyTemplate;
 178     }
 179
 180     @Override
 181     public void fromAuthorative(ToscaTopologyTemplate toscaTopologyTemplate) {
 182         description = toscaTopologyTemplate.getDescription();
 183
 184         if (toscaTopologyTemplate.getInputs() != null) {
 185             inputs = new LinkedHashMap<>();
 186             for (Map.Entry<String, ToscaParameter> toscaInputEntry : toscaTopologyTemplate.getInputs().entrySet()) {
 187                 var jpaInput = new JpaToscaParameter(toscaInputEntry.getValue());
 188                 jpaInput.setKey(new PfReferenceKey(getKey(), toscaInputEntry.getKey()));
 189                 inputs.put(toscaInputEntry.getKey(), jpaInput);
 190             }
 191         }
 192
 193         if (toscaTopologyTemplate.getNodeTemplates() != null) {
 194             nodeTemplates = new JpaToscaNodeTemplates();
 195             nodeTemplates.fromAuthorative(Collections.singletonList(toscaTopologyTemplate.getNodeTemplates()));
 196         }
 197
 198         if (toscaTopologyTemplate.getPolicies() != null) {
 199             policies = new JpaToscaPolicies();
 200             policies.fromAuthorative(toscaTopologyTemplate.getPolicies());
 201         }
 202     }
 203
 204     @Override
 205     public List<PfKey> getKeys() {
 206         final List<PfKey> keyList = getKey().getKeys();
 207
 208         if (inputs != null) {
 209             for (JpaToscaParameter input : inputs.values()) {
 210                 keyList.addAll(input.getKeys());
 211             }
 212         }
 213
 214         if (nodeTemplates != null) {
 215             keyList.addAll(nodeTemplates.getKeys());
 216         }
 217
 218         if (policies != null) {
 219             keyList.addAll(policies.getKeys());
 220         }
 221
 222         return keyList;
 223     }
 224
 225     @Override
 226     public void clean() {
 227         key.clean();
 228
 229         description = (description != null ? description.trim() : null);
 230
 231         if (inputs != null) {
 232             for (JpaToscaParameter input : inputs.values()) {
 233                 input.clean();
 234             }
 235         }
 236
 237         if (nodeTemplates != null) {
 238             nodeTemplates.clean();
 239         }
 240
 241         if (policies != null) {
 242             policies.clean();
 243         }
 244     }
 245
 246     @Override
 247     public int compareTo(final PfConcept otherConcept) {
 248         int result = compareToWithoutEntities(otherConcept);
 249         if (result != 0) {
 250             return result;
 251         }
 252
 253         final JpaToscaTopologyTemplate other = (JpaToscaTopologyTemplate) otherConcept;
 254
 255         result = PfUtils.compareObjects(inputs, other.inputs);
 256         if (result != 0) {
 257             return result;
 258         }
 259
 260         result = ObjectUtils.compare(nodeTemplates, other.nodeTemplates);
 261         if (result != 0) {
 262             return result;
 263         }
 264
 265         return ObjectUtils.compare(policies, other.policies);
 266     }
 267
 268     /**
 269      * Compare this topology template to another topology template, ignoring contained entities.
 270      *
 271      * @param otherConcept the other topology template
 272      * @return the result of the comparison
 273      */
 274     public int compareToWithoutEntities(final PfConcept otherConcept) {
 275         if (otherConcept == null) {
 276             return -1;
 277         }
 278         if (this == otherConcept) {
 279             return 0;
 280         }
 281         if (getClass() != otherConcept.getClass()) {
 282             return getClass().getName().compareTo(otherConcept.getClass().getName());
 283         }
 284
 285         final JpaToscaTopologyTemplate other = (JpaToscaTopologyTemplate) otherConcept;
 286         if (!key.equals(other.key)) {
 287             return key.compareTo(other.key);
 288         }
 289
 290         return ObjectUtils.compare(description, other.description);
 291     }
 292 }