cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/utils/DmiServiceUrlBuilder.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022-2023 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.ncmp.api.impl.utils;
  22
  23 import java.net.URLEncoder;
  24 import java.nio.charset.StandardCharsets;
  25 import java.util.HashMap;
  26 import java.util.Map;
  27 import lombok.RequiredArgsConstructor;
  28 import org.apache.logging.log4j.util.Strings;
  29 import org.apache.logging.log4j.util.TriConsumer;
  30 import org.onap.cps.ncmp.api.impl.config.DmiWebClientConfiguration.DmiProperties;
  31 import org.onap.cps.spi.utils.CpsValidator;
  32 import org.springframework.stereotype.Component;
  33 import org.springframework.util.LinkedMultiValueMap;
  34 import org.springframework.util.MultiValueMap;
  35 import org.springframework.web.util.UriComponentsBuilder;
  36
  37 @Component
  38 @RequiredArgsConstructor
  39 public class DmiServiceUrlBuilder {
  40     private final DmiProperties dmiProperties;
  41     private final CpsValidator cpsValidator;
  42
  43     /**
  44      * This method creates the dmi service url.
  45      *
  46      * @param queryParams  query param map as key,value pair
  47      * @param uriVariables uri param map as key (placeholder),value pair
  48      * @return {@code String} dmi service url as string
  49      */
  50     public String getDmiDatastoreUrl(final MultiValueMap<String, String> queryParams,
  51                                      final Map<String, Object> uriVariables) {
  52         return getUriComponentsBuilder(getResourceDataBasePathUriBuilder(), queryParams, uriVariables)
  53                 .buildAndExpand().toUriString();
  54     }
  55
  56     /**
  57      * This method builds data operation request url.
  58      *
  59      * @param dataoperationRequestQueryParams  query param map as key, value pair
  60      * @param dataoperationRequestUriVariables uri param map as key (placeholder), value pair
  61      * @return {@code String} data operation request url as string
  62      */
  63     public String getDataOperationRequestUrl(final MultiValueMap<String, String> dataoperationRequestQueryParams,
  64                                              final Map<String, Object> dataoperationRequestUriVariables) {
  65         return getDataOperationResourceDataBasePathUriBuilder()
  66                 .queryParams(dataoperationRequestQueryParams)
  67                 .uriVariables(dataoperationRequestUriVariables)
  68                 .buildAndExpand().toUriString();
  69     }
  70
  71     /**
  72      * This method creates the dmi service url builder object with path variables.
  73      *
  74      * @return {@code UriComponentsBuilder} dmi service url builder object
  75      */
  76     public UriComponentsBuilder getResourceDataBasePathUriBuilder() {
  77         return UriComponentsBuilder.newInstance()
  78                 .path("{dmiServiceName}")
  79                 .pathSegment("{dmiBasePath}")
  80                 .pathSegment("v1")
  81                 .pathSegment("ch")
  82                 .pathSegment("{cmHandleId}");
  83     }
  84
  85     /**
  86      * This method creates the dmi service url builder object with path variables for data operation request.
  87      *
  88      * @return {@code UriComponentsBuilder} dmi service url builder object
  89      */
  90     public UriComponentsBuilder getDataOperationResourceDataBasePathUriBuilder() {
  91         return UriComponentsBuilder.newInstance()
  92                 .path("{dmiServiceName}")
  93                 .pathSegment("{dmiBasePath}")
  94                 .pathSegment("v1")
  95                 .pathSegment("data");
  96     }
  97
  98     /**
  99      * This method populates uri variables.
 100      *
 101      * @param dataStoreName data store name
 102      * @param dmiServiceName dmi service name
 103      * @param cmHandleId        cm handle id for dmi registration
 104      * @return {@code String} dmi service url as string
 105      */
 106     public Map<String, Object> populateUriVariables(final String dataStoreName,
 107                                                     final String dmiServiceName,
 108                                                     final String cmHandleId) {
 109         cpsValidator.validateNameCharacters(cmHandleId);
 110         final Map<String, Object> uriVariables = new HashMap<>();
 111         final String dmiBasePath = dmiProperties.getDmiBasePath();
 112         uriVariables.put("dmiServiceName", dmiServiceName);
 113         uriVariables.put("dmiBasePath", dmiBasePath);
 114         uriVariables.put("cmHandleId", cmHandleId);
 115         uriVariables.put("dataStore", dataStoreName);
 116         return uriVariables;
 117     }
 118
 119     /**
 120      * This method populates uri variables for data operation request.
 121      *
 122      * @param dmiServiceName dmi service name
 123      * @return {@code Map<String, Object>} uri variables as map
 124      */
 125     public Map<String, Object> populateDataOperationRequestUriVariables(final String dmiServiceName) {
 126         final Map<String, Object> uriVariables = new HashMap<>();
 127         final String dmiBasePath = dmiProperties.getDmiBasePath();
 128         uriVariables.put("dmiServiceName", dmiServiceName);
 129         uriVariables.put("dmiBasePath", dmiBasePath);
 130         return uriVariables;
 131     }
 132
 133     /**
 134      * This method is used to populate map from query params.
 135      *
 136      * @param resourceId          unique id of response for valid topic
 137      * @param optionsParamInQuery options into url param
 138      * @param topicParamInQuery   topic into url param
 139      * @return all valid query params as map
 140      */
 141     public MultiValueMap<String, String> populateQueryParams(final String resourceId,
 142                                                              final String optionsParamInQuery,
 143                                                              final String topicParamInQuery) {
 144         final MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>();
 145         getQueryParamConsumer().accept("resourceIdentifier", resourceId, queryParams);
 146         getQueryParamConsumer().accept("options", optionsParamInQuery, queryParams);
 147         if (Strings.isNotEmpty(topicParamInQuery)) {
 148             getQueryParamConsumer().accept("topic", topicParamInQuery, queryParams);
 149         }
 150         return queryParams;
 151     }
 152
 153     /**
 154      * This method is used to populate map from query params for data operation request.
 155      *
 156      * @param topicParamInQuery topic into url param
 157      * @param requestId         unique id of response for valid topic
 158      * @return all valid query params as map
 159      */
 160     public MultiValueMap<String, String> getDataOperationRequestQueryParams(final String topicParamInQuery,
 161                                                                             final String requestId) {
 162         final MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>();
 163         getQueryParamConsumer().accept("topic", topicParamInQuery, queryParams);
 164         getQueryParamConsumer().accept("requestId", requestId, queryParams);
 165         return queryParams;
 166     }
 167
 168     private TriConsumer<String, String, MultiValueMap<String, String>> getQueryParamConsumer() {
 169         return (paramName, paramValue, paramMap) -> {
 170             if (Strings.isNotEmpty(paramValue)) {
 171                 paramMap.add(paramName, URLEncoder.encode(paramValue, StandardCharsets.UTF_8));
 172             }
 173         };
 174     }
 175
 176     private UriComponentsBuilder getUriComponentsBuilder(final UriComponentsBuilder uriComponentsBuilder,
 177                                                          final MultiValueMap<String, String> queryParams,
 178                                                          final Map<String, Object> uriVariables) {
 179         return uriComponentsBuilder
 180                 .pathSegment("data")
 181                 .pathSegment("ds")
 182                 .pathSegment("{dataStore}")
 183                 .queryParams(queryParams)
 184                 .uriVariables(uriVariables);
 185     }
 186 }