summaryrefslogtreecommitdiffstats
path: root/cps-service/src/main
diff options
context:
space:
mode:
authorleventecsanyi <levente.csanyi@est.tech>2022-10-26 10:44:08 +0200
committerleventecsanyi <levente.csanyi@est.tech>2022-12-01 21:32:44 +0100
commit37d72855721caa646144ad323fe51ae78af15507 (patch)
tree0d4494c83572f779aded34a7de3b03774c19873c /cps-service/src/main
parent94d77dd3430bf504b1fe1209760cfeedb47752a7 (diff)
Filter on private properties of CM Handles
- Moved cm handle query validation to cps-ncmp-service (where it belongs!) - Added new enum type for private/public field types - Created new methods for private and public queries - Added new REST endpoint - Created service methods for filtering on different types of properties - Refactored getPublicPropertyPairs and queryCmHandleAnyProperties - Added unit test for the controller layer - Fixed refactoring suggestions - Imporved code coverage with unit tests - Refactoring - Added new functionality to NcmpRestInputMapper - Updated version number to 3.2.1-SNAPSHOT and updated release-notes.rst Issue-ID: CPS-1236 Change-Id: I0ddf6866473f7c3c6b8507d222d441bf97ca6bdc Signed-off-by: leventecsanyi <levente.csanyi@est.tech>
Diffstat (limited to 'cps-service/src/main')
-rw-r--r--cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java41
-rw-r--r--cps-service/src/main/java/org/onap/cps/utils/CmHandleQueryRestParametersValidator.java125
-rw-r--r--cps-service/src/main/java/org/onap/cps/utils/ValidQueryProperties.java36
3 files changed, 0 insertions, 202 deletions
diff --git a/cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java b/cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java
deleted file mode 100644
index 8dcf88b0eb..0000000000
--- a/cps-service/src/main/java/org/onap/cps/spi/model/CmHandleQueryServiceParameters.java
+++ /dev/null
@@ -1,41 +0,0 @@
-/*
- * ============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.spi.model;
-
-import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.annotation.JsonInclude.Include;
-import com.fasterxml.jackson.annotation.JsonProperty;
-import java.util.Collections;
-import java.util.List;
-import javax.validation.Valid;
-import lombok.EqualsAndHashCode;
-import lombok.Getter;
-import lombok.Setter;
-
-@Setter
-@Getter
-@EqualsAndHashCode
-@JsonInclude(Include.NON_EMPTY)
-public class CmHandleQueryServiceParameters {
- @JsonProperty("cmHandleQueryParameters")
- @Valid
- private List<ConditionProperties> cmHandleQueryParameters = Collections.emptyList();
-}
diff --git a/cps-service/src/main/java/org/onap/cps/utils/CmHandleQueryRestParametersValidator.java b/cps-service/src/main/java/org/onap/cps/utils/CmHandleQueryRestParametersValidator.java
deleted file mode 100644
index 4d0eb7d412..0000000000
--- a/cps-service/src/main/java/org/onap/cps/utils/CmHandleQueryRestParametersValidator.java
+++ /dev/null
@@ -1,125 +0,0 @@
-/*
- * ============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.utils;
-
-import com.google.common.base.Strings;
-import java.util.Arrays;
-import java.util.Map;
-import lombok.AccessLevel;
-import lombok.NoArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
-import org.onap.cps.spi.exceptions.DataValidationException;
-import org.onap.cps.spi.model.CmHandleQueryServiceParameters;
-
-@Slf4j
-@NoArgsConstructor(access = AccessLevel.PRIVATE)
-public class CmHandleQueryRestParametersValidator {
-
- /**
- * Validate cm handle query parameters.
- * @param cmHandleQueryServiceParameters name of data to be validated
- */
- public static void validateCmHandleQueryParameters(
- final CmHandleQueryServiceParameters cmHandleQueryServiceParameters) {
- cmHandleQueryServiceParameters.getCmHandleQueryParameters().forEach(
- conditionApiProperty -> {
- if (Strings.isNullOrEmpty(conditionApiProperty.getConditionName())) {
- throw createDataValidationException("Missing 'conditionName' - please supply a valid name.");
- }
- if (Arrays.stream(ValidQueryProperties.values()).noneMatch(validQueryProperty ->
- validQueryProperty.getQueryProperty().equals(conditionApiProperty.getConditionName()))) {
- throw createDataValidationException(
- String.format("Wrong 'conditionName': %s - please supply a valid name.",
- conditionApiProperty.getConditionName()));
- }
- if (conditionApiProperty.getConditionParameters().isEmpty()) {
- throw createDataValidationException(
- "Empty 'conditionsParameters' - please supply a valid condition parameter.");
- }
- conditionApiProperty.getConditionParameters().forEach(
- CmHandleQueryRestParametersValidator::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 name 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);
- }
-
-}
diff --git a/cps-service/src/main/java/org/onap/cps/utils/ValidQueryProperties.java b/cps-service/src/main/java/org/onap/cps/utils/ValidQueryProperties.java
deleted file mode 100644
index 1d7ccb91df..0000000000
--- a/cps-service/src/main/java/org/onap/cps/utils/ValidQueryProperties.java
+++ /dev/null
@@ -1,36 +0,0 @@
-/*
- * ============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.utils;
-
-import lombok.Getter;
-
-@Getter
-public enum ValidQueryProperties {
- HAS_ALL_PROPERTIES("hasAllProperties"),
- HAS_ALL_MODULES("hasAllModules"),
- WITH_CPS_PATH("cmHandleWithCpsPath");
-
- private final String queryProperty;
-
- ValidQueryProperties(final String queryProperty) {
- this.queryProperty = queryProperty;
- }
-}