Support annotations on parameterized types

It appears that java.validation allows validation annotations to be used
on the type parameters of Collection and Map classes.  Updated the
validation code to support that.  Once policy-models has been updated to
use this approach, the original @Items and @Entries annotations will be
deprecated.

Issue-ID: POLICY-2648
Change-Id: Ic953be485ebafc9869f72407518f6549585353c9
Signed-off-by: Jim Hahn <jrh3@att.com>

9 files changed, 214 insertions, 13 deletions

diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/BeanValidator.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/BeanValidator.java
index 51b11402..6791c616 100644
--- a/common-parameters/src/main/java/org/onap/policy/common/parameters/BeanValidator.java
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/BeanValidator.java
@@ -288,6 +288,9 @@ public class BeanValidator {
         }
 
         ItemValidator itemValidator = makeItemValidator(annot);
+        if (itemValidator.isEmpty()) {
+            return true;
+        }
 
         return verCollection(result, fieldName, itemValidator, value);
     }
@@ -304,7 +307,7 @@ public class BeanValidator {
     public boolean verCollection(BeanValidationResult result, String fieldName, ValueValidator itemValidator,
                     Object value) {
 
-        if (!(value instanceof Collection) || itemValidator.isEmpty()) {
+        if (!(value instanceof Collection)) {
             return true;
         }
 
@@ -376,6 +379,62 @@ public class BeanValidator {
     }
 
     /**
+     * Validates the items in a Map.
+     *
+     * @param result where to add the validation result
+     * @param fieldName name of the field containing the map
+     * @param keyValidator validator for an individual key within the Map entry
+     * @param valueValidator validator for an individual value within the Map entry
+     * @param value value to be verified
+     * @return {@code true} if the next check should be performed, {@code false} otherwise
+     */
+    public boolean verMap(BeanValidationResult result, String fieldName, ValueValidator keyValidator,
+                    ValueValidator valueValidator, Object value) {
+
+        if (!(value instanceof Map)) {
+            return true;
+        }
+
+        Map<?, ?> map = (Map<?, ?>) value;
+
+        BeanValidationResult result2 = new BeanValidationResult(fieldName, value);
+
+        for (Entry<?, ?> entry : map.entrySet()) {
+            String name = getEntryName(entry);
+
+            BeanValidationResult result3 = new BeanValidationResult(name, entry);
+            keyValidator.validateValue(result3, "key", entry.getKey());
+            valueValidator.validateValue(result3, "value", entry.getValue());
+
+            if (!result3.isClean()) {
+                result2.addResult(result3);
+            }
+        }
+
+        if (result2.isClean()) {
+            return true;
+        }
+
+        result.addResult(result2);
+        return false;
+    }
+
+    /**
+     * Gets a name for an entry.
+     *
+     * @param entry entry whose name is to be determined
+     * @return a name for the entry
+     */
+    protected <K, V> String getEntryName(Map.Entry<K, V> entry) {
+        K key = entry.getKey();
+        if (key == null) {
+            return "";
+        }
+
+        return key.toString();
+    }
+
+    /**
      * Makes a field validator.
      *
      * @param clazz class containing the field
diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/FieldValidator.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/FieldValidator.java
index 249185c7..58f3e833 100644
--- a/common-parameters/src/main/java/org/onap/policy/common/parameters/FieldValidator.java
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/FieldValidator.java
@@ -21,10 +21,14 @@
 package org.onap.policy.common.parameters;
 
 import java.lang.annotation.Annotation;
+import java.lang.reflect.AnnotatedParameterizedType;
+import java.lang.reflect.AnnotatedType;
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
+import java.util.Collection;
+import java.util.Map;
 import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.Setter;
@@ -76,6 +80,8 @@ public class FieldValidator extends ValueValidator {
         }
 
         validator.addValidators(this);
+        addListValidator(validator);
+        addMapValidator(validator);
 
         if (checkers.isEmpty()) {
             // has no annotations - nothing to check
@@ -105,6 +111,65 @@ public class FieldValidator extends ValueValidator {
     }
 
     /**
+     * Adds validators for the individual items within a collection, if the field is a
+     * collection.
+     *
+     * @param validator provider of validation methods
+     */
+    private void addListValidator(BeanValidator validator) {
+        if (!Collection.class.isAssignableFrom(field.getType())) {
+            return;
+        }
+
+        AnnotatedType tannot = field.getAnnotatedType();
+        if (!(tannot instanceof AnnotatedParameterizedType)) {
+            return;
+        }
+
+        AnnotatedType[] targs = ((AnnotatedParameterizedType) tannot).getAnnotatedActualTypeArguments();
+        if (targs.length != 1) {
+            return;
+        }
+
+        Item2Validator itemValidator = new Item2Validator(validator, targs[0]);
+        if (itemValidator.isEmpty()) {
+            return;
+        }
+
+        checkers.add((result, fieldName, value) -> validator.verCollection(result, fieldName, itemValidator, value));
+    }
+
+    /**
+     * Adds validators for the individual entries within a map, if the field is a map.
+     *
+     * @param validator provider of validation methods
+     */
+    private void addMapValidator(BeanValidator validator) {
+        if (!Map.class.isAssignableFrom(field.getType())) {
+            return;
+        }
+
+        AnnotatedType tannot = field.getAnnotatedType();
+        if (!(tannot instanceof AnnotatedParameterizedType)) {
+            return;
+        }
+
+        AnnotatedType[] targs = ((AnnotatedParameterizedType) tannot).getAnnotatedActualTypeArguments();
+        if (targs.length != 2) {
+            return;
+        }
+
+        Item2Validator keyValidator = new Item2Validator(validator, targs[0]);
+        Item2Validator valueValidator = new Item2Validator(validator, targs[1]);
+        if (keyValidator.isEmpty() && valueValidator.isEmpty()) {
+            return;
+        }
+
+        checkers.add((result, fieldName, value) -> validator.verMap(result, fieldName, keyValidator, valueValidator,
+                        value));
+    }
+
+    /**
      * Performs validation of a single field.
      *
      * @param result validation results are added here
diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/Item2Validator.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/Item2Validator.java
new file mode 100644
index 00000000..c82244d6
--- /dev/null
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/Item2Validator.java
@@ -0,0 +1,71 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2021 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.common.parameters;
+
+import java.lang.annotation.Annotation;
+import java.lang.reflect.AnnotatedType;
+
+/**
+ * Validator of an "item", which is typically found in a collection, or the key or value
+ * components of an entry in a Map.
+ */
+public class Item2Validator extends ValueValidator {
+    private final AnnotatedType annotatedType;
+
+    /**
+     * Constructs the object.
+     *
+     * @param validator provider of validation methods
+     * @param annotatedType a type having validation annotations to be
+     *        applied to the item
+     */
+    public Item2Validator(BeanValidator validator, AnnotatedType annotatedType) {
+        this(validator, annotatedType, true);
+    }
+
+    /**
+     * Constructs the object.
+     *
+     * @param validator provider of validation methods
+     * @param annotatedType a type having validation annotations to be
+     *        applied to the item
+     * @param addValidators {@code true} if to add validators
+     */
+    public Item2Validator(BeanValidator validator, AnnotatedType annotatedType, boolean addValidators) {
+        this.annotatedType = annotatedType;
+
+        if (addValidators) {
+            validator.addValidators(this);
+        }
+    }
+
+    /**
+     * Gets an annotation from the field or the class.
+     *
+     * @param annotClass annotation class of interest
+     * @return the annotation, or {@code null} if the {@link #annotatedType} does
+     *         not contain the desired annotation
+     */
+    @Override
+    public <T extends Annotation> T getAnnotation(Class<T> annotClass) {
+        return annotatedType.getAnnotation(annotClass);
+    }
+}
diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Max.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Max.java
index 1d8fd90f..f28fd2cf 100644
--- a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Max.java
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Max.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP
  * ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019, 2021 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.
@@ -21,13 +21,14 @@
 package org.onap.policy.common.parameters.annotations;
 
 import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE_USE;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
 @Retention(RUNTIME)
-@Target(FIELD)
+@Target({FIELD, TYPE_USE})
 public @interface Max {
 
     /**
diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Min.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Min.java
index 9ad6d7e0..305d9810 100644
--- a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Min.java
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Min.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP
  * ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019, 2021 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.
@@ -21,13 +21,14 @@
 package org.onap.policy.common.parameters.annotations;
 
 import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE_USE;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
 @Retention(RUNTIME)
-@Target(FIELD)
+@Target({FIELD, TYPE_USE})
 public @interface Min {
 
     /**
diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/NotBlank.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/NotBlank.java
index 169fa593..0744beb5 100644
--- a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/NotBlank.java
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/NotBlank.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP
  * ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019, 2021 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.
@@ -22,6 +22,7 @@ package org.onap.policy.common.parameters.annotations;
 
 import static java.lang.annotation.ElementType.FIELD;
 import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.ElementType.TYPE_USE;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 import java.lang.annotation.Retention;
@@ -31,7 +32,7 @@ import java.lang.annotation.Target;
  * Indicates that a field (i.e., String) may not be empty.
  */
 @Retention(RUNTIME)
-@Target({TYPE, FIELD})
+@Target({TYPE, FIELD, TYPE_USE})
 public @interface NotBlank {
 
 }
diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/NotNull.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/NotNull.java
index 3c7bc8b7..81356005 100644
--- a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/NotNull.java
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/NotNull.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP
  * ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019, 2021 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.
@@ -22,6 +22,7 @@ package org.onap.policy.common.parameters.annotations;
 
 import static java.lang.annotation.ElementType.FIELD;
 import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.ElementType.TYPE_USE;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 import java.lang.annotation.Retention;
@@ -31,7 +32,7 @@ import java.lang.annotation.Target;
  * Indicates that a field may not be null.
  */
 @Retention(RUNTIME)
-@Target({TYPE, FIELD})
+@Target({TYPE, FIELD, TYPE_USE})
 public @interface NotNull {
 
 }
diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Pattern.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Pattern.java
index a30d814c..91a74d70 100644
--- a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Pattern.java
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Pattern.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP
  * ================================================================================
- * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2020-2021 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.
@@ -21,13 +21,14 @@
 package org.onap.policy.common.parameters.annotations;
 
 import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE_USE;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
 @Retention(RUNTIME)
-@Target(FIELD)
+@Target({FIELD, TYPE_USE})
 public @interface Pattern {
 
     /**
diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Valid.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Valid.java
index a3a1d59f..227a726f 100644
--- a/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Valid.java
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/annotations/Valid.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP
  * ================================================================================
- * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2020-2021 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.
@@ -22,13 +22,14 @@ package org.onap.policy.common.parameters.annotations;
 
 import static java.lang.annotation.ElementType.FIELD;
 import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.ElementType.TYPE_USE;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
 @Retention(RUNTIME)
-@Target({TYPE, FIELD})
+@Target({TYPE, FIELD, TYPE_USE})
 public @interface Valid {
 
 }