JPA concepts for TOSCA
[policy/models.git] / models-tosca / src / main / java / org / onap / policy / models / tosca / simple / concepts / JpaToscaPolicy.java
index 3e049ea..518a088 100644 (file)
@@ -2,8 +2,8 @@
  * ============LICENSE_START=======================================================
  * ONAP Policy Model
  * ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
- * Modifications Copyright (C) 2019 Nordix Foundation.
+ * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
+ * 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.
 
 package org.onap.policy.models.tosca.simple.concepts;
 
-import java.util.ArrayList;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
-
 import javax.persistence.AttributeOverride;
 import javax.persistence.AttributeOverrides;
 import javax.persistence.Column;
@@ -39,14 +37,11 @@ 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.coder.CoderException;
 import org.onap.policy.common.utils.coder.StandardCoder;
-import org.onap.policy.common.utils.validation.Assertions;
 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
 import org.onap.policy.models.base.PfAuthorative;
 import org.onap.policy.models.base.PfConcept;
@@ -77,6 +72,8 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
     private static final String METADATA_POLICY_ID_TAG = "policy-id";
     private static final String METADATA_POLICY_VERSION_TAG = "policy-version";
 
+    private static final StandardCoder STANDARD_CODER = new StandardCoder();
+
     // @formatter:off
     @Column
     @AttributeOverrides({
@@ -129,6 +126,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);
     }
 
     /**
@@ -156,26 +156,14 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
             toscaPolicy.setTypeVersion(null);
         }
 
-        if (properties != null) {
-            Map<String, Object> propertyMap = new LinkedHashMap<>();
-
-            for (Entry<String, String> entry : properties.entrySet()) {
-                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(), new StandardCoder().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(PfUtils.mapMap(properties, property -> {
+            try {
+                return STANDARD_CODER.decode(property, Object.class);
+            } catch (CoderException ce) {
+                String errorMessage = "error decoding property JSON value read from database: " + property;
+                throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ce);
             }
-
-            toscaPolicy.setProperties(propertyMap);
-        }
+        }));
 
         return toscaPolicy;
     }
@@ -184,30 +172,30 @@ 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) {
-            type.setVersion(PfKey.NULL_KEY_VERSION);
+        if (toscaPolicy.getType() != null) {
+            type.setName(toscaPolicy.getType());
+        } else {
+            throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
+                    "PolicyType type not specified, the type of the PolicyType for this policy must be specified in "
+                            + "the type field");
+        }
+
+        if (toscaPolicy.getTypeVersion() != null) {
+            type.setVersion(toscaPolicy.getTypeVersion());
+        } else {
+            throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
+                    "PolicyType version not specified, the version of the PolicyType for this policy must be specified"
+                            + " in the type_version field");
         }
 
-        if (toscaPolicy.getProperties() != null) {
-            properties = new LinkedHashMap<>();
-
-            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
-                try {
-                    properties.put(propertyEntry.getKey(), new StandardCoder().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);
-                }
+        properties = PfUtils.mapMap(toscaPolicy.getProperties(), property -> {
+            try {
+                return STANDARD_CODER.encode(property);
+            } catch (CoderException ce) {
+                String errorMessage = "error encoding property JSON value for database: " + property;
+                throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ce);
             }
-        }
+        });
 
         // Add the property metadata if it doesn't exist already
         if (toscaPolicy.getMetadata() == null) {
@@ -216,7 +204,7 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
 
         // 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()));
+        getMetadata().put(METADATA_POLICY_VERSION_TAG, getKey().getVersion());
     }
 
     @Override
@@ -249,6 +237,11 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
     public PfValidationResult validate(@NonNull final PfValidationResult resultIn) {
         PfValidationResult result = super.validate(resultIn);
 
+        if (PfKey.NULL_KEY_VERSION.equals(getKey().getVersion())) {
+            result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
+                    "key version is a null version"));
+        }
+
         if (type == null || type.isNullKey()) {
             result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
                     "type is null or a null key"));
@@ -257,7 +250,7 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
         }
 
         if (properties != null) {
-            result = validateProperties(result);
+            validateProperties(result);
         }
 
         if (targets != null) {
@@ -270,11 +263,9 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
     /**
      * Validate the policy properties.
      *
-     * @param result The result of validations up to now
-     * @return the validation result
+     * @param result where to put the validation results
      */
-    private PfValidationResult validateProperties(final PfValidationResult resultIn) {
-        PfValidationResult result = resultIn;
+    private void validateProperties(final PfValidationResult result) {
 
         for (Entry<String, String> propertyEntry : properties.entrySet()) {
             if (!ParameterValidationUtils.validateStringParameter(propertyEntry.getKey())) {
@@ -285,13 +276,12 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
                         "policy property value may not be null "));
             }
         }
-        return result;
     }
 
     /**
      * Validate the policy targets.
      *
-     * @param result The result of validations up to now
+     * @param resultIn The result of validations up to now
      * @return the validation result
      */
     private PfValidationResult validateTargets(final PfValidationResult resultIn) {
@@ -319,52 +309,25 @@ 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;
-        if (!super.equals(other)) {
-            return super.compareTo(other);
-        }
-
-        if (!type.equals(other.type)) {
-            return type.compareTo(other.type);
+        int result = super.compareTo(other);
+        if (result != 0) {
+            return result;
         }
 
-        int retVal = PfUtils.compareObjects(properties, other.properties);
-        if (retVal != 0) {
-            return retVal;
+        result = type.compareTo(other.type);
+        if (result != 0) {
+            return result;
         }
 
-        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);
+        result = PfUtils.compareMaps(properties, other.properties);
+        if (result != 0) {
+            return result;
         }
 
-        return copy;
+        return PfUtils.compareCollections(targets, other.targets);
     }
 }