2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022-2023 Nordix Foundation
4 * Modifications Copyright (C) 2022 Bell Canada
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.inventory;
24 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
25 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NO_TIMESTAMP;
26 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED;
27 import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS;
29 import io.micrometer.core.annotation.Timed;
30 import java.time.OffsetDateTime;
31 import java.util.ArrayList;
32 import java.util.Collection;
33 import java.util.HashMap;
34 import java.util.List;
36 import lombok.RequiredArgsConstructor;
37 import lombok.extern.slf4j.Slf4j;
38 import org.onap.cps.api.CpsAdminService;
39 import org.onap.cps.api.CpsDataService;
40 import org.onap.cps.api.CpsModuleService;
41 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
42 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
43 import org.onap.cps.spi.FetchDescendantsOption;
44 import org.onap.cps.spi.exceptions.DataValidationException;
45 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
46 import org.onap.cps.spi.model.DataNode;
47 import org.onap.cps.spi.model.ModuleDefinition;
48 import org.onap.cps.spi.model.ModuleReference;
49 import org.onap.cps.spi.utils.CpsValidator;
50 import org.onap.cps.utils.JsonObjectMapper;
51 import org.springframework.stereotype.Component;
54 @RequiredArgsConstructor
56 public class InventoryPersistenceImpl implements InventoryPersistence {
58 private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
60 private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
62 private static final String NCMP_DMI_REGISTRY_PARENT = "/dmi-registry";
64 private final JsonObjectMapper jsonObjectMapper;
66 private final CpsDataService cpsDataService;
68 private final CpsModuleService cpsModuleService;
70 private final CpsAdminService cpsAdminService;
72 private final CpsValidator cpsValidator;
75 public CompositeState getCmHandleState(final String cmHandleId) {
76 final DataNode stateAsDataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
77 createCmHandleXPath(cmHandleId) + "/state",
78 FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
79 cpsValidator.validateNameCharacters(cmHandleId);
80 return new CompositeStateBuilder().fromDataNode(stateAsDataNode).build();
84 public void saveCmHandleState(final String cmHandleId, final CompositeState compositeState) {
85 final String cmHandleJsonData = createStateJsonData(jsonObjectMapper.asJsonString(compositeState));
86 cpsDataService.updateDataNodeAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
87 createCmHandleXPath(cmHandleId),
88 cmHandleJsonData, OffsetDateTime.now());
92 public void saveCmHandleStateBatch(final Map<String, CompositeState> cmHandleStatePerCmHandleId) {
93 final Map<String, String> cmHandlesJsonDataMap = new HashMap<>();
94 cmHandleStatePerCmHandleId.forEach((cmHandleId, compositeState) -> cmHandlesJsonDataMap.put(
95 createCmHandleXPath(cmHandleId),
96 createStateJsonData(jsonObjectMapper.asJsonString(compositeState))));
97 cpsDataService.updateDataNodesAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
98 cmHandlesJsonDataMap, OffsetDateTime.now());
102 public YangModelCmHandle getYangModelCmHandle(final String cmHandleId) {
103 cpsValidator.validateNameCharacters(cmHandleId);
104 return YangDataConverter.convertCmHandleToYangModel(getCmHandleDataNode(cmHandleId), cmHandleId);
108 public Collection<YangModelCmHandle> getYangModelCmHandles(final Collection<String> cmHandleIds) {
109 final Collection<String> validCmHandleIds = new ArrayList<>(cmHandleIds.size());
110 cmHandleIds.forEach(cmHandleId -> {
112 cpsValidator.validateNameCharacters(cmHandleId);
113 validCmHandleIds.add(cmHandleId);
114 } catch (final DataValidationException dataValidationException) {
115 log.error("DataValidationException in CmHandleId {} to be ignored",
116 dataValidationException.getMessage());
119 return YangDataConverter.convertDataNodesToYangModelCmHandles(getCmHandleDataNodes(validCmHandleIds));
123 public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) {
124 return cpsModuleService.getModuleDefinitionsByAnchorName(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
128 public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
129 cpsValidator.validateNameCharacters(cmHandleId);
130 return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
134 public void saveCmHandle(final YangModelCmHandle yangModelCmHandle) {
135 final String cmHandleJsonData =
136 createCmHandleJsonData(jsonObjectMapper.asJsonString(yangModelCmHandle));
137 cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
138 cmHandleJsonData, NO_TIMESTAMP);
142 public void saveCmHandleBatch(final Collection<YangModelCmHandle> yangModelCmHandles) {
143 final List<String> cmHandlesJsonData = new ArrayList<>();
144 yangModelCmHandles.forEach(yangModelCmHandle -> cmHandlesJsonData.add(
145 createCmHandleJsonData(jsonObjectMapper.asJsonString(yangModelCmHandle))));
146 cpsDataService.saveListElementsBatch(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
147 NCMP_DMI_REGISTRY_PARENT, cmHandlesJsonData, NO_TIMESTAMP);
151 public void deleteListOrListElement(final String listElementXpath) {
152 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
153 listElementXpath, NO_TIMESTAMP);
157 @Timed(value = "cps.ncmp.inventory.persistence.schemaset.delete",
158 description = "Time taken to delete a schemaset")
159 public void deleteSchemaSetWithCascade(final String schemaSetName) {
161 cpsValidator.validateNameCharacters(schemaSetName);
162 cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
163 CASCADE_DELETE_ALLOWED);
164 } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
165 log.warn("Schema set {} does not exist or already deleted", schemaSetName);
170 @Timed(value = "cps.ncmp.inventory.persistence.datanode.get",
171 description = "Time taken to get a data node (from ncmp dmi registry)")
172 public DataNode getDataNode(final String xpath) {
173 return getDataNode(xpath, INCLUDE_ALL_DESCENDANTS);
177 @Timed(value = "cps.ncmp.inventory.persistence.datanode.get",
178 description = "Time taken to get a data node (from ncmp dmi registry)")
179 public DataNode getDataNode(final String xpath, final FetchDescendantsOption fetchDescendantsOption) {
180 return cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
181 xpath, fetchDescendantsOption);
185 public Collection<DataNode> getDataNodes(final Collection<String> xpaths) {
186 return getDataNodes(xpaths, INCLUDE_ALL_DESCENDANTS);
190 public Collection<DataNode> getDataNodes(final Collection<String> xpaths,
191 final FetchDescendantsOption fetchDescendantsOption) {
192 return cpsDataService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
193 xpaths, fetchDescendantsOption);
197 public DataNode getCmHandleDataNode(final String cmHandleId) {
198 return this.getDataNode(createCmHandleXPath(cmHandleId));
202 public Collection<DataNode> getCmHandleDataNodes(final Collection<String> cmHandleIds) {
203 final Collection<String> xpaths = new ArrayList<>(cmHandleIds.size());
204 cmHandleIds.forEach(cmHandleId -> xpaths.add(createCmHandleXPath(cmHandleId)));
205 return this.getDataNodes(xpaths);
209 public Collection<String> getCmHandleIdsWithGivenModules(final Collection<String> moduleNamesForQuery) {
210 return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNamesForQuery);
214 public void replaceListContent(final String parentNodeXpath, final Collection<DataNode> dataNodes) {
215 cpsDataService.replaceListContent(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
216 parentNodeXpath, dataNodes, NO_TIMESTAMP);
220 public void deleteDataNode(final String dataNodeXpath) {
221 cpsDataService.deleteDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, dataNodeXpath, NO_TIMESTAMP);
225 public void deleteDataNodes(final Collection<String> dataNodeXpaths) {
226 cpsDataService.deleteDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, dataNodeXpaths, NO_TIMESTAMP);
229 private static String createCmHandleXPath(final String cmHandleId) {
230 return "/dmi-registry/cm-handles[@id='" + cmHandleId + "']";
233 private static String createStateJsonData(final String state) {
234 return "{\"state\":" + state + "}";
237 private static String createCmHandleJsonData(final String cmHandleId) {
238 return "{\"cm-handles\":[" + cmHandleId + "]}";