2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022-2024 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 com.google.common.collect.Lists;
26 import java.time.OffsetDateTime;
27 import java.util.ArrayList;
28 import java.util.Collection;
29 import java.util.Collections;
30 import java.util.HashMap;
31 import java.util.List;
33 import lombok.extern.slf4j.Slf4j;
34 import org.onap.cps.api.CpsAnchorService;
35 import org.onap.cps.api.CpsDataService;
36 import org.onap.cps.api.CpsModuleService;
37 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
38 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
39 import org.onap.cps.spi.FetchDescendantsOption;
40 import org.onap.cps.spi.exceptions.DataValidationException;
41 import org.onap.cps.spi.model.DataNode;
42 import org.onap.cps.spi.model.ModuleDefinition;
43 import org.onap.cps.spi.model.ModuleReference;
44 import org.onap.cps.spi.utils.CpsValidator;
45 import org.onap.cps.utils.JsonObjectMapper;
46 import org.springframework.stereotype.Component;
50 public class InventoryPersistenceImpl extends NcmpPersistenceImpl implements InventoryPersistence {
52 private static final int CMHANDLE_BATCH_SIZE = 100;
54 private final CpsModuleService cpsModuleService;
55 private final CpsAnchorService cpsAnchorService;
56 private final CpsValidator cpsValidator;
59 * initialize an inventory persistence object.
61 * @param jsonObjectMapper json mapper object
62 * @param cpsDataService cps data service instance
63 * @param cpsModuleService cps module service instance
64 * @param cpsValidator cps validation service instance
65 * @param cpsAnchorService cps anchor service instance
67 public InventoryPersistenceImpl(final JsonObjectMapper jsonObjectMapper, final CpsDataService cpsDataService,
68 final CpsModuleService cpsModuleService, final CpsValidator cpsValidator,
69 final CpsAnchorService cpsAnchorService) {
70 super(jsonObjectMapper, cpsDataService, cpsModuleService, cpsValidator);
71 this.cpsModuleService = cpsModuleService;
72 this.cpsAnchorService = cpsAnchorService;
73 this.cpsValidator = cpsValidator;
78 public CompositeState getCmHandleState(final String cmHandleId) {
79 final DataNode stateAsDataNode = cpsDataService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
80 createCmHandleXPath(cmHandleId) + "/state", FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS)
82 cpsValidator.validateNameCharacters(cmHandleId);
83 return new CompositeStateBuilder().fromDataNode(stateAsDataNode).build();
87 public void saveCmHandleState(final String cmHandleId, final CompositeState compositeState) {
88 final String cmHandleJsonData = createStateJsonData(jsonObjectMapper.asJsonString(compositeState));
89 cpsDataService.updateDataNodeAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
90 createCmHandleXPath(cmHandleId), 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 createCmHandleXPath(cmHandleId),
98 createStateJsonData(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 final DataNode dataNode = getCmHandleDataNode(cmHandleId).iterator().next();
107 return YangDataConverter.convertCmHandleToYangModel(dataNode, cmHandleId);
111 public Collection<YangModelCmHandle> getYangModelCmHandles(final Collection<String> cmHandleIds) {
112 final Collection<String> validCmHandleIds = new ArrayList<>(cmHandleIds.size());
113 cmHandleIds.forEach(cmHandleId -> {
115 cpsValidator.validateNameCharacters(cmHandleId);
116 validCmHandleIds.add(cmHandleId);
117 } catch (final DataValidationException dataValidationException) {
118 log.error("DataValidationException in CmHandleId {} to be ignored",
119 dataValidationException.getMessage());
122 return YangDataConverter.convertDataNodesToYangModelCmHandles(getCmHandleDataNodes(validCmHandleIds));
126 public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) {
127 return cpsModuleService.getModuleDefinitionsByAnchorName(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
131 public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
132 cpsValidator.validateNameCharacters(cmHandleId);
133 return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
137 public void saveCmHandle(final YangModelCmHandle yangModelCmHandle) {
138 saveCmHandleBatch(Collections.singletonList(yangModelCmHandle));
142 public void saveCmHandleBatch(final List<YangModelCmHandle> yangModelCmHandles) {
143 for (final List<YangModelCmHandle> yangModelCmHandleBatch :
144 Lists.partition(yangModelCmHandles, CMHANDLE_BATCH_SIZE)) {
145 final String cmHandlesJsonData = createCmHandlesJsonData(yangModelCmHandleBatch);
146 cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
147 NCMP_DMI_REGISTRY_PARENT, cmHandlesJsonData, NO_TIMESTAMP);
152 public Collection<DataNode> getCmHandleDataNode(final String cmHandleId) {
153 return this.getDataNode(createCmHandleXPath(cmHandleId));
157 public Collection<DataNode> getCmHandleDataNodes(final Collection<String> cmHandleIds) {
158 final Collection<String> xpaths = new ArrayList<>(cmHandleIds.size());
159 cmHandleIds.forEach(cmHandleId -> xpaths.add(createCmHandleXPath(cmHandleId)));
160 return this.getDataNodes(xpaths);
164 public Collection<String> getCmHandleIdsWithGivenModules(final Collection<String> moduleNamesForQuery) {
165 return cpsAnchorService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNamesForQuery);
168 private static String createCmHandleXPath(final String cmHandleId) {
169 return NCMP_DMI_REGISTRY_PARENT + "/cm-handles[@id='" + cmHandleId + "']";
172 private static String createStateJsonData(final String state) {
173 return "{\"state\":" + state + "}";
176 private String createCmHandlesJsonData(final List<YangModelCmHandle> yangModelCmHandles) {
177 return "{\"cm-handles\":" + jsonObjectMapper.asJsonString(yangModelCmHandles) + "}";