2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022 Nordix Foundation
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.utils;
23 import com.google.common.base.Strings;
24 import java.util.Arrays;
26 import lombok.AccessLevel;
27 import lombok.NoArgsConstructor;
28 import lombok.extern.slf4j.Slf4j;
29 import org.onap.cps.spi.exceptions.DataValidationException;
30 import org.onap.cps.spi.model.CmHandleQueryServiceParameters;
33 @NoArgsConstructor(access = AccessLevel.PRIVATE)
34 public class CmHandleQueryRestParametersValidator {
37 * Validate cm handle query parameters.
38 * @param cmHandleQueryServiceParameters name of data to be validated
40 public static void validateCmHandleQueryParameters(
41 final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
42 cmHandleQueryServiceParameters.getCmHandleQueryParameters().forEach(
43 conditionApiProperty -> {
44 if (Strings.isNullOrEmpty(conditionApiProperty.getConditionName())) {
45 throw createDataValidationException("Missing 'conditionName' - please supply a valid name.");
47 if (Arrays.stream(ValidQueryProperties.values()).noneMatch(validQueryProperty ->
48 validQueryProperty.getQueryProperty().equals(conditionApiProperty.getConditionName()))) {
49 throw createDataValidationException(
50 String.format("Wrong 'conditionName': %s - please supply a valid name.",
51 conditionApiProperty.getConditionName()));
53 if (conditionApiProperty.getConditionParameters().isEmpty()) {
54 throw createDataValidationException(
55 "Empty 'conditionsParameters' - please supply a valid condition parameter.");
57 conditionApiProperty.getConditionParameters().forEach(
58 CmHandleQueryRestParametersValidator::validateConditionParameter
64 private static void validateConditionParameter(final Map<String, String> conditionParameter) {
65 if (conditionParameter.isEmpty()) {
66 throw createDataValidationException(
67 "Empty 'conditionsParameter' - please supply a valid condition parameter.");
69 if (conditionParameter.size() > 1) {
70 throw createDataValidationException("Too many name in one 'conditionsParameter' -"
71 + " please supply one name in one condition parameter.");
73 conditionParameter.forEach((key, value) -> {
74 if (Strings.isNullOrEmpty(key)) {
75 throw createDataValidationException(
76 "Missing 'conditionsParameterName' - please supply a valid name.");
82 * Validate module name condition properties.
83 * @param conditionProperty name of data to be validated
85 public static void validateModuleNameConditionProperties(final Map<String, String> conditionProperty) {
86 if (conditionProperty.containsKey("moduleName") && !conditionProperty.get("moduleName").isEmpty()) {
89 throw createDataValidationException("Wrong module condition property. - "
90 + "please supply a valid condition property.");
94 * Validate CPS path condition properties.
95 * @param conditionProperty name of data to be validated
97 public static boolean validateCpsPathConditionProperties(final Map<String, String> conditionProperty) {
98 if (conditionProperty.isEmpty()) {
101 if (conditionProperty.size() > 1) {
102 throw createDataValidationException("Only one condition property is allowed for the CPS path query.");
104 if (!conditionProperty.containsKey("cpsPath")) {
105 throw createDataValidationException(
106 "Wrong CPS path condition property. - expecting \"cpsPath\" as the condition property.");
108 final String cpsPath = conditionProperty.get("cpsPath");
109 if (cpsPath.isBlank()) {
110 throw createDataValidationException(
111 "Wrong CPS path. - please supply a valid CPS path.");
113 if (cpsPath.contains("/additional-properties")) {
114 log.debug("{} - Private metadata cannot be queried. Nothing to be returned",
121 private static DataValidationException createDataValidationException(final String details) {
122 return new DataValidationException("Invalid Query Parameter.", details);