Changed identifiers to concept identifiers
[policy/models.git] / models-tosca / src / main / java / org / onap / policy / models / tosca / simple / concepts / JpaToscaServiceTemplate.java
index 786784c..594a5c3 100644 (file)
@@ -1,7 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2019-2020 Nordix Foundation.
- *  Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ *  Copyright (C) 2019-2021 Nordix Foundation.
+ *  Modifications Copyright (C) 2019-2020 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.
 package org.onap.policy.models.tosca.simple.concepts;
 
 import com.google.gson.annotations.SerializedName;
-
+import java.util.Collection;
 import java.util.Collections;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
-
 import javax.persistence.CascadeType;
 import javax.persistence.Column;
 import javax.persistence.Entity;
@@ -38,22 +37,23 @@ import javax.persistence.JoinColumn;
 import javax.persistence.JoinColumns;
 import javax.persistence.OneToOne;
 import javax.persistence.Table;
-
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.NonNull;
-
 import org.apache.commons.lang3.ObjectUtils;
-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.ToscaCapabilityType;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeType;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaRelationshipType;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
 
 /**
@@ -72,13 +72,15 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
         implements PfAuthorative<ToscaServiceTemplate> {
     private static final long serialVersionUID = 8084846046148349401L;
 
-    public static final String DEFAULT_TOSCA_DEFINTIONS_VERISON = "tosca_simple_yaml_1_0_0";
+    public static final String DEFAULT_TOSCA_DEFINTIONS_VERISON = "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)
@@ -89,8 +91,42 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             }
         )
     @SerializedName("data_types")
+    @Valid
     private JpaToscaDataTypes dataTypes;
 
+    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumns(
+            {
+                @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)
+    @JoinColumns(
+            {
+                @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)
+    @JoinColumns(
+            {
+                @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)
     @JoinColumns(
             {
@@ -99,10 +135,20 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             }
         )
     @SerializedName("policy_types")
+    @Valid
     private JpaToscaPolicyTypes policyTypes;
 
-    @Column
+    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
+    @JoinColumns(
+            {
+                @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
 
@@ -142,6 +188,12 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
         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)
@@ -174,6 +226,30 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             }
         }
 
+        if (capabilityTypes != null) {
+            toscaServiceTemplate.setCapabilityTypes(new LinkedHashMap<>());
+            List<Map<String, ToscaCapabilityType>> capabilityTypeMapList = capabilityTypes.toAuthorative();
+            for (Map<String, ToscaCapabilityType> capabilityTypeMap : capabilityTypeMapList) {
+                toscaServiceTemplate.getCapabilityTypes().putAll(capabilityTypeMap);
+            }
+        }
+
+        if (relationshipTypes != null) {
+            toscaServiceTemplate.setRelationshipTypes(new LinkedHashMap<>());
+            List<Map<String, ToscaRelationshipType>> relationshipTypeMapList = relationshipTypes.toAuthorative();
+            for (Map<String, ToscaRelationshipType> relationshipTypeMap : relationshipTypeMapList) {
+                toscaServiceTemplate.getRelationshipTypes().putAll(relationshipTypeMap);
+            }
+        }
+
+        if (nodeTypes != null) {
+            toscaServiceTemplate.setNodeTypes(new LinkedHashMap<>());
+            List<Map<String, ToscaNodeType>> nodeTypeMapList = nodeTypes.toAuthorative();
+            for (Map<String, ToscaNodeType> nodeTypeMap : nodeTypeMapList) {
+                toscaServiceTemplate.getNodeTypes().putAll(nodeTypeMap);
+            }
+        }
+
         if (policyTypes != null) {
             toscaServiceTemplate.setPolicyTypes(new LinkedHashMap<>());
             List<Map<String, ToscaPolicyType>> policyTypeMapList = policyTypes.toAuthorative();
@@ -193,11 +269,11 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
     public void fromAuthorative(ToscaServiceTemplate toscaServiceTemplate) {
         super.fromAuthorative(toscaServiceTemplate);
 
-        if (PfKey.NULL_KEY_NAME.equals(getKey().getName())) {
+        if (toscaServiceTemplate.getDefinedName() == null) {
             getKey().setName(DEFAULT_NAME);
         }
 
-        if (PfKey.NULL_KEY_VERSION.equals(getKey().getVersion())) {
+        if (toscaServiceTemplate.getDefinedVersion() == null) {
             getKey().setVersion(DEFAULT_VERSION);
         }
 
@@ -208,6 +284,21 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             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(Collections.singletonList(toscaServiceTemplate.getPolicyTypes()));
@@ -227,6 +318,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());
         }
@@ -246,44 +349,41 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             dataTypes.clean();
         }
 
-        if (policyTypes != null) {
-            policyTypes.clean();
+        if (capabilityTypes != null) {
+            capabilityTypes.clean();
         }
 
-        if (topologyTemplate != null) {
-            topologyTemplate.clean();
+        if (relationshipTypes != null) {
+            relationshipTypes.clean();
         }
-    }
 
-    @Override
-    public PfValidationResult validate(final PfValidationResult resultIn) {
-        PfValidationResult result = super.validate(resultIn);
-
-        if (!ParameterValidationUtils.validateStringParameter(toscaDefinitionsVersion)) {
-            result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
-                    "service template tosca definitions version may not be null"));
-        }
-
-        if (dataTypes != null) {
-            result = dataTypes.validate(result);
+        if (nodeTypes != null) {
+            nodeTypes.clean();
         }
 
         if (policyTypes != null) {
-            result = policyTypes.validate(result);
+            policyTypes.clean();
         }
 
         if (topologyTemplate != null) {
-            result = topologyTemplate.validate(result);
+            topologyTemplate.clean();
         }
+    }
+
+    @Override
+    public BeanValidationResult validate(String fieldName) {
+        BeanValidationResult result = super.validate(fieldName);
 
         // No point in validating cross references if the structure of the individual parts are not valid
-        if (!result.isOk()) {
+        if (!result.isValid()) {
             return result;
         }
 
-        validateDatatypesInPolicyTypes(result);
+        validateReferencedDataTypes(result);
 
-        return validatePolicyTypesInPolicies(result);
+        validatePolicyTypesInPolicies(result);
+
+        return result;
     }
 
     @Override
@@ -300,6 +400,21 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
             return result;
         }
 
+        result = ObjectUtils.compare(capabilityTypes, other.capabilityTypes);
+        if (result != 0) {
+            return result;
+        }
+
+        result = ObjectUtils.compare(relationshipTypes, other.relationshipTypes);
+        if (result != 0) {
+            return result;
+        }
+
+        result = ObjectUtils.compare(nodeTypes, other.nodeTypes);
+        if (result != 0) {
+            return result;
+        }
+
         result = ObjectUtils.compare(policyTypes, other.policyTypes);
         if (result != 0) {
             return result;
@@ -337,52 +452,60 @@ public class JpaToscaServiceTemplate extends JpaToscaEntityType<ToscaServiceTemp
      * Validate that all data types referenced in policy types exist.
      *
      * @param result the validation result object to use for the validation result
-     * @return the validation result object
+     * @param result where the results are added
      */
