summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-service/src/main
diff options
context:
space:
mode:
authormpriyank <priyank.maheshwari@est.tech>2022-01-28 16:33:56 +0530
committerRenu Kumari <renu.kumari@bell.ca>2022-02-16 13:31:29 +0000
commita15c0e5b58f16c3ab4a7c7610ac8c4a191e5e051 (patch)
treee71d9c9f2c4570e645c96a69212146276792e49d /cps-ncmp-service/src/main
parent4e1d5e0a179857bfe14296ae1153b2c1173278c8 (diff)
Core logic to update,add or remove cmHandle properties
Issue-ID: CPS-837 Change-Id: Ia078b6a0291ae916931259a309dd592b0554da28 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
Diffstat (limited to 'cps-ncmp-service/src/main')
-rwxr-xr-xcps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java44
-rw-r--r--cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServicePropertyHandler.java171
-rw-r--r--cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/constants/DmiRegistryConstants.java42
3 files changed, 228 insertions, 29 deletions
diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java
index 6b6e6960a9..38f8e1707d 100755
--- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java
+++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java
@@ -23,11 +23,15 @@
package org.onap.cps.ncmp.api.impl;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DATASPACE_NAME;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_ANCHOR;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_PARENT;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NO_TIMESTAMP;
import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED;
import com.fasterxml.jackson.core.JsonProcessingException;
-import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
@@ -59,14 +63,6 @@ import org.springframework.stereotype.Service;
@RequiredArgsConstructor
public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService {
- private static final String NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME = "NFP-Operational";
-
- private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
-
- private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
-
- private static final OffsetDateTime NO_TIMESTAMP = null;
-
private final CpsDataService cpsDataService;
private final JsonObjectMapper jsonObjectMapper;
@@ -79,6 +75,8 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService
private final CpsAdminService cpsAdminService;
+ private final NetworkCmProxyDataServicePropertyHandler networkCmProxyDataServicePropertyHandler;
+
@Override
public void updateDmiRegistrationAndSyncModule(final DmiPluginRegistration dmiPluginRegistration) {
dmiPluginRegistration.validateDmiPluginRegistration();
@@ -92,8 +90,11 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService
if (dmiPluginRegistration.getRemovedCmHandles() != null) {
parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration);
}
- } catch (final JsonProcessingException e) {
- handleJsonProcessingException(dmiPluginRegistration, e);
+ } catch (final JsonProcessingException | DataNodeNotFoundException e) {
+ final String errorMessage = String.format(
+ "Error occurred while processing the CM-handle registration request [%s] ,caused by : [%s]",
+ dmiPluginRegistration, e.getMessage());
+ throw new DataValidationException(errorMessage, e.getMessage(), e);
}
}
@@ -177,11 +178,7 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService
}
private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
- final PersistenceCmHandlesList updatedPersistenceCmHandlesList =
- getUpdatedPersistenceCmHandlesList(dmiPluginRegistration, dmiPluginRegistration.getUpdatedCmHandles());
- final String cmHandlesAsJson = jsonObjectMapper.asJsonString(updatedPersistenceCmHandlesList);
- cpsDataService.updateNodeLeavesAndExistingDescendantLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
- "/dmi-registry", cmHandlesAsJson, NO_TIMESTAMP);
+ networkCmProxyDataServicePropertyHandler.updateCmHandleProperties(dmiPluginRegistration.getUpdatedCmHandles());
}
private PersistenceCmHandlesList getUpdatedPersistenceCmHandlesList(
@@ -194,18 +191,10 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService
updatedCmHandles);
}
- private static void handleJsonProcessingException(final DmiPluginRegistration dmiPluginRegistration,
- final JsonProcessingException e) {
- final String message = "Parsing error occurred while processing DMI Plugin Registration"
- + dmiPluginRegistration;
- log.error(message);
- throw new DataValidationException(message, e.getMessage(), e);
- }
-
private void registerAndSyncNewCmHandles(final PersistenceCmHandlesList persistenceCmHandlesList) {
final String cmHandleJsonData = jsonObjectMapper.asJsonString(persistenceCmHandlesList);
- cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "/dmi-registry",
- cmHandleJsonData, NO_TIMESTAMP);
+ cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
+ cmHandleJsonData, NO_TIMESTAMP);
for (final PersistenceCmHandle persistenceCmHandle : persistenceCmHandlesList.getPersistenceCmHandles()) {
syncModulesAndCreateAnchor(persistenceCmHandle);
@@ -277,7 +266,4 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService
cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, persistenceCmHandle.getId(),
persistenceCmHandle.getId());
}
-
-
-
}
diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServicePropertyHandler.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServicePropertyHandler.java
new file mode 100644
index 0000000000..3599213499
--- /dev/null
+++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServicePropertyHandler.java
@@ -0,0 +1,171 @@
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2022 Nordix Foundation
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.ncmp.api.impl;
+
+import static org.onap.cps.ncmp.api.impl.NetworkCmProxyDataServicePropertyHandler.PropertyType.DMI_PROPERTY;
+import static org.onap.cps.ncmp.api.impl.NetworkCmProxyDataServicePropertyHandler.PropertyType.PUBLIC_PROPERTY;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DATASPACE_NAME;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_ANCHOR;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NCMP_DMI_REGISTRY_PARENT;
+import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NO_TIMESTAMP;
+
+import com.google.common.collect.ImmutableMap;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.onap.cps.api.CpsDataService;
+import org.onap.cps.ncmp.api.models.CmHandle;
+import org.onap.cps.spi.FetchDescendantsOption;
+import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
+import org.onap.cps.spi.model.DataNode;
+import org.onap.cps.spi.model.DataNodeBuilder;
+import org.springframework.stereotype.Service;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+//Accepting the security hotspot as the string checked is generated from inside code and not user input.
+@SuppressWarnings("squid:S5852")
+public class NetworkCmProxyDataServicePropertyHandler {
+
+ private static final String CM_HANDLE_XPATH_TEMPLATE = NCMP_DMI_REGISTRY_PARENT + "/cm-handles[@id='%s']";
+
+ private final CpsDataService cpsDataService;
+
+ /**
+ * Iterates over incoming cmHandles and update the dataNodes based on the updated attributes.
+ * The attributes which are not passed will remain as is.
+ *
+ * @param cmHandles collection of cmHandles
+ */
+ public void updateCmHandleProperties(final Collection<CmHandle> cmHandles) throws DataNodeNotFoundException {
+ for (final CmHandle cmHandle : cmHandles) {
+ try {
+ final String cmHandleXpath = String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandle.getCmHandleID());
+ final DataNode existingCmHandleDataNode =
+ cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, cmHandleXpath,
+ FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
+ processUpdates(existingCmHandleDataNode, cmHandle);
+ } catch (final DataNodeNotFoundException e) {
+ log.error("Unable to find dataNode for cmHandleId : {} , caused by : {}", cmHandle.getCmHandleID(),
+ e.getMessage());
+ throw e;
+ }
+ }
+ }
+
+ private void processUpdates(final DataNode existingCmHandleDataNode, final CmHandle incomingCmHandle) {
+ if (!incomingCmHandle.getPublicProperties().isEmpty()) {
+ updateProperties(existingCmHandleDataNode, PUBLIC_PROPERTY, incomingCmHandle.getPublicProperties());
+ }
+ if (!incomingCmHandle.getDmiProperties().isEmpty()) {
+ updateProperties(existingCmHandleDataNode, DMI_PROPERTY, incomingCmHandle.getDmiProperties());
+ }
+ }
+
+ private void updateProperties(final DataNode existingCmHandleDataNode, final PropertyType propertyType,
+ final Map<String, String> incomingProperties) {
+ final Collection<DataNode> replacementPropertyDataNodes =
+ getReplacementDataNodes(existingCmHandleDataNode, propertyType, incomingProperties);
+ replacementPropertyDataNodes.addAll(
+ getUnchangedPropertyDataNodes(existingCmHandleDataNode, propertyType, incomingProperties));
+ if (replacementPropertyDataNodes.isEmpty()) {
+ removeAllProperties(existingCmHandleDataNode, propertyType);
+ } else {
+ cpsDataService.replaceListContent(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
+ existingCmHandleDataNode.getXpath(), replacementPropertyDataNodes, NO_TIMESTAMP);
+ }
+ }
+
+ private void removeAllProperties(final DataNode existingCmHandleDataNode, final PropertyType propertyType) {
+ existingCmHandleDataNode.getChildDataNodes().forEach(dataNode -> {
+ final Matcher matcher = propertyType.propertyXpathPattern.matcher(dataNode.getXpath());
+ if (matcher.find()) {
+ log.info("Deleting dataNode with xpath : [{}]", dataNode.getXpath());
+ cpsDataService.deleteDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, dataNode.getXpath(),
+ NO_TIMESTAMP);
+ }
+ });
+ }
+
+ private Collection<DataNode> getUnchangedPropertyDataNodes(final DataNode existingCmHandleDataNode,
+ final PropertyType propertyType, final Map<String, String> incomingProperties) {
+ final Collection<DataNode> unchangedPropertyDataNodes = new HashSet<>();
+ for (final DataNode existingPropertyDataNode : existingCmHandleDataNode.getChildDataNodes()) {
+ final Matcher matcher = propertyType.propertyXpathPattern.matcher(existingPropertyDataNode.getXpath());
+ if (matcher.find()) {
+ final String keyName = matcher.group(2);
+ if (!incomingProperties.containsKey(keyName)) {
+ unchangedPropertyDataNodes.add(existingPropertyDataNode);
+ }
+ }
+ }
+ return unchangedPropertyDataNodes;
+ }
+
+ private Collection<DataNode> getReplacementDataNodes(final DataNode existingCmHandleDataNode,
+ final PropertyType propertyType, final Map<String, String> incomingProperties) {
+ final Collection<DataNode> replacementPropertyDataNodes = new HashSet<>();
+ incomingProperties.forEach((updatedAttributeKey, updatedAttributeValue) -> {
+ final String propertyXpath = getAttributeXpath(existingCmHandleDataNode, propertyType, updatedAttributeKey);
+ if (updatedAttributeValue != null) {
+ log.info("Creating a new DataNode with xpath {} , key : {} and value : {}", propertyXpath,
+ updatedAttributeKey, updatedAttributeValue);
+ replacementPropertyDataNodes.add(
+ buildDataNode(propertyXpath, updatedAttributeKey, updatedAttributeValue));
+ }
+ });
+ return replacementPropertyDataNodes;
+ }
+
+ private String getAttributeXpath(final DataNode cmHandle, final PropertyType propertyType,
+ final String attributeKey) {
+ return cmHandle.getXpath() + "/" + propertyType.xpathPrefix + String.format("[@name='%s']", attributeKey);
+ }
+
+ private DataNode buildDataNode(final String xpath, final String attributeKey, final String attributeValue) {
+ final Map<String, String> updatedLeaves = new LinkedHashMap<>(1);
+ updatedLeaves.put("name", attributeKey);
+ updatedLeaves.put("value", attributeValue);
+ log.debug("Building a new node with xpath {} with leaves (name : {} , value : {})", xpath, attributeKey,
+ attributeValue);
+ return new DataNodeBuilder().withXpath(xpath).withLeaves(ImmutableMap.copyOf(updatedLeaves)).build();
+ }
+
+ enum PropertyType {
+ DMI_PROPERTY("additional-properties"), PUBLIC_PROPERTY("public-properties");
+
+ private static final String LIST_INDEX_PATTERN = "\\[@(\\w+)[^\\/]'([^']+)']";
+
+ final String xpathPrefix;
+ final Pattern propertyXpathPattern;
+
+ PropertyType(final String xpathPrefix) {
+ this.xpathPrefix = xpathPrefix;
+ this.propertyXpathPattern = Pattern.compile(xpathPrefix + LIST_INDEX_PATTERN);
+ }
+ }
+}
diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/constants/DmiRegistryConstants.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/constants/DmiRegistryConstants.java
new file mode 100644
index 0000000000..c29c725d79
--- /dev/null
+++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/constants/DmiRegistryConstants.java
@@ -0,0 +1,42 @@
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2022 Nordix Foundation
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.ncmp.api.impl.constants;
+
+import java.time.OffsetDateTime;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+
+/**
+ * DmiRegistryConstants class to be strictly used for DMI Related constants only.
+ */
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public final class DmiRegistryConstants {
+
+ public static final String NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME = "NFP-Operational";
+
+ public static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
+
+ public static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
+
+ public static final String NCMP_DMI_REGISTRY_PARENT = "/dmi-registry";
+
+ public static final OffsetDateTime NO_TIMESTAMP = null;
+}