/* * ============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 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 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 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 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); } }