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