2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 highstreet technologies GmbH
4 * Modifications Copyright (C) 2021-2022 Nordix Foundation
5 * Modifications Copyright (C) 2021 Pantheon.tech
6 * Modifications Copyright (C) 2021-2022 Bell Canada
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.cps.ncmp.api.impl;
26 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DATASPACE_NAME;
27 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_ANCHOR;
28 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_PARENT;
29 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
30 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NO_TIMESTAMP;
31 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
32 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED;
34 import com.fasterxml.jackson.core.JsonProcessingException;
35 import java.util.ArrayList;
36 import java.util.Collection;
37 import java.util.HashMap;
38 import java.util.LinkedHashMap;
39 import java.util.List;
41 import java.util.UUID;
42 import java.util.regex.Pattern;
43 import java.util.stream.Collectors;
44 import lombok.RequiredArgsConstructor;
45 import lombok.extern.slf4j.Slf4j;
46 import org.onap.cps.api.CpsAdminService;
47 import org.onap.cps.api.CpsDataService;
48 import org.onap.cps.api.CpsModuleService;
49 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
50 import org.onap.cps.ncmp.api.impl.exception.HttpClientRequestException;
51 import org.onap.cps.ncmp.api.impl.exception.InvalidTopicException;
52 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations;
53 import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations;
54 import org.onap.cps.ncmp.api.impl.operations.DmiOperations;
55 import org.onap.cps.ncmp.api.impl.operations.YangModelCmHandleRetriever;
56 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
57 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandlesList;
58 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse;
59 import org.onap.cps.ncmp.api.models.CmHandleRegistrationResponse.RegistrationError;
60 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
61 import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
62 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
63 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
64 import org.onap.cps.spi.exceptions.DataValidationException;
65 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
66 import org.onap.cps.spi.model.ModuleReference;
67 import org.onap.cps.utils.JsonObjectMapper;
68 import org.springframework.http.HttpStatus;
69 import org.springframework.http.ResponseEntity;
70 import org.springframework.stereotype.Service;
74 @RequiredArgsConstructor
75 public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
77 private final CpsDataService cpsDataService;
79 private final JsonObjectMapper jsonObjectMapper;
81 private final DmiDataOperations dmiDataOperations;
83 private final DmiModelOperations dmiModelOperations;
85 private final CpsModuleService cpsModuleService;
87 private final CpsAdminService cpsAdminService;
89 private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler;
91 private final YangModelCmHandleRetriever yangModelCmHandleRetriever;
93 // valid kafka topic name regex
94 private static final Pattern TOPIC_NAME_PATTERN = Pattern.compile("^[a-zA-Z0-9]([._-](?![._-])|"
95 + "[a-zA-Z0-9]){0,120}[a-zA-Z0-9]$");
96 private static final String NO_REQUEST_ID = null;
97 private static final String NO_TOPIC = null;
100 public DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(
101 final DmiPluginRegistration dmiPluginRegistration) {
102 dmiPluginRegistration.validateDmiPluginRegistration();
103 final var dmiPluginRegistrationResponse = new DmiPluginRegistrationResponse();
105 dmiPluginRegistrationResponse.setRemovedCmHandles(
106 parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration.getRemovedCmHandles()));
107 if (!dmiPluginRegistration.getCreatedCmHandles().isEmpty()) {
108 parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(dmiPluginRegistration);
110 if (!dmiPluginRegistration.getUpdatedCmHandles().isEmpty()) {
111 dmiPluginRegistrationResponse.setUpdatedCmHandles(
112 networkCmProxyDataServicePropertyHandler
113 .updateCmHandleProperties(dmiPluginRegistration.getUpdatedCmHandles()));
115 } catch (final JsonProcessingException | DataNodeNotFoundException e) {
116 final String errorMessage = String.format(
117 "Error occurred while processing the CM-handle registration request, caused by : [%s]",
119 throw new DataValidationException(errorMessage, e.getMessage(), e);
121 return dmiPluginRegistrationResponse;
125 public Object getResourceDataOperationalForCmHandle(final String cmHandleId,
126 final String resourceIdentifier,
127 final String acceptParamInHeader,
128 final String optionsParamInQuery,
129 final String topicParamInQuery) {
131 return validateTopicNameAndGetResourceData(cmHandleId, resourceIdentifier, acceptParamInHeader,
132 DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL, optionsParamInQuery, topicParamInQuery);
136 public Object getResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
137 final String resourceIdentifier,
138 final String acceptParamInHeader,
139 final String optionsParamInQuery,
140 final String topicParamInQuery) {
141 return validateTopicNameAndGetResourceData(cmHandleId, resourceIdentifier, acceptParamInHeader,
142 DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING, optionsParamInQuery, topicParamInQuery);
146 public Object writeResourceDataPassThroughRunningForCmHandle(final String cmHandleId,
147 final String resourceIdentifier,
148 final OperationEnum operation,
149 final String requestData,
150 final String dataType) {
151 return handleResponse(
152 dmiDataOperations.writeResourceDataPassThroughRunningFromDmi(cmHandleId, resourceIdentifier, operation,
153 requestData, dataType), operation);
158 public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
159 return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
163 * Retrieve cm handle identifiers for the given list of module names.
165 * @param moduleNames module names.
166 * @return a collection of anchor identifiers
169 public Collection<String> executeCmHandleHasAllModulesSearch(final Collection<String> moduleNames) {
170 return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNames);
174 * Retrieve cm handle details for a given cm handle.
176 * @param cmHandleId cm handle identifier
177 * @return cm handle details
180 public NcmpServiceCmHandle getNcmpServiceCmHandle(final String cmHandleId) {
181 final NcmpServiceCmHandle ncmpServiceCmHandle = new NcmpServiceCmHandle();
182 final YangModelCmHandle yangModelCmHandle =
183 yangModelCmHandleRetriever.getDmiServiceNamesAndProperties(cmHandleId);
184 final List<YangModelCmHandle.Property> dmiProperties = yangModelCmHandle.getDmiProperties();
185 final List<YangModelCmHandle.Property> publicProperties = yangModelCmHandle.getPublicProperties();
186 ncmpServiceCmHandle.setCmHandleID(yangModelCmHandle.getId());
187 setDmiProperties(dmiProperties, ncmpServiceCmHandle);
188 setPublicProperties(publicProperties, ncmpServiceCmHandle);
189 return ncmpServiceCmHandle;
192 private void setDmiProperties(final List<YangModelCmHandle.Property> dmiProperties,
193 final NcmpServiceCmHandle ncmpServiceCmHandle) {
194 final Map<String, String> dmiPropertiesMap = new LinkedHashMap<>(dmiProperties.size());
195 asPropertiesMap(dmiProperties, dmiPropertiesMap);
196 ncmpServiceCmHandle.setDmiProperties(dmiPropertiesMap);
199 private void setPublicProperties(final List<YangModelCmHandle.Property> publicProperties,
200 final NcmpServiceCmHandle ncmpServiceCmHandle) {
201 final Map<String, String> publicPropertiesMap = new LinkedHashMap<>();
202 asPropertiesMap(publicProperties, publicPropertiesMap);
203 ncmpServiceCmHandle.setPublicProperties(publicPropertiesMap);
206 private void asPropertiesMap(final List<YangModelCmHandle.Property> properties,
207 final Map<String, String> propertiesMap) {
208 for (final YangModelCmHandle.Property property: properties) {
209 propertiesMap.put(property.getName(), property.getValue());
214 * THis method registers a cm handle and initiates modules sync.
216 * @param dmiPluginRegistration dmi plugin registration information.
217 * @throws JsonProcessingException thrown if json is malformed or missing.
219 public void parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(
220 final DmiPluginRegistration dmiPluginRegistration) throws JsonProcessingException {
221 final YangModelCmHandlesList createdYangModelCmHandlesList =
222 getUpdatedYangModelCmHandlesList(dmiPluginRegistration,
223 dmiPluginRegistration.getCreatedCmHandles());
224 registerAndSyncNewCmHandles(createdYangModelCmHandlesList);
227 private static Object handleResponse(final ResponseEntity<?> responseEntity, final OperationEnum operation) {
228 if (responseEntity.getStatusCode().is2xxSuccessful()) {
229 return responseEntity.getBody();
231 final String exceptionMessage = "Unable to " + operation.toString() + " resource data.";
232 throw new HttpClientRequestException(exceptionMessage, (String) responseEntity.getBody(),
233 responseEntity.getStatusCodeValue());
237 private YangModelCmHandlesList getUpdatedYangModelCmHandlesList(
238 final DmiPluginRegistration dmiPluginRegistration,
239 final List<NcmpServiceCmHandle> updatedCmHandles) {
240 return YangModelCmHandlesList.toYangModelCmHandlesList(
241 dmiPluginRegistration.getDmiPlugin(),
242 dmiPluginRegistration.getDmiDataPlugin(),
243 dmiPluginRegistration.getDmiModelPlugin(),
247 private void registerAndSyncNewCmHandles(final YangModelCmHandlesList yangModelCmHandlesList) {
248 final String cmHandleJsonData = jsonObjectMapper.asJsonString(yangModelCmHandlesList);
249 cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
250 cmHandleJsonData, NO_TIMESTAMP);
252 for (final YangModelCmHandle yangModelCmHandle : yangModelCmHandlesList.getYangModelCmHandles()) {
253 syncModulesAndCreateAnchor(yangModelCmHandle);
257 protected void syncModulesAndCreateAnchor(final YangModelCmHandle yangModelCmHandle) {
258 syncAndCreateSchemaSet(yangModelCmHandle);
259 createAnchor(yangModelCmHandle);
262 private List<CmHandleRegistrationResponse> parseAndRemoveCmHandlesInDmiRegistration(
263 final List<String> tobeRemovedCmHandles) {
264 final List<CmHandleRegistrationResponse> cmHandleRegistrationResponses =
265 new ArrayList<>(tobeRemovedCmHandles.size());
266 for (final String cmHandle : tobeRemovedCmHandles) {
268 deleteSchemaSetWithCascade(cmHandle);
269 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
270 "/dmi-registry/cm-handles[@id='" + cmHandle + "']", NO_TIMESTAMP);
271 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse.createSuccessResponse(cmHandle));
272 } catch (final DataNodeNotFoundException dataNodeNotFoundException) {
273 log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}",
274 cmHandle, dataNodeNotFoundException.getMessage());
275 cmHandleRegistrationResponses.add(CmHandleRegistrationResponse
276 .createFailureResponse(cmHandle, RegistrationError.CM_HANDLE_DOES_NOT_EXIST));
277 } catch (final Exception exception) {
278 log.error("Unable to de-register cm-handleIdd : {} , caused by : {}",
279 cmHandle, exception.getMessage());
280 cmHandleRegistrationResponses.add(
281 CmHandleRegistrationResponse.createFailureResponse(cmHandle, exception));
284 return cmHandleRegistrationResponses;
287 private void deleteSchemaSetWithCascade(final String schemaSetName) {
289 cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
290 CASCADE_DELETE_ALLOWED);
291 } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
292 log.warn("Schema set {} does not exist or already deleted", schemaSetName);
296 private void syncAndCreateSchemaSet(final YangModelCmHandle yangModelCmHandle) {
297 final Collection<ModuleReference> moduleReferencesFromCmHandle =
298 dmiModelOperations.getModuleReferences(yangModelCmHandle);
300 final Collection<ModuleReference> identifiedNewModuleReferencesFromCmHandle = cpsModuleService
301 .identifyNewModuleReferences(moduleReferencesFromCmHandle);
303 final Collection<ModuleReference> existingModuleReferencesFromCmHandle =
304 moduleReferencesFromCmHandle.stream().filter(moduleReferenceFromCmHandle ->
305 !identifiedNewModuleReferencesFromCmHandle.contains(moduleReferenceFromCmHandle)
306 ).collect(Collectors.toList());
308 final Map<String, String> newModuleNameToContentMap;
309 if (identifiedNewModuleReferencesFromCmHandle.isEmpty()) {
310 newModuleNameToContentMap = new HashMap<>();
312 newModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle,
313 identifiedNewModuleReferencesFromCmHandle);
316 .createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
317 newModuleNameToContentMap, existingModuleReferencesFromCmHandle);
320 private void createAnchor(final YangModelCmHandle yangModelCmHandle) {
321 cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, yangModelCmHandle.getId(),
322 yangModelCmHandle.getId());
325 private static boolean hasTopicParameter(final String topicName) {
326 if (topicName == null) {
329 if (TOPIC_NAME_PATTERN.matcher(topicName).matches()) {
332 throw new InvalidTopicException("Topic name " + topicName + " is invalid", "invalid topic");
335 private Map<String, Object> buildDmiResponse(final String requestId) {
336 final Map<String, Object> dmiResponseMap = new HashMap<>();
337 dmiResponseMap.put("requestId", requestId);
338 return dmiResponseMap;
341 private Object validateTopicNameAndGetResourceData(final String cmHandleId,
342 final String resourceIdentifier,
343 final String acceptParamInHeader,
344 final DmiOperations.DataStoreEnum dataStore,
345 final String optionsParamInQuery,
346 final String topicParamInQuery) {
347 final boolean processAsynchronously = hasTopicParameter(topicParamInQuery);
348 if (processAsynchronously) {
349 final String resourceDataRequestId = UUID.randomUUID().toString();
350 return ResponseEntity.status(HttpStatus.OK)
351 .body(buildDmiResponse(resourceDataRequestId));
353 final ResponseEntity<?> responseEntity = dmiDataOperations.getResourceDataFromDmi(
354 cmHandleId, resourceIdentifier, optionsParamInQuery, acceptParamInHeader,
355 dataStore, NO_REQUEST_ID, NO_TOPIC);
356 return handleResponse(responseEntity, OperationEnum.READ);