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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 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
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.ncmp.api.inventory;
  23
  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;
  28
  29 import java.time.OffsetDateTime;
  30 import java.util.ArrayList;
  31 import java.util.Collection;
  32 import java.util.HashMap;
  33 import java.util.List;
  34 import java.util.Map;
  35 import lombok.RequiredArgsConstructor;
  36 import lombok.extern.slf4j.Slf4j;
  37 import org.onap.cps.api.CpsAdminService;
  38 import org.onap.cps.api.CpsDataService;
  39 import org.onap.cps.api.CpsModuleService;
  40 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
  41 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  42 import org.onap.cps.spi.FetchDescendantsOption;
  43 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
  44 import org.onap.cps.spi.model.DataNode;
  45 import org.onap.cps.spi.model.ModuleDefinition;
  46 import org.onap.cps.spi.model.ModuleReference;
  47 import org.onap.cps.spi.utils.CpsValidator;
  48 import org.onap.cps.utils.JsonObjectMapper;
  49 import org.springframework.stereotype.Component;
  50
  51 @Slf4j
  52 @RequiredArgsConstructor
  53 @Component
  54 public class InventoryPersistenceImpl implements InventoryPersistence {
  55
  56     private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
  57
  58     private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
  59
  60     private static final String NCMP_DMI_REGISTRY_PARENT = "/dmi-registry";
  61
  62     private static final String CM_HANDLE_XPATH_TEMPLATE = "/dmi-registry/cm-handles[@id='" + "%s" + "']";
  63
  64     private final JsonObjectMapper jsonObjectMapper;
  65
  66     private final CpsDataService cpsDataService;
  67
  68     private final CpsModuleService cpsModuleService;
  69
  70     private final CpsAdminService cpsAdminService;
  71
  72     private final CpsValidator cpsValidator;
  73
  74     @Override
  75     public CompositeState getCmHandleState(final String cmHandleId) {
  76         final DataNode stateAsDataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  77             String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId) + "/state",
  78             FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
  79         cpsValidator.validateNameCharacters(cmHandleId);
  80         return new CompositeStateBuilder().fromDataNode(stateAsDataNode).build();
  81     }
  82
  83     @Override
  84     public void saveCmHandleState(final String cmHandleId, final CompositeState compositeState) {
  85         final String cmHandleJsonData = String.format("{\"state\":%s}",
  86                 jsonObjectMapper.asJsonString(compositeState));
  87         cpsDataService.updateDataNodeAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  88                 String.format(CM_HANDLE_XPATH_TEMPLATE, 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                 String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId),
  97                 String.format("{\"state\":%s}", 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         return YangDataConverter.convertCmHandleToYangModel(getCmHandleDataNode(cmHandleId), cmHandleId);
 106     }
 107
 108     @Override
 109     public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) {
 110         return cpsModuleService.getModuleDefinitionsByAnchorName(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 111     }
 112
 113     @Override
 114     public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
 115         cpsValidator.validateNameCharacters(cmHandleId);
 116         return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 117     }
 118
 119     @Override
 120     public void saveCmHandle(final YangModelCmHandle yangModelCmHandle) {
 121         final String cmHandleJsonData =
 122                 String.format("{\"cm-handles\":[%s]}", jsonObjectMapper.asJsonString(yangModelCmHandle));
 123         cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 124                 cmHandleJsonData, NO_TIMESTAMP);
 125     }
 126
 127     @Override
 128     public void saveCmHandleBatch(final Collection<YangModelCmHandle> yangModelCmHandles) {
 129         final List<String> cmHandlesJsonData = new ArrayList<>();
 130         yangModelCmHandles.forEach(yangModelCmHandle -> cmHandlesJsonData.add(
 131                 String.format("{\"cm-handles\":[%s]}", jsonObjectMapper.asJsonString(yangModelCmHandle))));
 132         cpsDataService.saveListElementsBatch(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 133                 NCMP_DMI_REGISTRY_PARENT, cmHandlesJsonData, NO_TIMESTAMP);
 134     }
 135
 136     @Override
 137     public void deleteListOrListElement(final String listElementXpath) {
 138         cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 139                 listElementXpath, NO_TIMESTAMP);
 140     }
 141
 142     @Override
 143     public void deleteSchemaSetWithCascade(final String schemaSetName) {
 144         try {
 145             cpsValidator.validateNameCharacters(schemaSetName);
 146             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 147                     CASCADE_DELETE_ALLOWED);
 148         } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
 149             log.warn("Schema set {} does not exist or already deleted", schemaSetName);
 150         }
 151     }
 152
 153     @Override
 154     public DataNode getDataNode(final String xpath) {
 155         return getDataNode(xpath, INCLUDE_ALL_DESCENDANTS);
 156     }
 157
 158     @Override
 159     public DataNode getDataNode(final String xpath, final FetchDescendantsOption fetchDescendantsOption) {
 160         return cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 161                 xpath, fetchDescendantsOption);
 162     }
 163
 164     @Override
 165     public DataNode getCmHandleDataNode(final String cmHandleId) {
 166         return this.getDataNode(String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId));
 167     }
 168
 169     @Override
 170     public Collection<String> getCmHandleIdsWithGivenModules(final Collection<String> moduleNamesForQuery) {
 171         return cpsAdminService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNamesForQuery);
 172     }
 173
 174     @Override
 175     public void replaceListContent(final String parentNodeXpath, final Collection<DataNode> dataNodes) {
 176         cpsDataService.replaceListContent(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 177                 parentNodeXpath, dataNodes, NO_TIMESTAMP);
 178     }
 179
 180     @Override
 181     public void deleteDataNode(final String dataNodeXpath) {
 182         cpsDataService.deleteDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, dataNodeXpath,
 183                 NO_TIMESTAMP);
 184     }
 185 }