2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022-2023 Nordix Foundation
4 * Modifications Copyright (C) 2022 Bell Canada
5 * Modifications Copyright (C) 2023 TechMahindra Ltd.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.cps.ncmp.api.impl.inventory;
25 import java.time.OffsetDateTime;
26 import java.util.ArrayList;
27 import java.util.Collection;
28 import java.util.HashMap;
29 import java.util.List;
31 import lombok.extern.slf4j.Slf4j;
32 import org.onap.cps.api.CpsAnchorService;
33 import org.onap.cps.api.CpsDataService;
34 import org.onap.cps.api.CpsModuleService;
35 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
36 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
37 import org.onap.cps.spi.FetchDescendantsOption;
38 import org.onap.cps.spi.exceptions.DataValidationException;
39 import org.onap.cps.spi.model.DataNode;
40 import org.onap.cps.spi.model.ModuleDefinition;
41 import org.onap.cps.spi.model.ModuleReference;
42 import org.onap.cps.spi.utils.CpsValidator;
43 import org.onap.cps.utils.JsonObjectMapper;
44 import org.springframework.stereotype.Component;
48 public class InventoryPersistenceImpl extends NcmpPersistenceImpl implements InventoryPersistence {
50 private final CpsModuleService cpsModuleService;
51 private final CpsAnchorService cpsAnchorService;
52 private final CpsValidator cpsValidator;
55 * initialize an inventory persistence object.
57 * @param jsonObjectMapper json mapper object
58 * @param cpsDataService cps data service instance
59 * @param cpsModuleService cps module service instance
60 * @param cpsValidator cps validation service instance
61 * @param cpsAnchorService cps anchor service instance
63 public InventoryPersistenceImpl(final JsonObjectMapper jsonObjectMapper, final CpsDataService cpsDataService,
64 final CpsModuleService cpsModuleService, final CpsValidator cpsValidator,
65 final CpsAnchorService cpsAnchorService) {
66 super(jsonObjectMapper, cpsDataService, cpsModuleService, cpsValidator);
67 this.cpsModuleService = cpsModuleService;
68 this.cpsAnchorService = cpsAnchorService;
69 this.cpsValidator = cpsValidator;
74 public CompositeState getCmHandleState(final String cmHandleId) {
75 final DataNode stateAsDataNode = cpsDataService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
76 createCmHandleXPath(cmHandleId) + "/state", FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS)
78 cpsValidator.validateNameCharacters(cmHandleId);
79 return new CompositeStateBuilder().fromDataNode(stateAsDataNode).build();
83 public void saveCmHandleState(final String cmHandleId, final CompositeState compositeState) {
84 final String cmHandleJsonData = createStateJsonData(jsonObjectMapper.asJsonString(compositeState));
85 cpsDataService.updateDataNodeAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
86 createCmHandleXPath(cmHandleId), cmHandleJsonData, OffsetDateTime.now());
90 public void saveCmHandleStateBatch(final Map<String, CompositeState> cmHandleStatePerCmHandleId) {
91 final Map<String, String> cmHandlesJsonDataMap = new HashMap<>();
92 cmHandleStatePerCmHandleId.forEach((cmHandleId, compositeState) -> cmHandlesJsonDataMap.put(
93 createCmHandleXPath(cmHandleId),
94 createStateJsonData(jsonObjectMapper.asJsonString(compositeState))));
95 cpsDataService.updateDataNodesAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
96 cmHandlesJsonDataMap, OffsetDateTime.now());
100 public YangModelCmHandle getYangModelCmHandle(final String cmHandleId) {
101 cpsValidator.validateNameCharacters(cmHandleId);
102 final DataNode dataNode = getCmHandleDataNode(cmHandleId).iterator().next();
103 return YangDataConverter.convertCmHandleToYangModel(dataNode, cmHandleId);
107 public Collection<YangModelCmHandle> getYangModelCmHandles(final Collection<String> cmHandleIds) {
108 final Collection<String> validCmHandleIds = new ArrayList<>(cmHandleIds.size());
109 cmHandleIds.forEach(cmHandleId -> {
111 cpsValidator.validateNameCharacters(cmHandleId);
112 validCmHandleIds.add(cmHandleId);
113 } catch (final DataValidationException dataValidationException) {
114 log.error("DataValidationException in CmHandleId {} to be ignored",
115 dataValidationException.getMessage());
118 return YangDataConverter.convertDataNodesToYangModelCmHandles(getCmHandleDataNodes(validCmHandleIds));
122 public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) {
123 return cpsModuleService.getModuleDefinitionsByAnchorName(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
127 public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
128 cpsValidator.validateNameCharacters(cmHandleId);
129 return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
133 public void saveCmHandle(final YangModelCmHandle yangModelCmHandle) {
134 final String cmHandleJsonData =
135 createCmHandleJsonData(jsonObjectMapper.asJsonString(yangModelCmHandle));
136 cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
137 cmHandleJsonData, NO_TIMESTAMP);
141 public void saveCmHandleBatch(final Collection<YangModelCmHandle> yangModelCmHandles) {
142 final List<String> cmHandlesJsonData = new ArrayList<>();
143 yangModelCmHandles.forEach(yangModelCmHandle -> cmHandlesJsonData.add(
144 createCmHandleJsonData(jsonObjectMapper.asJsonString(yangModelCmHandle))));
145 cpsDataService.saveListElementsBatch(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
146 NCMP_DMI_REGISTRY_PARENT, cmHandlesJsonData, NO_TIMESTAMP);
150 public Collection<DataNode> getCmHandleDataNode(final String cmHandleId) {
151 return this.getDataNode(createCmHandleXPath(cmHandleId));
155 public Collection<DataNode> getCmHandleDataNodes(final Collection<String> cmHandleIds) {
156 final Collection<String> xpaths = new ArrayList<>(cmHandleIds.size());
157 cmHandleIds.forEach(cmHandleId -> xpaths.add(createCmHandleXPath(cmHandleId)));
158 return this.getDataNodes(xpaths);
162 public Collection<String> getCmHandleIdsWithGivenModules(final Collection<String> moduleNamesForQuery) {
163 return cpsAnchorService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNamesForQuery);
166 private static String createCmHandleXPath(final String cmHandleId) {
167 return NCMP_DMI_REGISTRY_PARENT + "/cm-handles[@id='" + cmHandleId + "']";
170 private static String createStateJsonData(final String state) {
171 return "{\"state\":" + state + "}";
174 private static String createCmHandleJsonData(final String yangModelCmHandleAsJson) {
175 return "{\"cm-handles\":[" + yangModelCmHandleAsJson + "]}";