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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022-2023 Nordix Foundation
   4  *  Modifications Copyright (C) 2023 TechMahindra Ltd.
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.ncmp.api.impl.inventory;
  23
  24 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DATASPACE_NAME;
  25 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DMI_REGISTRY_ANCHOR;
  26 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DMI_REGISTRY_PARENT;
  27 import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS;
  28 import static org.onap.cps.spi.FetchDescendantsOption.OMIT_DESCENDANTS;
  29
  30 import java.util.Collection;
  31 import java.util.Collections;
  32 import java.util.HashSet;
  33 import java.util.List;
  34 import java.util.Map;
  35 import java.util.stream.Collectors;
  36 import lombok.RequiredArgsConstructor;
  37 import org.onap.cps.ncmp.api.impl.config.embeddedcache.TrustLevelCacheConfig;
  38 import org.onap.cps.ncmp.api.impl.inventory.enums.PropertyType;
  39 import org.onap.cps.ncmp.api.impl.trustlevel.TrustLevel;
  40 import org.onap.cps.spi.CpsDataPersistenceService;
  41 import org.onap.cps.spi.FetchDescendantsOption;
  42 import org.onap.cps.spi.model.DataNode;
  43 import org.onap.cps.spi.utils.CpsValidator;
  44 import org.springframework.beans.factory.annotation.Qualifier;
  45 import org.springframework.stereotype.Component;
  46
  47 @RequiredArgsConstructor
  48 @Component
  49 public class CmHandleQueriesImpl implements CmHandleQueries {
  50
  51     private static final String DESCENDANT_PATH = "//";
  52     private static final String ANCESTOR_CM_HANDLES = "/ancestor::cm-handles";
  53     private final CpsDataPersistenceService cpsDataPersistenceService;
  54
  55     @Qualifier(TrustLevelCacheConfig.TRUST_LEVEL_PER_DMI_PLUGIN_BEAN_NAME)
  56     private final Map<String, TrustLevel> trustLevelPerDmiPlugin;
  57
  58     @Qualifier(TrustLevelCacheConfig.TRUST_LEVEL_PER_CM_HANDLE_BEAN_NAME)
  59     private final Map<String, TrustLevel> trustLevelPerCmHandle;
  60     private final CpsValidator cpsValidator;
  61
  62     @Override
  63     public Collection<String> queryCmHandleAdditionalProperties(final Map<String, String> privatePropertyQueryPairs) {
  64         return queryCmHandleAnyProperties(privatePropertyQueryPairs, PropertyType.ADDITIONAL);
  65     }
  66
  67     @Override
  68     public Collection<String> queryCmHandlePublicProperties(final Map<String, String> publicPropertyQueryPairs) {
  69         return queryCmHandleAnyProperties(publicPropertyQueryPairs, PropertyType.PUBLIC);
  70     }
  71
  72     @Override
  73     public Collection<String> queryCmHandlesByTrustLevel(final Map<String, String> trustLevelPropertyQueryPairs) {
  74         final String trustLevelProperty = trustLevelPropertyQueryPairs.values().iterator().next();
  75         final TrustLevel targetTrustLevel = TrustLevel.valueOf(trustLevelProperty);
  76
  77         return getCmHandleIdsByTrustLevel(targetTrustLevel);
  78     }
  79
  80     @Override
  81     public List<DataNode> queryCmHandlesByState(final CmHandleState cmHandleState) {
  82         return queryCmHandleAncestorsByCpsPath("//state[@cm-handle-state=\"" + cmHandleState + "\"]",
  83             INCLUDE_ALL_DESCENDANTS);
  84     }
  85
  86     @Override
  87     public List<DataNode> queryNcmpRegistryByCpsPath(final String cpsPath,
  88                                                      final FetchDescendantsOption fetchDescendantsOption) {
  89         return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  90                 cpsPath, fetchDescendantsOption);
  91     }
  92
  93     @Override
  94     public List<DataNode> queryCmHandleAncestorsByCpsPath(final String cpsPath,
  95                                                           final FetchDescendantsOption fetchDescendantsOption) {
  96         return queryNcmpRegistryByCpsPath(cpsPath + ANCESTOR_CM_HANDLES, fetchDescendantsOption);
  97     }
  98
  99     @Override
 100     public boolean cmHandleHasState(final String cmHandleId, final CmHandleState requiredCmHandleState) {
 101         final DataNode stateDataNode = getCmHandleState(cmHandleId);
 102         final String cmHandleStateAsString = (String) stateDataNode.getLeaves().get("cm-handle-state");
 103         return CmHandleState.valueOf(cmHandleStateAsString).equals(requiredCmHandleState);
 104     }
 105
 106     @Override
 107     public List<DataNode> queryCmHandlesByOperationalSyncState(final DataStoreSyncState dataStoreSyncState) {
 108         return queryCmHandleAncestorsByCpsPath("//state/datastores" + "/operational[@sync-state=\""
 109                 + dataStoreSyncState + "\"]", FetchDescendantsOption.OMIT_DESCENDANTS);
 110     }
 111
 112     @Override
 113     public Collection<String> getCmHandleIdsByDmiPluginIdentifier(final String dmiPluginIdentifier) {
 114         final Collection<String> cmHandleIds = new HashSet<>();
 115         for (final ModelledDmiServiceLeaves modelledDmiServiceLeaf : ModelledDmiServiceLeaves.values()) {
 116             for (final DataNode cmHandleAsDataNode: getCmHandlesByDmiPluginIdentifierAndDmiProperty(
 117                     dmiPluginIdentifier,
 118                     modelledDmiServiceLeaf.getLeafName())) {
 119                 cmHandleIds.add(cmHandleAsDataNode.getLeaves().get("id").toString());
 120             }
 121         }
 122         return cmHandleIds;
 123     }
 124
 125     private Collection<String> getCmHandleIdsByTrustLevel(final TrustLevel targetTrustLevel) {
 126         final Collection<String> selectedCmHandleIds = new HashSet<>();
 127
 128         for (final Map.Entry<String, TrustLevel> mapEntry : trustLevelPerDmiPlugin.entrySet()) {
 129             final String dmiPluginIdentifier = mapEntry.getKey();
 130             final TrustLevel dmiTrustLevel = mapEntry.getValue();
 131             final Collection<String> candidateCmHandleIds = getCmHandleIdsByDmiPluginIdentifier(dmiPluginIdentifier);
 132             for (final String candidateCmHandleId : candidateCmHandleIds) {
 133                 final TrustLevel candidateCmHandleTrustLevel = trustLevelPerCmHandle.get(candidateCmHandleId);
 134                 final TrustLevel effectiveTrustlevel =
 135                     candidateCmHandleTrustLevel.getEffectiveTrustLevel(dmiTrustLevel);
 136                 if (targetTrustLevel.equals(effectiveTrustlevel)) {
 137                     selectedCmHandleIds.add(candidateCmHandleId);
 138                 }
 139             }
 140         }
 141
 142         return selectedCmHandleIds;
 143     }
 144
 145     private Collection<String> collectCmHandleIdsFromDataNodes(final Collection<DataNode> dataNodes) {
 146         return dataNodes.stream().map(dataNode -> (String) dataNode.getLeaves().get("id")).collect(Collectors.toSet());
 147     }
 148
 149     private Collection<String> queryCmHandleAnyProperties(
 150         final Map<String, String> propertyQueryPairs,
 151         final PropertyType propertyType) {
 152         if (propertyQueryPairs.isEmpty()) {
 153             return Collections.emptySet();
 154         }
 155         Collection<String> cmHandleIds = null;
 156         for (final Map.Entry<String, String> publicPropertyQueryPair : propertyQueryPairs.entrySet()) {
 157             final String cpsPath = DESCENDANT_PATH + propertyType.getYangContainerName() + "[@name=\""
 158                 + publicPropertyQueryPair.getKey()
 159                 + "\" and @value=\"" + publicPropertyQueryPair.getValue() + "\"]";
 160
 161             final Collection<DataNode> dataNodes = queryCmHandleAncestorsByCpsPath(cpsPath,
 162                     OMIT_DESCENDANTS);
 163             if (cmHandleIds == null) {
 164                 cmHandleIds = collectCmHandleIdsFromDataNodes(dataNodes);
 165             } else {
 166                 final Collection<String> cmHandleIdsToRetain = collectCmHandleIdsFromDataNodes(dataNodes);
 167                 cmHandleIds.retainAll(cmHandleIdsToRetain);
 168             }
 169             if (cmHandleIds.isEmpty()) {
 170                 break;
 171             }
 172         }
 173         return cmHandleIds;
 174     }
 175
 176     private List<DataNode> getCmHandlesByDmiPluginIdentifierAndDmiProperty(final String dmiPluginIdentifier,
 177                                                                            final String dmiProperty) {
 178         return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 179                 NCMP_DMI_REGISTRY_PARENT + "/cm-handles[@" + dmiProperty + "='" + dmiPluginIdentifier + "']",
 180                 OMIT_DESCENDANTS);
 181     }
 182
 183     private DataNode getCmHandleState(final String cmHandleId) {
 184         cpsValidator.validateNameCharacters(cmHandleId);
 185         final String xpath = NCMP_DMI_REGISTRY_PARENT + "/cm-handles[@id='" + cmHandleId + "']/state";
 186         return cpsDataPersistenceService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 187                 xpath, OMIT_DESCENDANTS).iterator().next();
 188     }
 189 }
 190
 191