cps-service/src/main/java/org/onap/cps/utils/CpsValidator.java

   1 /*
   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
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.utils;
  22
  23 import com.google.common.collect.Lists;
  24 import java.util.Collection;
  25 import java.util.regex.Pattern;
  26 import lombok.AccessLevel;
  27 import lombok.NoArgsConstructor;
  28 import lombok.extern.slf4j.Slf4j;
  29 import org.onap.cps.spi.exceptions.DataValidationException;
  30
  31 @Slf4j
  32 @NoArgsConstructor(access = AccessLevel.PRIVATE)
  33 public final class CpsValidator {
  34
  35     private static final char[] UNSUPPORTED_NAME_CHARACTERS = "!\" #$%&'()*+,./\\:;<=>?@[]^`{|}~".toCharArray();
  36     private static final Pattern TOPIC_NAME_PATTERN = Pattern.compile("^[a-zA-Z0-9]([._-](?![._-])|"
  37             + "[a-zA-Z0-9]){0,120}[a-zA-Z0-9]$");
  38
  39     /**
  40      * Validate characters in names within cps.
  41      * @param names names of data to be validated
  42      */
  43     public static void validateNameCharacters(final String... names) {
  44         for (final String name : names) {
  45             final  Collection<Character> charactersOfName = Lists.charactersOf(name);
  46             for (final char unsupportedCharacter : UNSUPPORTED_NAME_CHARACTERS) {
  47                 if (charactersOfName.contains(unsupportedCharacter)) {
  48                     throw new DataValidationException("Name or ID Validation Error.",
  49                         name + " invalid token encountered at position " + (name.indexOf(unsupportedCharacter) + 1));
  50                 }
  51             }
  52         }
  53     }
  54
  55     /**
  56      * Validate kafka topic name pattern.
  57      * @param topicName name of the topic to be validated
  58      */
  59     public static boolean validateTopicName(final String topicName) {
  60         return topicName != null && TOPIC_NAME_PATTERN.matcher(topicName).matches();
  61     }
  62 }