Implement validation and hierarchical get
[policy/models.git] / models-tosca / src / main / java / org / onap / policy / models / tosca / simple / concepts / JpaToscaPolicy.java
index 67a833c..2816df0 100644 (file)
@@ -3,7 +3,7 @@
  * ONAP Policy Model
  * ================================================================================
  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
- * Modifications Copyright (C) 2019 Nordix Foundation.
+ * Modifications Copyright (C) 2019-2020 Nordix Foundation.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,18 +36,22 @@ import javax.persistence.ElementCollection;
 import javax.persistence.Entity;
 import javax.persistence.Inheritance;
 import javax.persistence.InheritanceType;
+import javax.persistence.Lob;
 import javax.persistence.Table;
+import javax.ws.rs.core.Response;
 
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.NonNull;
 
-import org.onap.policy.common.utils.validation.Assertions;
+import org.onap.policy.common.utils.coder.CoderException;
+import org.onap.policy.common.utils.coder.StandardCoder;
 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
 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.PfModelRuntimeException;
 import org.onap.policy.models.base.PfUtils;
 import org.onap.policy.models.base.PfValidationMessage;
 import org.onap.policy.models.base.PfValidationResult;
@@ -68,6 +72,10 @@ import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
 public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements PfAuthorative<ToscaPolicy> {
     private static final long serialVersionUID = 3265174757061982805L;
 
+    // Tags for metadata
+    private static final String METADATA_POLICY_ID_TAG = "policy-id";
+    private static final String METADATA_POLICY_VERSION_TAG = "policy-version";
+
     // @formatter:off
     @Column
     @AttributeOverrides({
@@ -79,11 +87,11 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
     private PfConceptKey type;
 
     @ElementCollection
-    @Column(length = 10000)
+    @Lob
     private Map<String, String> properties;
 
     @ElementCollection
-    private List<PfConceptKey> targets;
+    private List<PfConceptKey> targets = new ArrayList<>();
     // @formatter:on
 
     /**
@@ -120,6 +128,9 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
      */
     public JpaToscaPolicy(@NonNull final JpaToscaPolicy copyConcept) {
         super(copyConcept);
+        this.type = new PfConceptKey(copyConcept.type);
+        this.properties = (copyConcept.properties != null ? new LinkedHashMap<>(copyConcept.properties) : null);
+        this.targets = PfUtils.mapList(copyConcept.targets, PfConceptKey::new);
     }
 
     /**
@@ -128,6 +139,8 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
      * @param authorativeConcept the authorative concept to copy from
      */
     public JpaToscaPolicy(final ToscaPolicy authorativeConcept) {
+        super(new PfConceptKey());
+        type = new PfConceptKey();
         this.fromAuthorative(authorativeConcept);
     }
 
@@ -141,16 +154,28 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
 
         if (!PfKey.NULL_KEY_VERSION.equals(type.getVersion())) {
             toscaPolicy.setTypeVersion(type.getVersion());
-        }
-        else {
+        } else {
             toscaPolicy.setTypeVersion(null);
         }
 
         if (properties != null) {
             Map<String, Object> propertyMap = new LinkedHashMap<>();
 
+            final StandardCoder coder = new StandardCoder();
+
             for (Entry<String, String> entry : properties.entrySet()) {
-                propertyMap.put(entry.getKey(), entry.getValue());
+                try {
+                    // TODO: This is a HACK, we need to validate the properties against their
+                    // TODO: their data type in their policy type definition in TOSCA, which means reading
+                    // TODO: the policy type from the database and parsing the property value object correctly
+                    // TODO: Here we are simply reading a JSON string from the database and deserializing the
+                    // TODO: property value from JSON
+                    propertyMap.put(entry.getKey(), coder.decode(entry.getValue(), Object.class));
+                } catch (CoderException ce) {
+                    String errorMessage = "error decoding property JSON value read from database: key=" + entry.getKey()
+                            + ", value=" + entry.getValue();
+                    throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ce);
+                }
             }
 
             toscaPolicy.setProperties(propertyMap);
@@ -163,24 +188,47 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
     public void fromAuthorative(@NonNull final ToscaPolicy toscaPolicy) {
         super.fromAuthorative(toscaPolicy);
 
-        type.setName(toscaPolicy.getType());
-        type.setVersion(toscaPolicy.getTypeVersion());
-        if (type.getVersion() == null) {
+        if (toscaPolicy.getType() != null) {
+            type.setName(toscaPolicy.getType());
+        } else {
+            type.setName(PfKey.NULL_KEY_NAME);
+        }
+
+        if (toscaPolicy.getTypeVersion() != null) {
+            type.setVersion(toscaPolicy.getTypeVersion());
+        } else {
             type.setVersion(PfKey.NULL_KEY_VERSION);
         }
 
         if (toscaPolicy.getProperties() != null) {
             properties = new LinkedHashMap<>();
 
+            final StandardCoder coder = new StandardCoder();
+
             for (Entry<String, Object> propertyEntry : toscaPolicy.getProperties().entrySet()) {
                 // TODO: This is a HACK, we need to validate the properties against their
                 // TODO: their data type in their policy type definition in TOSCA, which means reading
                 // TODO: the policy type from the database and parsing the property value object correctly
                 // TODO: Here we are simply serializing the property value into a string and storing it
                 // TODO: unvalidated into the database
-                properties.put(propertyEntry.getKey(), propertyEntry.getValue().toString());
+                try {
+                    properties.put(propertyEntry.getKey(), coder.encode(propertyEntry.getValue()));
+                } catch (CoderException ce) {
+                    String errorMessage = "error encoding property JSON value for database: key="
+                            + propertyEntry.getKey() + ", value=" + propertyEntry.getValue();
+                    throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ce);
+                }
             }
         }
+
+        // Add the property metadata if it doesn't exist already
+        if (toscaPolicy.getMetadata() == null) {
+            setMetadata(new LinkedHashMap<>());
+        }
+
+        // Add the policy name and version fields to the metadata
+        getMetadata().put(METADATA_POLICY_ID_TAG, getKey().getName());
+        getMetadata().put(METADATA_POLICY_VERSION_TAG, Integer.toString(getKey().getMajorVersion()));
     }
 
     @Override
@@ -214,7 +262,7 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
         PfValidationResult result = super.validate(resultIn);
 
         if (type == null || type.isNullKey()) {
-            result.addValidationMessage(new PfValidationMessage(type, this.getClass(), ValidationResult.INVALID,
+            result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
                     "type is null or a null key"));
         } else {
             result = type.validate(result);
@@ -237,7 +285,7 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
      * @param result The result of validations up to now
      * @return the validation result
      */
-    private PfValidationResult validateProperties(@NonNull final PfValidationResult resultIn) {
+    private PfValidationResult validateProperties(final PfValidationResult resultIn) {
         PfValidationResult result = resultIn;
 
         for (Entry<String, String> propertyEntry : properties.entrySet()) {
@@ -283,7 +331,7 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
         }
 
         if (getClass() != otherConcept.getClass()) {
-            return this.hashCode() - otherConcept.hashCode();
+            return getClass().getName().compareTo(otherConcept.getClass().getName());
         }
 
         final JpaToscaPolicy other = (JpaToscaPolicy) otherConcept;
@@ -302,33 +350,4 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
 
         return PfUtils.compareObjects(targets, other.targets);
     }
-
-    @Override
-    public PfConcept copyTo(@NonNull PfConcept target) {
-        final Object copyObject = target;
-        Assertions.instanceOf(copyObject, PfConcept.class);
-
-        final JpaToscaPolicy copy = ((JpaToscaPolicy) copyObject);
-        super.copyTo(target);
-
-        copy.setType(new PfConceptKey(type));
-
-        if (properties == null) {
-            copy.setProperties(null);
-        } else {
-            copy.setProperties(properties);
-        }
-
-        if (targets == null) {
-            copy.setTargets(null);
-        } else {
-            final List<PfConceptKey> newTargets = new ArrayList<>();
-            for (final PfConceptKey oldTarget : targets) {
-                newTargets.add(new PfConceptKey(oldTarget));
-            }
-            copy.setTargets(newTargets);
-        }
-
-        return copy;
-    }
 }