CPS-837 Remove and Add Properties as part of CM-Handle registration update

Input

Input

1. Since the incoming request has updatedCmHandles tag hence we need to check if there are properties eligible to be updated.
   
   

2. Iterate over the incoming cmHandles and for each cmHandle do the following.

   1. Form the xpath from the incoming request using the below expression.
      
      

      Form xpath

      final String targetXpath = "/dmi-registry/cm-handles[@id='" + cmHandleID + "']";
      eg : "/dmi-registry/cm-handles[@id=myHandle1]"

   2. Get the dataNodes using the above xpath been created including all the leaves (leaves denotes the attributes).
      
      

      Get Data Nodes using xpath

      final DataNode dataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME, 	NCMP_DMI_REGISTRY_ANCHOR, 
      targetXpath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);

   3. Get handle of the leaves(with existing data) and apply the changes only to the attribute which are present in the incoming request. The attributes which are explicitly set to null will be removed  and others which are present will be updated. The attributes which are not specified will not be touched.
      
      

      Core logic to add or remove attributes

      private void handleAddOrRemoveCmHandleProperties(final DataNode dataNode, final String targetAttributeKey,
                  final String targetAttributeValue) {
              final Map<String, Object> leaves = dataNode.getLeaves();
              if (leaves.containsKey(targetAttributeKey)) {
                  if (targetAttributeValue == null) {
                      log.info("Removing the attribute with ( key : {} , existingValue : {} )", targetAttributeKey,
                              leaves.get(targetAttributeKey));
                      leaves.remove(targetAttributeKey);
                  } else {
                      log.info("Updating the attribute with ( key : {} , existingValue : {} to newValue : {} )",
                              targetAttributeKey, leaves.get(targetAttributeKey), targetAttributeValue);
                      leaves.put(targetAttributeKey, targetAttributeValue);
                  }
      
              } else {
                  log.info("Adding the attribute with ( key : {} , value : {} )", targetAttributeKey, targetAttributeValue);
                  leaves.put(targetAttributeKey, targetAttributeValue);
              }
          }

      
      
      
      

3. Perform step-2 for all the cmHandles and collect the updated dataNodes.

4. Now since from step-3 we have a Collection<DataNode> which have the updated changes , we can make use of replaceListContent method to apply our changes.
   
   Note[V1 can be done as is but make a note and propose to the team if we can create an overloaded version] : We are creating an overloaded version of replaceListContent method which takes in Collection<DataNode> directly instead of String jsonData as we directly have the dataNode from step 2.b.
   
   

   replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath, final Collection<DataNode> dataNodes, final OffsetDateTime observedTimestamp)

   @Override
   public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
                                      final Collection<DataNode> dataNodes, final OffsetDateTime observedTimestamp) {
           cpsDataPersistenceService.replaceListContent(dataspaceName, anchorName, parentNodeXpath, dataNodes);
           processDataUpdatedEventAsync(dataspaceName, anchorName, observedTimestamp, parentNodeXpath, Operation.UPDATE);
       }

• All properties will be removed.
• "propx" : we are trying to remove a non-existent property so it should be ignored and should not result in any issue.