X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=models-tosca%2Fsrc%2Fmain%2Fjava%2Forg%2Fonap%2Fpolicy%2Fmodels%2Ftosca%2Fsimple%2Fconcepts%2FJpaToscaServiceTemplate.java;h=8f878c86ef351ced5872f3d934706d01ecb1603e;hb=938005505883cf7a636a8840e20e3dc8a0ad9176;hp=5f50e4a4393b62ff30000d80d9dc914d720a2024;hpb=891bffd9f13177d96ad26acdfa7148d09e1d682a;p=policy%2Fmodels.git

diff --git a/models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaServiceTemplate.java b/models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaServiceTemplate.java
index 5f50e4a43..8f878c86e 100644
--- a/models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaServiceTemplate.java
+++ b/models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaServiceTemplate.java
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2019 Nordix Foundation.
+ *  Copyright (C) 2019-2021, 2023 Nordix Foundation.
+ *  Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,32 +22,33 @@
 package org.onap.policy.models.tosca.simple.concepts;
 
 import com.google.gson.annotations.SerializedName;
-
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.FetchType;
+import jakarta.persistence.Inheritance;
+import jakarta.persistence.InheritanceType;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.OneToOne;
+import jakarta.persistence.Table;
+import java.io.Serial;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.LinkedHashMap;
 import java.util.List;
-
-import javax.persistence.CascadeType;
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.FetchType;
-import javax.persistence.Inheritance;
-import javax.persistence.InheritanceType;
-import javax.persistence.OneToOne;
-import javax.persistence.Table;
-
+import java.util.Map;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.NonNull;
-
 import org.apache.commons.lang3.ObjectUtils;
-import org.onap.policy.common.utils.validation.Assertions;
-import org.onap.policy.common.utils.validation.ParameterValidationUtils;
+import org.onap.policy.common.parameters.BeanValidationResult;
+import org.onap.policy.common.parameters.annotations.NotBlank;
+import org.onap.policy.common.parameters.annotations.NotNull;
+import org.onap.policy.common.parameters.annotations.Valid;
 import org.onap.policy.models.base.PfAuthorative;
 import org.onap.policy.models.base.PfConcept;
 import org.onap.policy.models.base.PfConceptKey;
 import org.onap.policy.models.base.PfKey;
-import org.onap.policy.models.base.PfValidationMessage;
-import org.onap.policy.models.base.PfValidationResult;
-import org.onap.policy.models.base.PfValidationResult.ValidationResult;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
 
 /**
@@ -55,34 +57,72 @@ import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  *
  * @author Liam Fallon (liam.fallon@est.tech)
  */
+
 @Entity
 @Table(name = "ToscaServiceTemplate")
 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
 @Data
 @EqualsAndHashCode(callSuper = true)
 public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemplate>
