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
9 * 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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.ncmp.api.impl.utils;
23 import static org.onap.cps.ncmp.api.impl.operations.RequiredDmiService.DATA;
25 import java.util.HashMap;
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.NcmpConfiguration;
31 import org.onap.cps.ncmp.api.impl.operations.DmiOperations;
32 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
33 import org.onap.cps.utils.CpsValidator;
34 import org.springframework.stereotype.Component;
35 import org.springframework.util.LinkedMultiValueMap;
36 import org.springframework.util.MultiValueMap;
37 import org.springframework.web.util.UriComponentsBuilder;
40 @RequiredArgsConstructor
41 public class DmiServiceUrlBuilder {
43 private final NcmpConfiguration.DmiProperties dmiProperties;
46 * This method creates the dmi service url.
48 * @param queryParams query param map as key,value pair
49 * @param uriVariables uri param map as key (placeholder),value pair
50 * @return {@code String} dmi service url as string
52 public String getDmiDatastoreUrl(final MultiValueMap<String, String> queryParams,
53 final Map<String, Object> uriVariables) {
54 final UriComponentsBuilder uriComponentsBuilder = getCmHandleUrl()
57 .pathSegment("{dataStore}")
58 .queryParams(queryParams)
59 .uriVariables(uriVariables);
60 return uriComponentsBuilder.buildAndExpand().toUriString();
64 * This method creates the dmi service url builder object with path variables.
66 * @return {@code UriComponentsBuilder} dmi service url builder object
68 public UriComponentsBuilder getCmHandleUrl() {
69 return UriComponentsBuilder.newInstance()
70 .path("{dmiServiceName}")
71 .pathSegment("{dmiBasePath}")
74 .pathSegment("{cmHandleId}");
78 * This method populates uri variables.
80 * @param yangModelCmHandle get dmi service name
81 * @param cmHandleId cm handle id for dmi registration
82 * @return {@code String} dmi service url as string
84 public Map<String, Object> populateUriVariables(final YangModelCmHandle yangModelCmHandle,
85 final String cmHandleId,
86 final DmiOperations.DataStoreEnum dataStore) {
87 CpsValidator.validateNameCharacters(cmHandleId);
88 final Map<String, Object> uriVariables = new HashMap<>();
89 final String dmiBasePath = dmiProperties.getDmiBasePath();
90 uriVariables.put("dmiServiceName",
91 yangModelCmHandle.resolveDmiServiceName(DATA));
92 uriVariables.put("dmiBasePath", dmiBasePath);
93 uriVariables.put("cmHandleId", cmHandleId);
94 uriVariables.put("dataStore", dataStore.getValue());
99 * This method is used to populate map from query params.
101 * @param resourceId unique id of response for valid topic
102 * @param optionsParamInQuery options into url param
103 * @param topicParamInQuery topic into url param
104 * @return all valid query params as map
106 public MultiValueMap<String, String> populateQueryParams(final String resourceId,
107 final String optionsParamInQuery,
108 final String topicParamInQuery) {
109 final MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>();
110 getQueryParamConsumer().accept("resourceIdentifier",
111 resourceId, queryParams);
112 getQueryParamConsumer().accept("options", optionsParamInQuery, queryParams);
113 if (Strings.isNotEmpty(topicParamInQuery)) {
114 getQueryParamConsumer().accept("topic", topicParamInQuery, queryParams);
119 private TriConsumer<String, String, MultiValueMap<String, String>> getQueryParamConsumer() {
120 return (paramName, paramValue, paramMap) -> {
121 if (Strings.isNotEmpty(paramValue)) {
122 paramMap.add(paramName, paramValue);