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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.ncmp.api.impl.inventory;
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;
30 import java.util.Collection;
31 import java.util.Collections;
32 import java.util.HashSet;
33 import java.util.List;
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.spi.CpsDataPersistenceService;
39 import org.onap.cps.spi.FetchDescendantsOption;
40 import org.onap.cps.spi.model.DataNode;
41 import org.springframework.stereotype.Component;
43 @RequiredArgsConstructor
45 public class CmHandleQueriesImpl implements CmHandleQueries {
47 private static final String DESCENDANT_PATH = "//";
49 private final CpsDataPersistenceService cpsDataPersistenceService;
50 private static final String ANCESTOR_CM_HANDLES = "/ancestor::cm-handles";
53 public Collection<String> queryCmHandleAdditionalProperties(final Map<String, String> privatePropertyQueryPairs) {
54 return queryCmHandleAnyProperties(privatePropertyQueryPairs, PropertyType.ADDITIONAL);
58 public Collection<String> queryCmHandlePublicProperties(final Map<String, String> publicPropertyQueryPairs) {
59 return queryCmHandleAnyProperties(publicPropertyQueryPairs, PropertyType.PUBLIC);
63 public List<DataNode> queryCmHandlesByState(final CmHandleState cmHandleState) {
64 return queryCmHandleAncestorsByCpsPath("//state[@cm-handle-state=\"" + cmHandleState + "\"]",
65 INCLUDE_ALL_DESCENDANTS);
69 public List<DataNode> queryNcmpRegistryByCpsPath(final String cpsPath,
70 final FetchDescendantsOption fetchDescendantsOption) {
71 return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
72 cpsPath, fetchDescendantsOption);
76 public List<DataNode> queryCmHandleAncestorsByCpsPath(final String cpsPath,
77 final FetchDescendantsOption fetchDescendantsOption) {
78 return queryNcmpRegistryByCpsPath(cpsPath + ANCESTOR_CM_HANDLES, fetchDescendantsOption);
82 public boolean cmHandleHasState(final String cmHandleId, final CmHandleState requiredCmHandleState) {
83 final DataNode stateDataNode = getCmHandleState(cmHandleId);
84 final String cmHandleStateAsString = (String) stateDataNode.getLeaves().get("cm-handle-state");
85 return CmHandleState.valueOf(cmHandleStateAsString).equals(requiredCmHandleState);
89 public List<DataNode> queryCmHandlesByOperationalSyncState(final DataStoreSyncState dataStoreSyncState) {
90 return queryCmHandleAncestorsByCpsPath("//state/datastores" + "/operational[@sync-state=\""
91 + dataStoreSyncState + "\"]", FetchDescendantsOption.OMIT_DESCENDANTS);
95 public Collection<String> getCmHandleIdsByDmiPluginIdentifier(final String dmiPluginIdentifier) {
96 final Collection<String> cmHandleIds = new HashSet<>();
97 for (final ModelledDmiServiceLeaves modelledDmiServiceLeaf : ModelledDmiServiceLeaves.values()) {
98 for (final DataNode cmHandleAsDataNode: getCmHandlesByDmiPluginIdentifierAndDmiProperty(
100 modelledDmiServiceLeaf.getLeafName())) {
101 cmHandleIds.add(cmHandleAsDataNode.getLeaves().get("id").toString());
107 private Collection<String> collectCmHandleIdsFromDataNodes(final Collection<DataNode> dataNodes) {
108 return dataNodes.stream().map(dataNode -> (String) dataNode.getLeaves().get("id")).collect(Collectors.toSet());
111 private Collection<String> queryCmHandleAnyProperties(
112 final Map<String, String> propertyQueryPairs,
113 final PropertyType propertyType) {
114 if (propertyQueryPairs.isEmpty()) {
115 return Collections.emptySet();
117 Collection<String> cmHandleIds = null;
118 for (final Map.Entry<String, String> publicPropertyQueryPair : propertyQueryPairs.entrySet()) {
119 final String cpsPath = DESCENDANT_PATH + propertyType.getYangContainerName() + "[@name=\""
120 + publicPropertyQueryPair.getKey()
121 + "\" and @value=\"" + publicPropertyQueryPair.getValue() + "\"]";
123 final Collection<DataNode> dataNodes = queryCmHandleAncestorsByCpsPath(cpsPath,
125 if (cmHandleIds == null) {
126 cmHandleIds = collectCmHandleIdsFromDataNodes(dataNodes);
128 final Collection<String> cmHandleIdsToRetain = collectCmHandleIdsFromDataNodes(dataNodes);
129 cmHandleIds.retainAll(cmHandleIdsToRetain);
131 if (cmHandleIds.isEmpty()) {
138 private List<DataNode> getCmHandlesByDmiPluginIdentifierAndDmiProperty(final String dmiPluginIdentifier,
139 final String dmiProperty) {
140 return cpsDataPersistenceService.queryDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
141 NCMP_DMI_REGISTRY_PARENT + "/cm-handles[@" + dmiProperty + "='" + dmiPluginIdentifier + "']",
145 private DataNode getCmHandleState(final String cmHandleId) {
146 final String xpath = NCMP_DMI_REGISTRY_PARENT + "/cm-handles[@id='" + cmHandleId + "']/state";
147 return cpsDataPersistenceService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
148 xpath, OMIT_DESCENDANTS).iterator().next();