Move Validators and RestClientParameters in policy-common

Issue-ID: POLICY-3402
Change-Id: I7479027e3ea1e960266264c2d13cd69e2103710b
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>

diff --git a/common-parameters/pom.xml b/common-parameters/pom.xml
index 342cb98..b8b9354 100644 (file)
--- a/common-parameters/pom.xml
+++ b/common-parameters/pom.xml
@@ -72,5 +72,9 @@
             <artifactId>snakeyaml</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>jakarta.validation</groupId>
+            <artifactId>jakarta.validation-api</artifactId>
+        </dependency>
     </dependencies>
 </project>

diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/validation/ParameterGroupConstraint.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/validation/ParameterGroupConstraint.java
new file mode 100644 (file)
index 0000000..f6ad817
--- /dev/null
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/validation/ParameterGroupConstraint.java
@@ -0,0 +1,57 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2021 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.common.parameters.validation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import javax.validation.Constraint;
+import javax.validation.Payload;
+
+@Documented
+@Constraint(validatedBy = ParameterGroupValidator.class)
+@Target({ElementType.FIELD})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface ParameterGroupConstraint {
+
+    /**
+     * Get error Message.
+     *
+     * @return error Message
+     */
+    String message() default "validation error(s) on parameters";
+
+    /**
+     * Get groups.
+     *
+     * @return Class arrays
+     */
+    Class<?>[] groups() default {};
+
+    /**
+     * Get payload.
+     *
+     * @return Class arrays
+     */
+    Class<? extends Payload>[] payload() default {};
+}

diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/validation/ParameterGroupValidator.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/validation/ParameterGroupValidator.java
new file mode 100644 (file)
index 0000000..a50543c
--- /dev/null
+++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/validation/ParameterGroupValidator.java
@@ -0,0 +1,42 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2021 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.common.parameters.validation;
+
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+import org.onap.policy.common.parameters.BeanValidationResult;
+import org.onap.policy.common.parameters.ParameterGroup;
+
+public class ParameterGroupValidator implements ConstraintValidator<ParameterGroupConstraint, ParameterGroup> {
+
+    @Override
+    public boolean isValid(ParameterGroup value, ConstraintValidatorContext context) {
+        if (value == null) {
+            return true;
+        }
+        final BeanValidationResult result = value.validate();
+        if (!result.isValid()) {
+            context.buildConstraintViolationWithTemplate(result.getMessage()).addConstraintViolation();
+        }
+        return result.isValid();
+    }
+
+}

diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/RestClientParameters.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/RestClientParameters.java
new file mode 100644 (file)
index 0000000..e23b29e
--- /dev/null
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/RestClientParameters.java
@@ -0,0 +1,56 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2021 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.common.endpoints.parameters;
+
+import org.onap.policy.common.endpoints.event.comm.bus.internal.BusTopicParams;
+import org.onap.policy.common.parameters.BeanValidationResult;
+import org.onap.policy.common.parameters.ParameterGroup;
+import org.onap.policy.common.parameters.ValidationStatus;
+
+public class RestClientParameters extends BusTopicParams implements ParameterGroup {
+
+    private static final String MSG_IS_BLANK = "is blank";
+
+    @Override
+    public String getName() {
+        return getClientName();
+    }
+
+    @Override
+    public void setName(String name) {
+        setClientName(name);
+    }
+
+    @Override
+    public BeanValidationResult validate() {
+        BeanValidationResult result = new BeanValidationResult(getClientName(), this);
+        if (isHostnameInvalid()) {
+            result.addResult("hostname", getHostname(), ValidationStatus.INVALID, MSG_IS_BLANK);
+        }
+        if (isClientNameInvalid()) {
+            result.addResult("clientName", getClientName(), ValidationStatus.INVALID, MSG_IS_BLANK);
+        }
+        if (isPortInvalid()) {
+            result.addResult("port", getPort(), ValidationStatus.INVALID, "is not valid");
+        }
+        return result;
+    }
+}