-        implements PfAuthorative<ToscaServiceTemplate> {
+    implements PfAuthorative<ToscaServiceTemplate> {
+    @Serial
     private static final long serialVersionUID = 8084846046148349401L;
 
+    public static final String DEFAULT_TOSCA_DEFINITIONS_VERSION = "tosca_simple_yaml_1_1_0";
     public static final String DEFAULT_NAME = "ToscaServiceTemplateSimple";
     public static final String DEFAULT_VERSION = "1.0.0";
 
+    // @formatter:off
     @Column
     @SerializedName("tosca_definitions_version")
+    @NotNull
+    @NotBlank
     private String toscaDefinitionsVersion;
 
     @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumn(name = "dataTypesName",    referencedColumnName = "name")
+    @JoinColumn(name = "dataTypesVersion", referencedColumnName = "version")
     @SerializedName("data_types")
+    @Valid
     private JpaToscaDataTypes dataTypes;
 
     @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumn(name = "capabilityTypesName",    referencedColumnName = "name")
+    @JoinColumn(name = "capabilityTypesVersion", referencedColumnName = "version")
+    @SerializedName("capability_types")
+    @Valid
+    private JpaToscaCapabilityTypes capabilityTypes;
+
+    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumn(name = "relationshipTypesName",    referencedColumnName = "name")
+    @JoinColumn(name = "relationshipTypesVersion", referencedColumnName = "version")
+    @SerializedName("relationship_types")
+    @Valid
+    private JpaToscaRelationshipTypes relationshipTypes;
+
+    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumn(name = "nodeTypesName",    referencedColumnName = "name")
+    @JoinColumn(name = "nodeTypesVersion", referencedColumnName = "version")
+    @SerializedName("node_types")
+    @Valid
+    private JpaToscaNodeTypes nodeTypes;
+
+    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumn(name = "policyTypesName",    referencedColumnName = "name")
+    @JoinColumn(name = "policyTypesVersion", referencedColumnName = "version")
     @SerializedName("policy_types")
+    @Valid
     private JpaToscaPolicyTypes policyTypes;
 
-    @Column
+    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumn(name = "topologyTemplateParentKeyName",    referencedColumnName = "parentKeyName")
+    @JoinColumn(name = "topologyTemplateParentKeyVersion", referencedColumnName = "parentKeyVersion")
+    @JoinColumn(name = "topologyTemplateParentLocalName",  referencedColumnName = "parentLocalName")
+    @JoinColumn(name = "topologyTemplateLocalName",        referencedColumnName = "localName")
     @SerializedName("topology_template")
+    @Valid
     private JpaToscaTopologyTemplate topologyTemplate;
-
+    // @formatter:on
 
     /**
      * The Default Constructor creates a {@link JpaToscaServiceTemplate} object with a null key.
@@ -97,13 +137,13 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
      * @param key the key
      */
     public JpaToscaServiceTemplate(@NonNull final PfConceptKey key) {
-        this(key, "");
+        this(key, DEFAULT_TOSCA_DEFINITIONS_VERSION);
     }
 
     /**
      * The full constructor creates a {@link JpaToscaServiceTemplate} object with all mandatory parameters.
      *
-     * @param key the key
+     * @param key                     the key
      * @param toscaDefinitionsVersion the TOSCA version string
      */
     public JpaToscaServiceTemplate(@NonNull final PfConceptKey key, @NonNull final String toscaDefinitionsVersion) {
@@ -118,6 +158,18 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
      */
     public JpaToscaServiceTemplate(final JpaToscaServiceTemplate copyConcept) {
         super(copyConcept);
+        this.toscaDefinitionsVersion = copyConcept.toscaDefinitionsVersion;
+        this.dataTypes = (copyConcept.dataTypes != null ? new JpaToscaDataTypes(copyConcept.dataTypes) : null);
+        this.capabilityTypes =
+            (copyConcept.capabilityTypes != null ? new JpaToscaCapabilityTypes(copyConcept.capabilityTypes) : null);
+        this.relationshipTypes =
+            (copyConcept.relationshipTypes != null ? new JpaToscaRelationshipTypes(copyConcept.relationshipTypes)
+                : null);
+        this.nodeTypes = (copyConcept.nodeTypes != null ? new JpaToscaNodeTypes(copyConcept.nodeTypes) : null);
+        this.policyTypes = (copyConcept.policyTypes != null ? new JpaToscaPolicyTypes(copyConcept.policyTypes) : null);
+        this.topologyTemplate =
+            (copyConcept.topologyTemplate != null ? new JpaToscaTopologyTemplate(copyConcept.topologyTemplate)
+                : null);
     }
 
     /**
@@ -131,7 +183,7 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
 
     @Override
     public ToscaServiceTemplate toAuthorative() {
-        final ToscaServiceTemplate toscaServiceTemplate = new ToscaServiceTemplate();
+        final var toscaServiceTemplate = new ToscaServiceTemplate();
 
         super.setToscaEntity(toscaServiceTemplate);
         super.toAuthorative();
@@ -139,11 +191,23 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
         toscaServiceTemplate.setToscaDefinitionsVersion(toscaDefinitionsVersion);
 
         if (dataTypes != null) {
-            toscaServiceTemplate.setDataTypes(dataTypes.toAuthorative());
+            toscaServiceTemplate.setDataTypes(flattenMap(dataTypes.toAuthorative()));
+        }
+
+        if (capabilityTypes != null) {
+            toscaServiceTemplate.setCapabilityTypes(flattenMap(capabilityTypes.toAuthorative()));
+        }
+
+        if (relationshipTypes != null) {
+            toscaServiceTemplate.setRelationshipTypes(flattenMap(relationshipTypes.toAuthorative()));
+        }
+
+        if (nodeTypes != null) {
+            toscaServiceTemplate.setNodeTypes(flattenMap(nodeTypes.toAuthorative()));
         }
 
         if (policyTypes != null) {
-            toscaServiceTemplate.setPolicyTypes(policyTypes.toAuthorative());
+            toscaServiceTemplate.setPolicyTypes(flattenMap(policyTypes.toAuthorative()));
         }
 
         if (topologyTemplate != null) {
@@ -153,15 +217,31 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
         return toscaServiceTemplate;
     }
 
+    /**
+     * Takes a list of maps and flattens it into a single map.
+     *
+     * @param list list to be flattened
+     * @return a map containing all the elements from the list of maps
+     */
+    private <V> Map<String, V> flattenMap(List<Map<String, V>> list) {
+        Map<String, V> result = new LinkedHashMap<>();
+
+        for (Map<String, V> map : list) {
+            result.putAll(map);
+        }
+
+        return result;
+    }
+
     @Override
     public void fromAuthorative(ToscaServiceTemplate toscaServiceTemplate) {
         super.fromAuthorative(toscaServiceTemplate);
 
-        if (getKey().getName() == PfKey.NULL_KEY_NAME) {
+        if (toscaServiceTemplate.getDefinedName() == null) {
             getKey().setName(DEFAULT_NAME);
         }
 
-        if (getKey().getVersion() == PfKey.NULL_KEY_VERSION) {
+        if (toscaServiceTemplate.getDefinedVersion() == null) {
             getKey().setVersion(DEFAULT_VERSION);
         }
 
@@ -169,15 +249,29 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
 
         if (toscaServiceTemplate.getDataTypes() != null) {
             dataTypes = new JpaToscaDataTypes();
-            dataTypes.fromAuthorative(toscaServiceTemplate.getDataTypes());
+            dataTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getDataTypes()));
+        }
+
+        if (toscaServiceTemplate.getCapabilityTypes() != null) {
+            capabilityTypes = new JpaToscaCapabilityTypes();
+            capabilityTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getCapabilityTypes()));
+        }
+
+        if (toscaServiceTemplate.getRelationshipTypes() != null) {
+            relationshipTypes = new JpaToscaRelationshipTypes();
+            relationshipTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getRelationshipTypes()));
+        }
+
+        if (toscaServiceTemplate.getNodeTypes() != null) {
+            nodeTypes = new JpaToscaNodeTypes();
+            nodeTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getNodeTypes()));
         }
 
         if (toscaServiceTemplate.getPolicyTypes() != null) {
             policyTypes = new JpaToscaPolicyTypes();
-            policyTypes.fromAuthorative(toscaServiceTemplate.getPolicyTypes());
+            policyTypes.fromAuthorative(Collections.singletonList(toscaServiceTemplate.getPolicyTypes()));
         }
 
