From 96e93d0c2642717ed5b37dcc2721ee2755141e76 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Fri, 13 Mar 2020 12:34:58 +0000 Subject: Consistent returns on Service Template gets This review enables specification of versions of entities on incoming service templates using a ':' delimiter. So this will load version 1.00, version 2.0.0, and version 3.0.0: org.onap.entitiy:1.0.0: version: 1.0.0 org.onap.entity:2.0.0: version: 2.0.0 org.onap.entity version: 3.0.0 So this will load version 1.00, version 2.0.0, and version 4.0.0: org.onap.entitiy:1.0.0: version: 1.0.0 org.onap.entity:2.0.0: version: 2.0.0 org.onap.entity: version: 3.0.0 org.onap.entity: version: 4.0.0 This will load org.onap.entity:1.0.0 name: org.onap.entity version: 1.0.0 This will throw an exception org.onap.entity:1.0.0 name: org.onap.some.other.entity version: 1.0.0 This will throw an exception org.onap.entity:1.0.0: name: org.onap.entity version: 2.0.0 Issue-ID: POLICY-2377 Change-Id: I34bccf065b4ee4d2fe71b052bf009d4a40e2cba8 Signed-off-by: liamfallon --- .../policy/models/base/PfConceptContainer.java | 72 +++++++++++++--------- .../org/onap/policy/models/base/PfKeyImpl.java | 37 ++++++----- 2 files changed, 67 insertions(+), 42 deletions(-) (limited to 'models-base/src/main/java/org') diff --git a/models-base/src/main/java/org/onap/policy/models/base/PfConceptContainer.java b/models-base/src/main/java/org/onap/policy/models/base/PfConceptContainer.java index 949cb96dc..1c1e4613e 100644 --- a/models-base/src/main/java/org/onap/policy/models/base/PfConceptContainer.java +++ b/models-base/src/main/java/org/onap/policy/models/base/PfConceptContainer.java @@ -30,6 +30,7 @@ import java.util.Map.Entry; import java.util.NavigableMap; import java.util.Set; import java.util.TreeMap; +import java.util.function.Function; import javax.persistence.CascadeType; import javax.persistence.EmbeddedId; @@ -45,6 +46,7 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.NonNull; +import org.apache.commons.lang3.StringUtils; import org.onap.policy.models.base.PfValidationResult.ValidationResult; // @formatter:off @@ -67,7 +69,7 @@ import org.onap.policy.models.base.PfValidationResult.ValidationResult; @EqualsAndHashCode(callSuper = false) public class PfConceptContainer extends PfConcept - implements PfConceptGetter, PfAuthorative>> { + implements PfConceptGetter, PfAuthorative>> { private static final long serialVersionUID = -324211738823208318L; @EmbeddedId @@ -178,31 +180,32 @@ public class PfConceptContainer ex for (Map incomingConceptMap : authorativeList) { // Add the map entries one by one for (Entry incomingConceptEntry : incomingConceptMap.entrySet()) { - C jpaConcept = getConceptNewInstance(); + PfConceptKey conceptKey = new PfConceptKey(); + if (incomingConceptEntry.getKey().matches(PfKey.KEY_ID_REGEXP)) { + conceptKey = new PfConceptKey(incomingConceptEntry.getKey()); + } else { + conceptKey.setName(incomingConceptEntry.getKey()); + if (incomingConceptEntry.getValue().getVersion() != null) { + conceptKey.setVersion(incomingConceptEntry.getValue().getVersion()); + } else { + conceptKey.setVersion(PfKey.NULL_KEY_VERSION); + } + } + + incomingConceptEntry.getValue().setName(findConceptField(conceptKey, conceptKey.getName(), + incomingConceptEntry.getValue(), PfNameVersion::getName)); + incomingConceptEntry.getValue().setVersion(findConceptField(conceptKey, conceptKey.getVersion(), + incomingConceptEntry.getValue(), PfNameVersion::getVersion)); + + C jpaConcept = getConceptNewInstance(); // This cast allows us to call the fromAuthorative method @SuppressWarnings("unchecked") PfAuthorative authoritiveImpl = (PfAuthorative) jpaConcept; - if (incomingConceptEntry.getValue().getName() == null) { - incomingConceptEntry.getValue().setName(incomingConceptEntry.getKey()); - } - // Set the key name and the rest of the values on the concept authoritiveImpl.fromAuthorative(incomingConceptEntry.getValue()); - // This cast gets the key of the concept - PfConceptKey conceptKey = (PfConceptKey) jpaConcept.getKey(); - - // Set the concept key of the concept - conceptKey.setName(incomingConceptEntry.getValue().getName()); - - if (incomingConceptEntry.getValue().getVersion() != null) { - conceptKey.setVersion(incomingConceptEntry.getValue().getVersion()); - } else { - conceptKey.setVersion(PfKey.NULL_KEY_VERSION); - } - // After all that, save the map entry conceptMap.put(conceptKey, jpaConcept); } @@ -210,7 +213,7 @@ public class PfConceptContainer ex if (conceptMap.isEmpty()) { throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, - "An incoming list of concepts must have at least one entry"); + "An incoming list of concepts must have at least one entry"); } } @@ -229,7 +232,7 @@ public class PfConceptContainer ex if (key.equals(PfConceptKey.getNullKey())) { result.addValidationMessage( - new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID, "key is a null key")); + new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID, "key is a null key")); } result = key.validate(result); @@ -253,14 +256,14 @@ public class PfConceptContainer ex for (final Entry conceptEntry : conceptMap.entrySet()) { if (conceptEntry.getKey().equals(PfConceptKey.getNullKey())) { result.addValidationMessage(new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "key on concept entry " + conceptEntry.getKey() + " may not be the null key")); + "key on concept entry " + conceptEntry.getKey() + " may not be the null key")); } else if (conceptEntry.getValue() == null) { result.addValidationMessage(new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "value on concept entry " + conceptEntry.getKey() + " may not be null")); + "value on concept entry " + conceptEntry.getKey() + " may not be null")); } else if (!conceptEntry.getKey().equals(conceptEntry.getValue().getKey())) { result.addValidationMessage(new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID, - "key on concept entry key " + conceptEntry.getKey() + " does not equal concept value key " - + conceptEntry.getValue().getKey())); + "key on concept entry key " + conceptEntry.getKey() + " does not equal concept value key " + + conceptEntry.getValue().getKey())); result = conceptEntry.getValue().validate(result); } else { result = conceptEntry.getValue().validate(result); @@ -308,7 +311,7 @@ public class PfConceptContainer ex @Override public C get(final String conceptKeyName, final String conceptKeyVersion) { return new PfConceptGetterImpl<>((NavigableMap) conceptMap).get(conceptKeyName, - conceptKeyVersion); + conceptKeyVersion); } @Override @@ -319,7 +322,7 @@ public class PfConceptContainer ex @Override public Set getAll(final String conceptKeyName, final String conceptKeyVersion) { return new PfConceptGetterImpl<>((NavigableMap) conceptMap).getAll(conceptKeyName, - conceptKeyVersion); + conceptKeyVersion); } /** @@ -331,11 +334,24 @@ public class PfConceptContainer ex private C getConceptNewInstance() { try { String conceptClassName = - ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0].getTypeName(); + ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0].getTypeName(); return (C) Class.forName(conceptClassName).getDeclaredConstructor().newInstance(); } catch (Exception ex) { throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, - "failed to instantiate instance of container concept class", ex); + "failed to instantiate instance of container concept class", ex); + } + } + + private String findConceptField(final PfConceptKey conceptKey, final String keyFieldValue, + final PfNameVersion concept, final Function fieldGetterFunction) { + + String conceptField = fieldGetterFunction.apply(concept); + + if (StringUtils.isBlank(conceptField) || keyFieldValue.equals(conceptField)) { + return keyFieldValue; + } else { + throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, "Key " + conceptKey.getId() + " field " + + keyFieldValue + " does not match the value " + conceptField + " in the concept field"); } } } diff --git a/models-base/src/main/java/org/onap/policy/models/base/PfKeyImpl.java b/models-base/src/main/java/org/onap/policy/models/base/PfKeyImpl.java index 461fd2495..61028f927 100644 --- a/models-base/src/main/java/org/onap/policy/models/base/PfKeyImpl.java +++ b/models-base/src/main/java/org/onap/policy/models/base/PfKeyImpl.java @@ -1,6 +1,6 @@ /* * ============LICENSE_START======================================================= - * Copyright (C) 2019 Nordix Foundation. + * Copyright (C) 2019-2020 Nordix Foundation. * Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); @@ -23,9 +23,11 @@ package org.onap.policy.models.base; import java.util.ArrayList; import java.util.List; + import lombok.Getter; import lombok.NonNull; import lombok.ToString; + import org.onap.policy.common.utils.validation.Assertions; import org.onap.policy.models.base.PfValidationResult.ValidationResult; @@ -115,6 +117,15 @@ public abstract class PfKeyImpl extends PfKey { return (PfKey.NULL_KEY_NAME.equals(getName()) && PfKey.NULL_KEY_VERSION.equals(getVersion())); } + /** + * Determines if the name is "null". + * + * @return {@code true} if the name is null, {@code false} otherwise + */ + public boolean isNullName() { + return PfKey.NULL_KEY_NAME.equals(getName()); + } + /** * Determines if the version is "null". * @@ -147,7 +158,7 @@ public abstract class PfKeyImpl extends PfKey { } if (thisVersionArray.length >= 2 && otherVersionArray.length >= 2 - && !thisVersionArray[1].equals(otherVersionArray[1])) { + && !thisVersionArray[1].equals(otherVersionArray[1])) { return Compatibility.MINOR; } @@ -189,12 +200,12 @@ public abstract class PfKeyImpl extends PfKey { } if (thisVersionArray.length >= 2 && otherVersionArray.length >= 2 - && !thisVersionArray[1].equals(otherVersionArray[1])) { + && !thisVersionArray[1].equals(otherVersionArray[1])) { return Integer.valueOf(thisVersionArray[1]) > Integer.valueOf(otherVersionArray[1]); } if (thisVersionArray.length >= 3 && otherVersionArray.length >= 3 - && !thisVersionArray[2].equals(otherVersionArray[2])) { + && !thisVersionArray[2].equals(otherVersionArray[2])) { return Integer.valueOf(thisVersionArray[2]) > Integer.valueOf(otherVersionArray[2]); } @@ -215,8 +226,7 @@ public abstract class PfKeyImpl extends PfKey { if (versionArray.length >= 2) { return Integer.parseInt(versionArray[1]); - } - else { + } else { return 0; } } @@ -227,26 +237,25 @@ public abstract class PfKeyImpl extends PfKey { if (versionArray.length >= 3) { return Integer.parseInt(versionArray[2]); - } - else { + } else { return 0; } } @Override public PfValidationResult validate(final PfValidationResult result) { - final String nameValidationErrorMessage = Assertions.getStringParameterValidationMessage(NAME_TOKEN, getName(), - getNameRegEx()); + final String nameValidationErrorMessage = + Assertions.getStringParameterValidationMessage(NAME_TOKEN, getName(), getNameRegEx()); if (nameValidationErrorMessage != null) { result.addValidationMessage(new PfValidationMessage(this, this.getClass(), ValidationResult.INVALID, - "name invalid-" + nameValidationErrorMessage)); + "name invalid-" + nameValidationErrorMessage)); } - final String versionValidationErrorMessage = Assertions.getStringParameterValidationMessage(VERSION_TOKEN, - getVersion(), getVersionRegEx()); + final String versionValidationErrorMessage = + Assertions.getStringParameterValidationMessage(VERSION_TOKEN, getVersion(), getVersionRegEx()); if (versionValidationErrorMessage != null) { result.addValidationMessage(new PfValidationMessage(this, this.getClass(), ValidationResult.INVALID, - "version invalid-" + versionValidationErrorMessage)); + "version invalid-" + versionValidationErrorMessage)); } return result; -- cgit 1.2.3-korg