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.inventory.enums.PropertyType;
  38 import org.onap.cps.ncmp.api.impl.trustlevel.TrustLevel;
  39 import org.onap.cps.ncmp.api.impl.trustlevel.TrustLevelFilter;
  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.stereotype.Component;
  45
  46 @RequiredArgsConstructor
  47 @Component
  48 public class CmHandleQueriesImpl implements CmHandleQueries {
  49
  50     private static final String DESCENDANT_PATH = "//";
  51     private static final String ANCESTOR_CM_HANDLES = "/ancestor::cm-handles";
  52     private final CpsDataPersistenceService cpsDataPersistenceService;
  53     private final Map<String, TrustLevel> trustLevelPerCmHandle;
  54     private final CpsValidator cpsValidator;
  55
  56     @Override
  57     public Collection<String> queryCmHandleAdditionalProperties(final Map<String, String> privatePropertyQueryPairs) {
  58         return queryCmHandleAnyProperties(privatePropertyQueryPairs, PropertyType.ADDITIONAL);
  59     }
  60
  61     @Override
  62     public Collection<String> queryCmHandlePublicProperties(final Map<String, String> publicPropertyQueryPairs) {
  63         return queryCmHandleAnyProperties(publicPropertyQueryPairs, PropertyType.PUBLIC);
  64     }
  65
  66     @Override
  67     public Collection<String> queryCmHandlesByTrustLevel(final Map<String, String> trustLevelPropertyQueryPairs) {
  68         final String trustLevelProperty = trustLevelPropertyQueryPairs.values().iterator().next();
  69         final TrustLevel targetTrustLevel = TrustLevel.valueOf(trustLevelProperty);
  70
  71         final TrustLevelFilter trustLevelFilter = new TrustLevelFilter(targetTrustLevel, trustLevelPerCmHandle);
  72         return trustLevelFilter.getAllCmHandleIdsByTargetTrustLevel();
  73     }
  74
  75     @Override
  76     public List<DataNode> queryCmHandlesByState(final CmHandleState cmHandleState) {
  77         return queryCmHandleAncestorsByCpsPath("//state[@cm-handle-state=\"" + cmHandleState + "\"]",
  78             INCLUDE_ALL_DESCENDANTS);
  79     }
  80
  81     @Override
  82     public List<DataNode> queryNcmpRegistryByCpsPath(final String cpsPath,
  83                                                      final FetchDescendantsOption fetchDescendantsOption) {
  84         return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  85                 cpsPath, fetchDescendantsOption);
  86     }
  87
  88     @Override
  89     public List<DataNode> queryCmHandleAncestorsByCpsPath(final String cpsPath,
  90                                                           final FetchDescendantsOption fetchDescendantsOption) {
  91         return queryNcmpRegistryByCpsPath(cpsPath + ANCESTOR_CM_HANDLES, fetchDescendantsOption);
  92     }
  93
  94     @Override
  95     public boolean cmHandleHasState(final String cmHandleId, final CmHandleState requiredCmHandleState) {
  96         final DataNode stateDataNode = getCmHandleState(cmHandleId);
  97         final String cmHandleStateAsString = (String) stateDataNode.getLeaves().get("cm-handle-state");
  98         return CmHandleState.valueOf(cmHandleStateAsString).equals(requiredCmHandleState);
  99     }
 100
 101     @Override
 102     public List<DataNode> queryCmHandlesByOperationalSyncState(final DataStoreSyncState dataStoreSyncState) {
 103         return queryCmHandleAncestorsByCpsPath("//state/datastores" + "/operational[@sync-state=\""
 104                 + dataStoreSyncState + "\"]", FetchDescendantsOption.OMIT_DESCENDANTS);
 105     }
 106
 107     @Override
 108     public Collection<String> getCmHandleIdsByDmiPluginIdentifier(final String dmiPluginIdentifier) {
 109         final Collection<String> cmHandleIds = new HashSet<>();
 110         for (final ModelledDmiServiceLeaves modelledDmiServiceLeaf : ModelledDmiServiceLeaves.values()) {
 111             for (final DataNode cmHandleAsDataNode: getCmHandlesByDmiPluginIdentifierAndDmiProperty(
 112                     dmiPluginIdentifier,
 113                     modelledDmiServiceLeaf.getLeafName())) {
 114                 cmHandleIds.add(cmHandleAsDataNode.getLeaves().get("id").toString());
 115             }
 116         }
 117         return cmHandleIds;
 118     }
 119
 120     private Collection<String> collectCmHandleIdsFromDataNodes(final Collection<DataNode> dataNodes) {
 121         return dataNodes.stream().map(dataNode -> (String) dataNode.getLeaves().get("id")).collect(Collectors.toSet());
 122     }
 123
 124     private Collection<String> queryCmHandleAnyProperties(
 125         final Map<String, String> propertyQueryPairs,
 126         final PropertyType propertyType) {
 127         if (propertyQueryPairs.isEmpty()) {
 128             return Collections.emptySet();
 129         }
 130         Collection<String> cmHandleIds = null;
 131         for (final Map.Entry<String, String> publicPropertyQueryPair : propertyQueryPairs.entrySet()) {
 132             final String cpsPath = DESCENDANT_PATH + propertyType.getYangContainerName() + "[@name=\""
 133                 + publicPropertyQueryPair.getKey()
 134                 + "\" and @value=\"" + publicPropertyQueryPair.getValue() + "\"]";
 135
 136             final Collection<DataNode> dataNodes = queryCmHandleAncestorsByCpsPath(cpsPath,
 137                     OMIT_DESCENDANTS);
 138             if (cmHandleIds == null) {
 139                 cmHandleIds = collectCmHandleIdsFromDataNodes(dataNodes);
 140             } else {
 141                 final Collection<String> cmHandleIdsToRetain = collectCmHandleIdsFromDataNodes(dataNodes);
 142                 cmHandleIds.retainAll(cmHandleIdsToRetain);
 143             }
 144             if (cmHandleIds.isEmpty()) {
 145                 break;
 146             }
 147         }
 148         return cmHandleIds;
 149     }
 150
 151     private List<DataNode> getCmHandlesByDmiPluginIdentifierAndDmiProperty(final String dmiPluginIdentifier,
 152                                                                            final String dmiProperty) {
 153         return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 154                 NCMP_DMI_REGISTRY_PARENT + "/cm-handles[@" + dmiProperty + "='" + dmiPluginIdentifier + "']",
 155                 OMIT_DESCENDANTS);
 156     }
 157
 158     private DataNode getCmHandleState(final String cmHandleId) {
 159         cpsValidator.validateNameCharacters(cmHandleId);
 160         final String xpath = NCMP_DMI_REGISTRY_PARENT + "/cm-handles[@id='" + cmHandleId + "']/state";
 161         return cpsDataPersistenceService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 162                 xpath, OMIT_DESCENDANTS).iterator().next();
 163     }
 164 }
 165
 166