cps-ri/src/main/java/org/onap/cps/spi/query/CpsPathQuery.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Nordix Foundation
   4  *  Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        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.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.spi.query;
  22
  23 import java.util.regex.Matcher;
  24 import java.util.regex.Pattern;
  25 import lombok.AccessLevel;
  26 import lombok.Getter;
  27 import lombok.Setter;
  28 import org.onap.cps.spi.exceptions.CpsPathException;
  29
  30 @Getter
  31 @Setter(AccessLevel.PRIVATE)
  32 public class CpsPathQuery {
  33
  34     private CpsPathQueryType cpsPathQueryType;
  35     private String xpathPrefix;
  36     private String leafName;
  37     private Object leafValue;
  38     private String endsWith;
  39
  40     private static final String NON_CAPTURING_GROUP_1_TO_99_YANG_CONTAINERS = "((?:\\/[^\\/]+){1,99})";
  41
  42     private static final String YANG_LEAF_VALUE_EQUALS_CONDITION = "\\[\\s*@(\\S+?)\\s*=\\s*(.*?)\\s*\\]";
  43
  44     private static final Pattern QUERY_CPS_PATH_WITH_SINGLE_LEAF_PATTERN =
  45         Pattern.compile(NON_CAPTURING_GROUP_1_TO_99_YANG_CONTAINERS + YANG_LEAF_VALUE_EQUALS_CONDITION);
  46
  47     private static final Pattern QUERY_CPS_PATH_ENDS_WITH_PATTERN = Pattern.compile("\\/\\/(.+)");
  48
  49     private static final Pattern LEAF_INTEGER_VALUE_PATTERN = Pattern.compile("[-+]?\\d+");
  50
  51     private static final Pattern LEAF_STRING_VALUE_PATTERN = Pattern.compile("['\"](.*)['\"]");
  52
  53     /**
  54      * Returns a cps path query.
  55      *
  56      * @param cpsPath cps path
  57      * @return a CpsPath object.
  58      */
  59     public static CpsPathQuery createFrom(final String cpsPath) {
  60         Matcher matcher = QUERY_CPS_PATH_WITH_SINGLE_LEAF_PATTERN.matcher(cpsPath);
  61         final CpsPathQuery cpsPathQuery = new CpsPathQuery();
  62         if (matcher.matches()) {
  63             cpsPathQuery.setCpsPathQueryType(CpsPathQueryType.XPATH_LEAF_VALUE);
  64             cpsPathQuery.setXpathPrefix(matcher.group(1));
  65             cpsPathQuery.setLeafName(matcher.group(2));
  66             cpsPathQuery.setLeafValue(convertLeafValueToCorrectType(matcher.group(3), cpsPath));
  67             return cpsPathQuery;
  68         }
  69         matcher = QUERY_CPS_PATH_ENDS_WITH_PATTERN.matcher(cpsPath);
  70         if (matcher.matches()) {
  71             cpsPathQuery.setCpsPathQueryType(CpsPathQueryType.XPATH_ENDS_WITH);
  72             cpsPathQuery.setEndsWith(matcher.group(1));
  73             return cpsPathQuery;
  74         }
  75         throw new CpsPathException("Invalid cps path.",
  76             String.format("Cannot interpret or parse cps path '%s'.", cpsPath));
  77     }
  78
  79     private static Object convertLeafValueToCorrectType(final String leafValueString, final String cpsPath) {
  80         final Matcher stringValueWithQuotesMatcher = LEAF_STRING_VALUE_PATTERN.matcher(leafValueString);
  81         if (stringValueWithQuotesMatcher.matches()) {
  82             return stringValueWithQuotesMatcher.group(1);
  83         }
  84         final Matcher integerValueMatcher = LEAF_INTEGER_VALUE_PATTERN.matcher(leafValueString);
  85         if (integerValueMatcher.matches()) {
  86             return Integer.valueOf(leafValueString);
  87         }
  88         throw new CpsPathException("Unsupported leaf value.",
  89             String.format("Unsupported leaf value '%s' in cps path '%s'.", leafValueString, cpsPath));
  90     }
  91 }