cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/CmHandleQueriesImpl.java

   1 /*
   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
   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.inventory;
  22
  23 import static org.onap.cps.ncmp.api.impl.utils.YangDataConverter.convertYangModelCmHandleToNcmpServiceCmHandle;
  24 import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS;
  25 import static org.onap.cps.spi.FetchDescendantsOption.OMIT_DESCENDANTS;
  26
  27 import java.util.Collection;
  28 import java.util.Collections;
  29 import java.util.HashMap;
  30 import java.util.HashSet;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Set;
  34 import java.util.stream.Collectors;
  35 import lombok.RequiredArgsConstructor;
  36 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
  37 import org.onap.cps.ncmp.api.inventory.enums.PropertyType;
  38 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  39 import org.onap.cps.spi.CpsDataPersistenceService;
  40 import org.onap.cps.spi.FetchDescendantsOption;
  41 import org.onap.cps.spi.model.DataNode;
  42 import org.springframework.stereotype.Component;
  43
  44 @RequiredArgsConstructor
  45 @Component
  46 public class CmHandleQueriesImpl implements CmHandleQueries {
  47
  48     private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
  49     private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
  50     private static final String DESCENDANT_PATH = "//";
  51
  52     private final CpsDataPersistenceService cpsDataPersistenceService;
  53     private static final Map<String, NcmpServiceCmHandle> NO_QUERY_TO_EXECUTE = null;
  54     private static final String ANCESTOR_CM_HANDLES = "/ancestor::cm-handles";
  55
  56     @Override
  57     public Map<String, NcmpServiceCmHandle> queryCmHandleAdditionalProperties(
  58             final Map<String, String> privatePropertyQueryPairs) {
  59         return queryCmHandleAnyProperties(privatePropertyQueryPairs, PropertyType.ADDITIONAL);
  60     }
  61
  62     @Override
  63     public Map<String, NcmpServiceCmHandle> queryCmHandlePublicProperties(
  64             final Map<String, String> publicPropertyQueryPairs) {
  65         return queryCmHandleAnyProperties(publicPropertyQueryPairs, PropertyType.PUBLIC);
  66     }
  67
  68     private  Map<String, NcmpServiceCmHandle> queryCmHandleAnyProperties(
  69             final Map<String, String> propertyQueryPairs,
  70             final PropertyType propertyType) {
  71         if (propertyQueryPairs.isEmpty()) {
  72             return Collections.emptyMap();
  73         }
  74         Map<String, NcmpServiceCmHandle> cmHandleIdToNcmpServiceCmHandles = null;
  75         for (final Map.Entry<String, String> publicPropertyQueryPair : propertyQueryPairs.entrySet()) {
  76             final String cpsPath = DESCENDANT_PATH + propertyType.getYangContainerName() + "[@name=\""
  77                     + publicPropertyQueryPair.getKey()
  78                     + "\" and @value=\"" + publicPropertyQueryPair.getValue() + "\"]";
  79
  80             final Collection<DataNode> dataNodes = queryCmHandleDataNodesByCpsPath(cpsPath, INCLUDE_ALL_DESCENDANTS);
  81             if (cmHandleIdToNcmpServiceCmHandles == null) {
  82                 cmHandleIdToNcmpServiceCmHandles = collectDataNodesToNcmpServiceCmHandles(dataNodes);
  83             } else {
  84                 final Collection<String> cmHandleIdsToRetain = dataNodes.parallelStream()
  85                         .map(dataNode -> dataNode.getLeaves().get("id").toString()).collect(Collectors.toSet());
  86                 cmHandleIdToNcmpServiceCmHandles.keySet().retainAll(cmHandleIdsToRetain);
  87             }
  88             if (cmHandleIdToNcmpServiceCmHandles.isEmpty()) {
  89                 break;
  90             }
  91         }
  92         return cmHandleIdToNcmpServiceCmHandles;
  93     }
  94
  95     @Override
  96     public Map<String, NcmpServiceCmHandle> combineCmHandleQueries(final Map<String, NcmpServiceCmHandle> firstQuery,
  97             final Map<String, NcmpServiceCmHandle> secondQuery) {
  98         if (firstQuery == NO_QUERY_TO_EXECUTE && secondQuery == NO_QUERY_TO_EXECUTE) {
  99             return NO_QUERY_TO_EXECUTE;
 100         } else if (firstQuery == NO_QUERY_TO_EXECUTE) {
 101             return secondQuery;
 102         } else if (secondQuery == NO_QUERY_TO_EXECUTE) {
 103             return firstQuery;
 104         } else {
 105             firstQuery.keySet().retainAll(secondQuery.keySet());
 106             return firstQuery;
 107         }
 108     }
 109
 110     @Override
 111     public List<DataNode> queryCmHandlesByState(final CmHandleState cmHandleState) {
 112         return queryCmHandleDataNodesByCpsPath("//state[@cm-handle-state=\"" + cmHandleState + "\"]",
 113             INCLUDE_ALL_DESCENDANTS);
 114     }
 115
 116     @Override
 117     public List<DataNode> queryCmHandleDataNodesByCpsPath(final String cpsPath,
 118             final FetchDescendantsOption fetchDescendantsOption) {
 119         return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 120             cpsPath + ANCESTOR_CM_HANDLES, fetchDescendantsOption);
 121     }
 122
 123     @Override
 124     public boolean cmHandleHasState(final String cmHandleId, final CmHandleState requiredCmHandleState) {
 125         final DataNode stateDataNode = getCmHandleState(cmHandleId);
 126         final String cmHandleStateAsString = (String) stateDataNode.getLeaves().get("cm-handle-state");
 127         return CmHandleState.valueOf(cmHandleStateAsString).equals(requiredCmHandleState);
 128     }
 129
 130     @Override
 131     public List<DataNode> queryCmHandlesByOperationalSyncState(final DataStoreSyncState dataStoreSyncState) {
 132         return queryCmHandleDataNodesByCpsPath("//state/datastores" + "/operational[@sync-state=\""
 133                 + dataStoreSyncState + "\"]", FetchDescendantsOption.OMIT_DESCENDANTS);
 134     }
 135
 136     private Map<String, NcmpServiceCmHandle> collectDataNodesToNcmpServiceCmHandles(
 137             final Collection<DataNode> dataNodes) {
 138         final Map<String, NcmpServiceCmHandle> cmHandleIdToNcmpServiceCmHandle = new HashMap<>();
 139         dataNodes.forEach(dataNode -> {
 140             final NcmpServiceCmHandle ncmpServiceCmHandle = createNcmpServiceCmHandle(dataNode);
 141             cmHandleIdToNcmpServiceCmHandle.put(ncmpServiceCmHandle.getCmHandleId(), ncmpServiceCmHandle);
 142         });
 143         return cmHandleIdToNcmpServiceCmHandle;
 144     }
 145
 146     private NcmpServiceCmHandle createNcmpServiceCmHandle(final DataNode dataNode) {
 147         return convertYangModelCmHandleToNcmpServiceCmHandle(YangDataConverter
 148                 .convertCmHandleToYangModel(dataNode, dataNode.getLeaves().get("id").toString()));
 149     }
 150
 151     @Override
 152     public Set<NcmpServiceCmHandle> getCmHandlesByDmiPluginIdentifier(final String dmiPluginIdentifier) {
 153         final Map<String, DataNode> cmHandleAsDataNodePerCmHandleId = new HashMap<>();
 154         for (final ModelledDmiServiceLeaves modelledDmiServiceLeaf : ModelledDmiServiceLeaves.values()) {
 155             for (final DataNode cmHandleAsDataNode: getCmHandlesByDmiPluginIdentifierAndDmiProperty(
 156                     dmiPluginIdentifier,
 157                     modelledDmiServiceLeaf.getLeafName())) {
 158                 cmHandleAsDataNodePerCmHandleId.put(
 159                         cmHandleAsDataNode.getLeaves().get("id").toString(), cmHandleAsDataNode);
 160             }
 161         }
 162         final Set<NcmpServiceCmHandle> ncmpServiceCmHandles = new HashSet<>(cmHandleAsDataNodePerCmHandleId.size());
 163         cmHandleAsDataNodePerCmHandleId.values().forEach(
 164                 cmHandleAsDataNode -> ncmpServiceCmHandles.add(createNcmpServiceCmHandle(cmHandleAsDataNode)));
 165         return ncmpServiceCmHandles;
 166     }
 167
 168     private List<DataNode> getCmHandlesByDmiPluginIdentifierAndDmiProperty(final String dmiPluginIdentifier,
 169                                                              final String dmiProperty) {
 170         return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 171                 "/dmi-registry/cm-handles[@" + dmiProperty + "='" + dmiPluginIdentifier + "']",
 172                 OMIT_DESCENDANTS);
 173     }
 174
 175     private DataNode getCmHandleState(final String cmHandleId) {
 176         final String xpath = "/dmi-registry/cm-handles[@id='" + cmHandleId + "']/state";
 177         return cpsDataPersistenceService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 178                 xpath, OMIT_DESCENDANTS);
 179     }
 180 }
 181
 182