-    private PfValidationResult validateDatatypesInPolicyTypes(final PfValidationResult result) {
+    private void validateReferencedDataTypes(final BeanValidationResult result) {
         if (policyTypes == null) {
-            return result;
+            return;
         }
 
-        for (JpaToscaPolicyType policyType : policyTypes.getAll(null)) {
-            for (PfConceptKey datatypeKey : policyType.getReferencedDataTypes()) {
-                if (dataTypes == null || dataTypes.get(datatypeKey) == null) {
-                    result.addValidationMessage(
-                            new PfValidationMessage(policyType.getKey(), this.getClass(), ValidationResult.INVALID,
-                                    "data type " + datatypeKey + " referenced in policy type not found"));
-                }
+        if (dataTypes != null) {
+            for (JpaToscaDataType dataType : dataTypes.getAll(null)) {
+                validateReferencedDataTypesExists(dataType.getReferencedDataTypes(), result);
             }
         }
 
-        return 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);
+            }
+        }
     }
 
     /**
      * Validate that all policy types referenced in policies exist.
      *
-     * @param result the validation result object to use for the validation result
-     * @return the validation result object
+     * @param result where the results are added
      */
-    private PfValidationResult validatePolicyTypesInPolicies(PfValidationResult result) {
-        if (topologyTemplate == null || topologyTemplate.getPolicies() == null) {
-            return result;
+    private void validatePolicyTypesInPolicies(BeanValidationResult result) {
+        if (topologyTemplate == null || topologyTemplate.getPolicies() == null
+                || topologyTemplate.getPolicies().getConceptMap().isEmpty()) {
+            return;
         }
 
-        if (policyTypes == null) {
-            result.addValidationMessage(new PfValidationMessage(this.getKey(), this.getClass(),
-                    ValidationResult.INVALID,
-                    "no policy types are defined on the service template for the policies in the topology template"));
-            return result;
+        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) {
-                result.addValidationMessage(
-                        new PfValidationMessage(policy.getKey(), this.getClass(), ValidationResult.INVALID,
-                                "policy type " + policy.getType().getId() + " referenced in policy not found"));
+                addResult(result, "policy type", policy.getType().getId(), NOT_FOUND);
             }
         }
-
-        return result;
     }
 }