cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/InventoryPersistenceImpl.java

   1 /*
   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
  10  *
  11  *        http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  *  SPDX-License-Identifier: Apache-2.0
  20  *  ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.cps.ncmp.api.inventory;
  24
  25 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
  26 import static org.onap.cps.ncmp.api.impl.constants.DmiRegistryConstants.NO_TIMESTAMP;
  27 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED;
  28 import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS;
  29
  30 import io.micrometer.core.annotation.Timed;
  31 import java.time.OffsetDateTime;
  32 import java.util.ArrayList;
  33 import java.util.Collection;
  34 import java.util.HashMap;
  35 import java.util.List;
  36 import java.util.Map;
  37 import lombok.RequiredArgsConstructor;
  38 import lombok.extern.slf4j.Slf4j;
  39 import org.onap.cps.api.CpsAdminService;
  40 import org.onap.cps.api.CpsDataService;
  41 import org.onap.cps.api.CpsModuleService;
  42 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
  43 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  44 import org.onap.cps.spi.FetchDescendantsOption;
  45 import org.onap.cps.spi.exceptions.DataValidationException;
  46 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
  47 import org.onap.cps.spi.model.DataNode;
  48 import org.onap.cps.spi.model.ModuleDefinition;
  49 import org.onap.cps.spi.model.ModuleReference;
  50 import org.onap.cps.spi.utils.CpsValidator;
  51 import org.onap.cps.utils.JsonObjectMapper;
  52 import org.springframework.stereotype.Component;
  53
  54 @Slf4j
  55 @RequiredArgsConstructor
  56 @Component
  57 public class InventoryPersistenceImpl implements InventoryPersistence {
  58
  59     private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
  60
  61     private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
  62
  63     private static final String NCMP_DMI_REGISTRY_PARENT = "/dmi-registry";
  64
  65     private final JsonObjectMapper jsonObjectMapper;
  66
  67     private final CpsDataService cpsDataService;
  68
  69     private final CpsModuleService cpsModuleService;
  70
  71     private final CpsAdminService cpsAdminService;
  72
  73     private final CpsValidator cpsValidator;
  74
  75     @Override
  76     public CompositeState getCmHandleState(final String cmHandleId) {
  77         final DataNode stateAsDataNode = cpsDataService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  78                 createCmHandleXPath(cmHandleId) + "/state",
  79                 FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS).iterator().next();
  80         cpsValidator.validateNameCharacters(cmHandleId);
  81         return new CompositeStateBuilder().fromDataNode(stateAsDataNode).build();
  82     }
  83
  84     @Override
  85     public void saveCmHandleState(final String cmHandleId, final CompositeState compositeState) {
  86         final String cmHandleJsonData = createStateJsonData(jsonObjectMapper.asJsonString(compositeState));
  87         cpsDataService.updateDataNodeAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  88                 createCmHandleXPath(cmHandleId),
  89                 cmHandleJsonData, OffsetDateTime.now());
  90     }
  91
  92     @Override
  93     public void saveCmHandleStateBatch(final Map<String, CompositeState> cmHandleStatePerCmHandleId) {
  94         final Map<String, String> cmHandlesJsonDataMap = new HashMap<>();
  95         cmHandleStatePerCmHandleId.forEach((cmHandleId, compositeState) -> cmHandlesJsonDataMap.put(
  96                 createCmHandleXPath(cmHandleId),
  97                 createStateJsonData(jsonObjectMapper.asJsonString(compositeState))));
  98         cpsDataService.updateDataNodesAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  99                 cmHandlesJsonDataMap, OffsetDateTime.now());
 100     }
 101
 102     @Override
 103     public YangModelCmHandle getYangModelCmHandle(final String cmHandleId) {
 104         cpsValidator.validateNameCharacters(cmHandleId);
 105         final DataNode dataNode = getCmHandleDataNode(cmHandleId).iterator().next();
 106         return YangDataConverter.convertCmHandleToYangModel(dataNode, cmHandleId);
 107     }
 108
 109     @Override
 110     public Collection<YangModelCmHandle> getYangModelCmHandles(final Collection<String> cmHandleIds) {
 111         final Collection<String> validCmHandleIds = new ArrayList<>(cmHandleIds.size());
 112         cmHandleIds.forEach(cmHandleId -> {
 113             try {
 114                 cpsValidator.validateNameCharacters(cmHandleId);
 115                 validCmHandleIds.add(cmHandleId);
 116             } catch (final DataValidationException dataValidationException) {
 117                 log.error("DataValidationException in CmHandleId {} to be ignored",
 118                         dataValidationException.getMessage());
 119             }
 120         });
 121         return YangDataConverter.convertDataNodesToYangModelCmHandles(getCmHandleDataNodes(validCmHandleIds));
 122     }
 123
 124     @Override
 125     public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) {
 126         return cpsModuleService.getModuleDefinitionsByAnchorName(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 127     }
 128
 129     @Override
 130     public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
 131         cpsValidator.validateNameCharacters(cmHandleId);
 132         return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 133     }
 134
 135     @Override
 136     public void saveCmHandle(final YangModelCmHandle yangModelCmHandle) {
 137         final String cmHandleJsonData =
 138                 createCmHandleJsonData(jsonObjectMapper.asJsonString(yangModelCmHandle));
 139         cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 140                 cmHandleJsonData, NO_TIMESTAMP);
 141     }
 142
 143     @Override
 144     public void saveCmHandleBatch(final Collection<YangModelCmHandle> yangModelCmHandles) {
 145         final List<String> cmHandlesJsonData = new ArrayList<>();
 146         yangModelCmHandles.forEach(yangModelCmHandle -> cmHandlesJsonData.add(
 147                 createCmHandleJsonData(jsonObjectMapper.asJsonString(yangModelCmHandle))));
 148         cpsDataService.saveListElementsBatch(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 149                 NCMP_DMI_REGISTRY_PARENT, cmHandlesJsonData, NO_TIMESTAMP);
 150     }
 151
 152     @Override
 153     public void deleteListOrListElement(final String listElementXpath) {
 154         cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 155                 listElementXpath, NO_TIMESTAMP);
 156     }
 157
 158     @Override
 159     @Timed(value = "cps.ncmp.inventory.persistence.schemaset.delete",
 160             description = "Time taken to delete a schemaset")
 161     public void deleteSchemaSetWithCascade(final String schemaSetName) {
 162         try {
 163             cpsValidator.validateNameCharacters(schemaSetName);
 164             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 165                     CASCADE_DELETE_ALLOWED);
 166         } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
 167             log.warn("Schema set {} does not exist or already deleted", schemaSetName);
 168         }
 169     }
 170
 171     @Override
 172     @Timed(value = "cps.ncmp.inventory.persistence.schemaset.delete.batch",
 173         description = "Time taken to delete multiple schemaset")
 174     public void deleteSchemaSetsWithCascade(final Collection<String> schemaSetNames) {
 175         cpsValidator.validateNameCharacters(schemaSetNames);
 176         cpsModuleService.deleteSchemaSetsWithCascade(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetNames);
 177     }
 178
 179     @Override
 180     @Timed(value = "cps.ncmp.inventory.persistence.datanode.get",
 181             description = "Time taken to get a data node (from ncmp dmi registry)")
 182     public Collection<DataNode> getDataNode(final String xpath) {
 183         return getDataNode(xpath, INCLUDE_ALL_DESCENDANTS);
 184     }
 185
 186     @Override
 187     @Timed(value = "cps.ncmp.inventory.persistence.datanode.get",
 188             description = "Time taken to get a data node (from ncmp dmi registry)")
 189     public Collection<DataNode> getDataNode(final String xpath, final FetchDescendantsOption fetchDescendantsOption) {
 190         return cpsDataService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 191                 xpath, fetchDescendantsOption);
 192     }
 193
 194     @Override
 195     public Collection<DataNode> getDataNodes(final Collection<String> xpaths) {
 196         return getDataNodes(xpaths, INCLUDE_ALL_DESCENDANTS);
 197     }
 198
 199     @Override
 200     public Collection<DataNode> getDataNodes(final Collection<String> xpaths,
 201                                              final FetchDescendantsOption fetchDescendantsOption) {
 202         return cpsDataService.getDataNodesForMultipleXpaths(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 203                 xpaths, fetchDescendantsOption);
 204     }
 205
 206     @Override
 207     public Collection<DataNode> getCmHandleDataNode(final String cmHandleId) {
 208         return this.getDataNode(createCmHandleXPath(cmHandleId));
 209     }
 210
 211     @Override
 212     public Collection<DataNode> getCmHandleDataNodes(final Collection<String> cmHandleIds) {
 213         final Collection<String> xpaths = new ArrayList<>(cmHandleIds.size());
 214         cmHandleIds.forEach(cmHandleId -> xpaths.add(createCmHandleXPath(cmHandleId)));
 215         return this.getDataNodes(xpaths);
 216     }
 217
 218     @Override
 219     public Collection<String> getCmHandleIdsWithGivenModules(final Collection<String> moduleNamesForQuery) {
 220         return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNamesForQuery);
 221     }
 222
 223     @Override
 224     public void replaceListContent(final String parentNodeXpath, final Collection<DataNode> dataNodes) {
 225         cpsDataService.replaceListContent(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 226                 parentNodeXpath, dataNodes, NO_TIMESTAMP);
 227     }
 228
 229     @Override
 230     public void deleteDataNode(final String dataNodeXpath) {
 231         cpsDataService.deleteDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, dataNodeXpath, NO_TIMESTAMP);
 232     }
 233
 234     @Override
 235     public void deleteDataNodes(final Collection<String> dataNodeXpaths) {
 236         cpsDataService.deleteDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, dataNodeXpaths, NO_TIMESTAMP);
 237     }
 238
 239     private static String createCmHandleXPath(final String cmHandleId) {
 240         return "/dmi-registry/cm-handles[@id='" + cmHandleId + "']";
 241     }
 242
 243     private static String createStateJsonData(final String state) {
 244         return "{\"state\":" + state + "}";
 245     }
 246
 247     private static String createCmHandleJsonData(final String yangModelCmHandleAsJson) {
 248         return "{\"cm-handles\":[" + yangModelCmHandleAsJson + "]}";
 249     }
 250 }