-
         if (toscaServiceTemplate.getToscaTopologyTemplate() != null) {
             topologyTemplate = new JpaToscaTopologyTemplate();
             topologyTemplate.fromAuthorative(toscaServiceTemplate.getToscaTopologyTemplate());
@@ -192,6 +286,18 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             keyList.addAll(dataTypes.getKeys());
         }
 
+        if (capabilityTypes != null) {
+            keyList.addAll(capabilityTypes.getKeys());
+        }
+
+        if (relationshipTypes != null) {
+            keyList.addAll(relationshipTypes.getKeys());
+        }
+
+        if (nodeTypes != null) {
+            keyList.addAll(nodeTypes.getKeys());
+        }
+
         if (policyTypes != null) {
             keyList.addAll(policyTypes.getKeys());
         }
@@ -211,6 +317,18 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             dataTypes.clean();
         }
 
+        if (capabilityTypes != null) {
+            capabilityTypes.clean();
+        }
+
+        if (relationshipTypes != null) {
+            relationshipTypes.clean();
+        }
+
+        if (nodeTypes != null) {
+            nodeTypes.clean();
+        }
+
         if (policyTypes != null) {
             policyTypes.clean();
         }
@@ -221,48 +339,46 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
     }
 
     @Override
-    public PfValidationResult validate(final PfValidationResult resultIn) {
-        PfValidationResult result = super.validate(resultIn);
+    public BeanValidationResult validate(String fieldName) {
+        BeanValidationResult result = super.validate(fieldName);
 
-        if (!ParameterValidationUtils.validateStringParameter(toscaDefinitionsVersion)) {
-            result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
-                    "service template tosca definitions version may not be null"));
+        // No point in validating cross-references if the structure of the individual parts are not valid
+        if (!result.isValid()) {
+            return result;
         }
 
-        if (dataTypes != null) {
-            result = dataTypes.validate(result);
-        }
+        validateReferencedDataTypes(result);
 
-        if (policyTypes != null) {
-            result = policyTypes.validate(result);
-        }
+        validatePolicyTypesInPolicies(result);
 
-        return (topologyTemplate != null ? topologyTemplate.validate(result) : result);
+        return result;
     }
 
     @Override
     public int compareTo(final PfConcept otherConcept) {
-        if (otherConcept == null) {
-            return -1;
-        }
-        if (this == otherConcept) {
-            return 0;
-        }
-        if (getClass() != otherConcept.getClass()) {
-            return this.hashCode() - otherConcept.hashCode();
+        int result = compareToWithoutEntities(otherConcept);
+        if (result != 0) {
+            return result;
         }
 
         final JpaToscaServiceTemplate other = (JpaToscaServiceTemplate) otherConcept;
-        if (!super.equals(other)) {
-            return super.compareTo(other);
+
+        result = ObjectUtils.compare(dataTypes, other.dataTypes);
+        if (result != 0) {
+            return result;
         }
 
-        int result = ObjectUtils.compare(toscaDefinitionsVersion, other.toscaDefinitionsVersion);
+        result = ObjectUtils.compare(capabilityTypes, other.capabilityTypes);
         if (result != 0) {
             return result;
         }
 
-        result = ObjectUtils.compare(dataTypes, other.dataTypes);
+        result = ObjectUtils.compare(relationshipTypes, other.relationshipTypes);
+        if (result != 0) {
+            return result;
+        }
+
+        result = ObjectUtils.compare(nodeTypes, other.nodeTypes);
         if (result != 0) {
             return result;
         }
@@ -275,19 +391,88 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
         return ObjectUtils.compare(topologyTemplate, other.topologyTemplate);
     }
 
-    @Override
-    public PfConcept copyTo(@NonNull PfConcept target) {
-        final Object copyObject = target;
-        Assertions.instanceOf(copyObject, PfConcept.class);
+    /**
+     * Compare this service template to another service template, ignoring contained entitites.
+     *
+     * @param otherConcept the other topology template
+     * @return the result of the comparison
+     */
+    public int compareToWithoutEntities(final PfConcept otherConcept) {
+        if (otherConcept == null) {
+            return -1;
+        }
+        if (this == otherConcept) {
+            return 0;
+        }
+        if (getClass() != otherConcept.getClass()) {
+            return getClass().getName().compareTo(otherConcept.getClass().getName());
+        }
 
-        final JpaToscaServiceTemplate copy = ((JpaToscaServiceTemplate) copyObject);
-        super.copyTo(target);
-        copy.setToscaDefinitionsVersion(toscaDefinitionsVersion);
+        final JpaToscaServiceTemplate other = (JpaToscaServiceTemplate) otherConcept;
+        if (!super.equals(other)) {
+            return super.compareTo(other);
+        }
+
+        return ObjectUtils.compare(toscaDefinitionsVersion, other.toscaDefinitionsVersion);
+    }
+
+    /**
+     * Validate that all data types referenced in policy types exist.
+     *
+     * @param result where the results are added
+     */
+    private void validateReferencedDataTypes(final BeanValidationResult result) {
+        if (policyTypes == null) {
+            return;
+        }
+
+        if (dataTypes != null) {
+            for (JpaToscaDataType dataType : dataTypes.getAll(null)) {
+                validateReferencedDataTypesExists(dataType.getReferencedDataTypes(), result);
+            }
+        }
+
+        for (JpaToscaPolicyType policyType : policyTypes.getAll(null)) {
+            validateReferencedDataTypesExists(policyType.getReferencedDataTypes(), result);
+        }
+    }
+
+    /**
+     * Validate that the referenced data types exist for a collection of data type keys.
+     *
+     * @param dataTypeKeyCollection the data type key collection
+     * @param result                where the results are added
+     */
+    private void validateReferencedDataTypesExists(final Collection<PfConceptKey> dataTypeKeyCollection,
+                                                   final BeanValidationResult result) {
+        for (PfConceptKey dataTypeKey : dataTypeKeyCollection) {
+            if (dataTypes == null || dataTypes.get(dataTypeKey) == null) {
+                addResult(result, "data type", dataTypeKey.getId(), NOT_FOUND);
+            }
+        }
+    }
 
-        copy.setDataTypes(dataTypes != null ? new JpaToscaDataTypes(dataTypes) : null);
-        copy.setPolicyTypes(policyTypes != null ? new JpaToscaPolicyTypes(policyTypes) : null);
-        copy.setTopologyTemplate(topologyTemplate != null ? new JpaToscaTopologyTemplate(topologyTemplate) : null);
+    /**
+     * Validate that all policy types referenced in policies exist.
+     *
+     * @param result where the results are added
+     */
+    private void validatePolicyTypesInPolicies(BeanValidationResult result) {
+        if (topologyTemplate == null || topologyTemplate.getPolicies() == null
+            || topologyTemplate.getPolicies().getConceptMap().isEmpty()) {
+            return;
+        }
 
-        return copy;
+        if (policyTypes == null || policyTypes.getConceptMap().isEmpty()) {
+            addResult(result, "policyTypes", policyTypes,
+                "no policy types are defined on the service template for the policies in the topology template");
+            return;
+        }
+
+        for (JpaToscaPolicy policy : topologyTemplate.getPolicies().getAll(null)) {
+            if (policyTypes.get(policy.getType()) == null) {
+                addResult(result, "policy type", policy.getType().getId(), NOT_FOUND);
+            }
+        }
     }
 }