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.SchemaSetNotFoundException;
45 import org.onap.cps.spi.model.DataNode;
46 import org.onap.cps.spi.model.ModuleDefinition;
47 import org.onap.cps.spi.model.ModuleReference;
48 import org.onap.cps.spi.utils.CpsValidator;
49 import org.onap.cps.utils.JsonObjectMapper;
50 import org.springframework.stereotype.Component;
53 @RequiredArgsConstructor
55 public class InventoryPersistenceImpl implements InventoryPersistence {
57 private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
59 private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
61 private static final String NCMP_DMI_REGISTRY_PARENT = "/dmi-registry";
63 private static final String CM_HANDLE_XPATH_TEMPLATE = "/dmi-registry/cm-handles[@id='" + "%s" + "']";
65 private final JsonObjectMapper jsonObjectMapper;
67 private final CpsDataService cpsDataService;
69 private final CpsModuleService cpsModuleService;
71 private final CpsAdminService cpsAdminService;
73 private final CpsValidator cpsValidator;
76 public CompositeState getCmHandleState(final String cmHandleId) {
77 final DataNode stateAsDataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
78 String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId) + "/state",
79 FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
80 cpsValidator.validateNameCharacters(cmHandleId);
81 return new CompositeStateBuilder().fromDataNode(stateAsDataNode).build();
85 public void saveCmHandleState(final String cmHandleId, final CompositeState compositeState) {
86 final String cmHandleJsonData = String.format("{\"state\":%s}",
87 jsonObjectMapper.asJsonString(compositeState));
88 cpsDataService.updateDataNodeAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
89 String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId),
90 cmHandleJsonData, OffsetDateTime.now());
94 public void saveCmHandleStateBatch(final Map<String, CompositeState> cmHandleStatePerCmHandleId) {
95 final Map<String, String> cmHandlesJsonDataMap = new HashMap<>();
96 cmHandleStatePerCmHandleId.forEach((cmHandleId, compositeState) -> cmHandlesJsonDataMap.put(
97 String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId),
98 String.format("{\"state\":%s}", jsonObjectMapper.asJsonString(compositeState))));
99 cpsDataService.updateDataNodesAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
100 cmHandlesJsonDataMap, OffsetDateTime.now());
104 public YangModelCmHandle getYangModelCmHandle(final String cmHandleId) {
105 cpsValidator.validateNameCharacters(cmHandleId);
106 return YangDataConverter.convertCmHandleToYangModel(getCmHandleDataNode(cmHandleId), cmHandleId);
110 public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) {
111 return cpsModuleService.getModuleDefinitionsByAnchorName(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
115 public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
116 cpsValidator.validateNameCharacters(cmHandleId);
117 return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
121 public void saveCmHandle(final YangModelCmHandle yangModelCmHandle) {
122 final String cmHandleJsonData =
123 String.format("{\"cm-handles\":[%s]}", jsonObjectMapper.asJsonString(yangModelCmHandle));
124 cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
125 cmHandleJsonData, NO_TIMESTAMP);
129 public void saveCmHandleBatch(final Collection<YangModelCmHandle> yangModelCmHandles) {
130 final List<String> cmHandlesJsonData = new ArrayList<>();
131 yangModelCmHandles.forEach(yangModelCmHandle -> cmHandlesJsonData.add(
132 String.format("{\"cm-handles\":[%s]}", jsonObjectMapper.asJsonString(yangModelCmHandle))));
133 cpsDataService.saveListElementsBatch(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
134 NCMP_DMI_REGISTRY_PARENT, cmHandlesJsonData, NO_TIMESTAMP);
138 public void deleteListOrListElement(final String listElementXpath) {
139 cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
140 listElementXpath, NO_TIMESTAMP);
144 @Timed(value = "cps.ncmp.inventory.persistence.schemaset.delete",
145 description = "Time taken to delete a schemaset")
146 public void deleteSchemaSetWithCascade(final String schemaSetName) {
148 cpsValidator.validateNameCharacters(schemaSetName);
149 cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
150 CASCADE_DELETE_ALLOWED);
151 } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
152 log.warn("Schema set {} does not exist or already deleted", schemaSetName);
157 public DataNode getDataNode(final String xpath) {
158 return getDataNode(xpath, INCLUDE_ALL_DESCENDANTS);
162 @Timed(value = "cps.ncmp.inventory.persistence.datanode.get",
163 description = "Time taken to get a data node (from ncmp dmi registry)")
164 public DataNode getDataNode(final String xpath, final FetchDescendantsOption fetchDescendantsOption) {
165 return cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
166 xpath, fetchDescendantsOption);
170 public DataNode getCmHandleDataNode(final String cmHandleId) {
171 return this.getDataNode(String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId));
175 public Collection<String> getCmHandleIdsWithGivenModules(final Collection<String> moduleNamesForQuery) {
176 return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNamesForQuery);
180 public void replaceListContent(final String parentNodeXpath, final Collection<DataNode> dataNodes) {
181 cpsDataService.replaceListContent(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
182 parentNodeXpath, dataNodes, NO_TIMESTAMP);
186 public void deleteDataNode(final String dataNodeXpath) {
187 cpsDataService.deleteDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, dataNodeXpath,