cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/utils/YangDataConverter.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.util.ArrayList;
  24 import java.util.Collection;
  25 import java.util.LinkedHashMap;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.regex.Matcher;
  29 import java.util.regex.Pattern;
  30 import lombok.AccessLevel;
  31 import lombok.NoArgsConstructor;
  32 import lombok.extern.slf4j.Slf4j;
  33 import org.onap.cps.ncmp.api.impl.inventory.CompositeState;
  34 import org.onap.cps.ncmp.api.impl.inventory.CompositeStateBuilder;
  35 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  36 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  37 import org.onap.cps.spi.model.DataNode;
  38
  39 @NoArgsConstructor(access = AccessLevel.PRIVATE)
  40 @Slf4j
  41 public class YangDataConverter {
  42
  43     private static final Pattern cmHandleIdInXpathPattern = Pattern.compile("\\[@id='(.*?)']");
  44
  45     /**
  46      * This method convert yang model cm handle to ncmp service cm handle.
  47      * @param yangModelCmHandle the yang model of the cm handle
  48      * @return ncmp service cm handle
  49      */
  50     public static NcmpServiceCmHandle convertYangModelCmHandleToNcmpServiceCmHandle(
  51             final YangModelCmHandle yangModelCmHandle) {
  52         final NcmpServiceCmHandle ncmpServiceCmHandle = new NcmpServiceCmHandle();
  53         final List<YangModelCmHandle.Property> dmiProperties = yangModelCmHandle.getDmiProperties();
  54         final List<YangModelCmHandle.Property> publicProperties = yangModelCmHandle.getPublicProperties();
  55         ncmpServiceCmHandle.setCmHandleId(yangModelCmHandle.getId());
  56         ncmpServiceCmHandle.setCompositeState(yangModelCmHandle.getCompositeState());
  57         setDmiProperties(dmiProperties, ncmpServiceCmHandle);
  58         setPublicProperties(publicProperties, ncmpServiceCmHandle);
  59         return ncmpServiceCmHandle;
  60     }
  61
  62     /**
  63      * This method convert yang model cm handle properties to simple map.
  64      * @param properties the yang model cm handle properties
  65      * @param propertiesMap the String, String map for the results
  66      */
  67     public static void asPropertiesMap(final List<YangModelCmHandle.Property> properties,
  68                                        final Map<String, String> propertiesMap) {
  69         for (final YangModelCmHandle.Property property : properties) {
  70             propertiesMap.put(property.getName(), property.getValue());
  71         }
  72     }
  73
  74     /**
  75      * This method convert cm handle data node to yang model cm handle.
  76      * @param cmHandleDataNode the datanode of the cm handle
  77      * @param cmHandleId the id of the cm handle
  78      * @return yang model cm handle
  79      */
  80     public static YangModelCmHandle convertCmHandleToYangModel(final DataNode cmHandleDataNode,
  81                                                                final String cmHandleId) {
  82         final NcmpServiceCmHandle ncmpServiceCmHandle = new NcmpServiceCmHandle();
  83         ncmpServiceCmHandle.setCmHandleId(cmHandleId);
  84         populateCmHandleDetails(cmHandleDataNode, ncmpServiceCmHandle);
  85         return YangModelCmHandle.toYangModelCmHandle(
  86                 (String) cmHandleDataNode.getLeaves().get("dmi-service-name"),
  87                 (String) cmHandleDataNode.getLeaves().get("dmi-data-service-name"),
  88                 (String) cmHandleDataNode.getLeaves().get("dmi-model-service-name"),
  89                 ncmpServiceCmHandle
  90         );
  91     }
  92
  93     /**
  94      * This method convert cm handle data nodes to yang model cm handles.
  95      * @param cmHandleDataNodes the datanode of the cm handle
  96      * @return yang model cm handles
  97      */
  98     public static Collection<YangModelCmHandle> convertDataNodesToYangModelCmHandles(
  99             final Collection<DataNode> cmHandleDataNodes) {
 100         final Collection<YangModelCmHandle> yangModelCmHandles = new ArrayList<>(cmHandleDataNodes.size());
 101         cmHandleDataNodes.forEach(dataNode -> {
 102             final String cmHandleId = extractCmHandleIdFromXpath(dataNode.getXpath());
 103             yangModelCmHandles.add(convertCmHandleToYangModel(dataNode, cmHandleId));
 104         });
 105         return yangModelCmHandles;
 106     }
 107
 108     private static String extractCmHandleIdFromXpath(final String xpath) {
 109         final Matcher matcher = cmHandleIdInXpathPattern.matcher(xpath);
 110         matcher.find();
 111         return matcher.group(1);
 112     }
 113
 114
 115     private static void populateCmHandleDetails(final DataNode cmHandleDataNode,
 116                                                 final NcmpServiceCmHandle ncmpServiceCmHandle) {
 117         final Map<String, String> dmiProperties = new LinkedHashMap<>();
 118         final Map<String, String> publicProperties = new LinkedHashMap<>();
 119         final CompositeStateBuilder compositeStateBuilder = new CompositeStateBuilder();
 120         CompositeState compositeState = compositeStateBuilder.build();
 121         for (final DataNode childDataNode: cmHandleDataNode.getChildDataNodes()) {
 122             if (childDataNode.getXpath().contains("/additional-properties[@name=")) {
 123                 addProperty(childDataNode, dmiProperties);
 124             } else if (childDataNode.getXpath().contains("/public-properties[@name=")) {
 125                 addProperty(childDataNode, publicProperties);
 126             } else if (childDataNode.getXpath().endsWith("/state")) {
 127                 compositeState = compositeStateBuilder.fromDataNode(childDataNode).build();
 128             }
 129         }
 130         ncmpServiceCmHandle.setDmiProperties(dmiProperties);
 131         ncmpServiceCmHandle.setPublicProperties(publicProperties);
 132         ncmpServiceCmHandle.setCompositeState(compositeState);
 133     }
 134
 135     private static void addProperty(final DataNode propertyDataNode, final Map<String, String> propertiesAsMap) {
 136         propertiesAsMap.put(String.valueOf(propertyDataNode.getLeaves().get("name")),
 137                 String.valueOf(propertyDataNode.getLeaves().get("value")));
 138     }
 139
 140     private static void setDmiProperties(final List<YangModelCmHandle.Property> dmiProperties,
 141                                          final NcmpServiceCmHandle ncmpServiceCmHandle) {
 142         final Map<String, String> dmiPropertiesMap = new LinkedHashMap<>(dmiProperties.size());
 143         asPropertiesMap(dmiProperties, dmiPropertiesMap);
 144         ncmpServiceCmHandle.setDmiProperties(dmiPropertiesMap);
 145     }
 146
 147     private static void setPublicProperties(final List<YangModelCmHandle.Property> publicProperties,
 148                                             final NcmpServiceCmHandle ncmpServiceCmHandle) {
 149         final Map<String, String> publicPropertiesMap = new LinkedHashMap<>();
 150         asPropertiesMap(publicProperties, publicPropertiesMap);
 151         ncmpServiceCmHandle.setPublicProperties(publicPropertiesMap);
 152     }
 153 }