Changes for Checkstyle 8.32
[policy/models.git] / models-tosca / src / main / java / org / onap / policy / models / tosca / simple / concepts / JpaToscaPolicy.java
index 3e049ea..689d035 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.
@@ -28,7 +28,6 @@ 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 +38,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;
@@ -89,10 +85,10 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
 
     @ElementCollection
     @Lob
-    private Map<String, String> properties;
+    private Map<String, String> properties = new LinkedHashMap<>();
 
     @ElementCollection
-    private List<PfConceptKey> targets;
+    private List<PfConceptKey> targets = new ArrayList<>();
     // @formatter:on
 
     /**
@@ -129,6 +125,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);
     }
 
     /**
@@ -159,6 +158,8 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
         if (properties != null) {
             Map<String, Object> propertyMap = new LinkedHashMap<>();
 
+            final StandardCoder coder = new StandardCoder();
+
             for (Entry<String, String> entry : properties.entrySet()) {
                 try {
                     // TODO: This is a HACK, we need to validate the properties against their
@@ -166,10 +167,10 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
                     // 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));
+                    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();
+                        + ", value=" + entry.getValue();
                     throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ce);
                 }
             }
@@ -184,15 +185,27 @@ 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<>();
 
+            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
@@ -200,10 +213,10 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
                 // 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()));
+                    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();
+                        + propertyEntry.getKey() + ", value=" + propertyEntry.getValue();
                     throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ce);
                 }
             }
@@ -216,7 +229,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,15 +262,20 @@ 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"));
+                "type is null or a null key"));
         } else {
             result = type.validate(result);
         }
 
         if (properties != null) {
-            result = validateProperties(result);
+            validateProperties(result);
         }
 
         if (targets != null) {
@@ -270,22 +288,19 @@ 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())) {
                 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
-                        "policy property key may not be null "));
+                    "policy property key may not be null "));
             } else if (propertyEntry.getValue() == null) {
                 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
-                        "policy property value may not be null "));
+                    "policy property value may not be null "));
             }
         }
-        return result;
     }
 
     /**
@@ -300,7 +315,7 @@ public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements P
         for (PfConceptKey target : targets) {
             if (target == null) {
                 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
-                        "policy target may not be null "));
+                    "policy target may not be null "));
             } else {
                 result = target.validate(result);
             }
@@ -319,7 +334,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;
@@ -338,33 +353,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;
-    }
 }