1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2022 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.cps.ncmp.api.impl.utils;
import com.google.common.base.Strings;
import java.util.Collection;
import java.util.Map;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
import org.onap.cps.spi.exceptions.DataValidationException;
@Slf4j
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class RestQueryParametersValidator {
/**
* Validate query parameters.
*
* @param cmHandleQueryServiceParameters name of data to be validated
* @param validConditionNames valid condition names
*/
public static void validateCmHandleQueryParameters(
final CmHandleQueryServiceParameters cmHandleQueryServiceParameters,
final Collection<String> validConditionNames) {
cmHandleQueryServiceParameters.getCmHandleQueryParameters().forEach(
cmHandleQueryParameter -> {
if (validConditionNames.stream().noneMatch(validConditionName ->
validConditionName.equals(cmHandleQueryParameter.getConditionName()))) {
throw createDataValidationException(
String.format("Wrong 'conditionName': %s - please supply a valid name.",
cmHandleQueryParameter.getConditionName()));
}
if (cmHandleQueryParameter.getConditionParameters().isEmpty()) {
throw createDataValidationException(
"Empty 'conditionsParameters' - please supply a valid condition parameter.");
}
cmHandleQueryParameter.getConditionParameters().forEach(
RestQueryParametersValidator::validateConditionParameter
);
}
);
}
private static void validateConditionParameter(final Map<String, String> conditionParameter) {
if (conditionParameter.isEmpty()) {
throw createDataValidationException(
"Empty 'conditionsParameter' - please supply a valid condition parameter.");
}
if (conditionParameter.size() > 1) {
throw createDataValidationException("Too many names in one 'conditionsParameter' -"
+ " please supply one name in one condition parameter.");
}
conditionParameter.forEach((key, value) -> {
if (Strings.isNullOrEmpty(key)) {
throw createDataValidationException(
"Missing 'conditionsParameterName' - please supply a valid name.");
}
});
}
/**
* Validate module name condition properties.
* @param conditionProperty name of data to be validated
*/
public static void validateModuleNameConditionProperties(final Map<String, String> conditionProperty) {
if (conditionProperty.containsKey("moduleName") && !conditionProperty.get("moduleName").isEmpty()) {
return;
}
throw createDataValidationException("Wrong module condition property. - "
+ "please supply a valid condition property.");
}
/**
* Validate CPS path condition properties.
* @param conditionProperty name of data to be validated
*/
public static boolean validateCpsPathConditionProperties(final Map<String, String> conditionProperty) {
if (conditionProperty.isEmpty()) {
return true;
}
if (conditionProperty.size() > 1) {
throw createDataValidationException("Only one condition property is allowed for the CPS path query.");
}
if (!conditionProperty.containsKey("cpsPath")) {
throw createDataValidationException(
"Wrong CPS path condition property. - expecting \"cpsPath\" as the condition property.");
}
final String cpsPath = conditionProperty.get("cpsPath");
if (cpsPath.isBlank()) {
throw createDataValidationException(
"Wrong CPS path. - please supply a valid CPS path.");
}
if (cpsPath.contains("/additional-properties")) {
log.debug("{} - Private metadata cannot be queried. Nothing to be returned",
cpsPath);
return false;
}
return true;
}
private static DataValidationException createDataValidationException(final String details) {
return new DataValidationException("Invalid Query Parameter.", details);
}
}
|