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.CpsDataService;
  38 import org.onap.cps.api.CpsModuleService;
  39 import org.onap.cps.ncmp.api.impl.utils.YangDataConverter;
  40 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  41 import org.onap.cps.spi.CpsAdminPersistenceService;
  42 import org.onap.cps.spi.CpsDataPersistenceService;
  43 import org.onap.cps.spi.FetchDescendantsOption;
  44 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
  45 import org.onap.cps.spi.model.Anchor;
  46 import org.onap.cps.spi.model.DataNode;
  47 import org.onap.cps.spi.model.ModuleDefinition;
  48 import org.onap.cps.spi.model.ModuleReference;
  49 import org.onap.cps.spi.utils.CpsValidator;
  50 import org.onap.cps.utils.JsonObjectMapper;
  51 import org.springframework.stereotype.Component;
  52
  53 @Slf4j
  54 @RequiredArgsConstructor
  55 @Component
  56 public class InventoryPersistenceImpl implements InventoryPersistence {
  57
  58     private static final String NCMP_DATASPACE_NAME = "NCMP-Admin";
  59
  60     private static final String NCMP_DMI_REGISTRY_ANCHOR = "ncmp-dmi-registry";
  61
  62     private static final String NCMP_DMI_REGISTRY_PARENT = "/dmi-registry";
  63
  64     private static final String CM_HANDLE_XPATH_TEMPLATE = "/dmi-registry/cm-handles[@id='" + "%s" + "']";
  65
  66     private final JsonObjectMapper jsonObjectMapper;
  67
  68     private final CpsDataService cpsDataService;
  69
  70     private final CpsModuleService cpsModuleService;
  71
  72     private final CpsDataPersistenceService cpsDataPersistenceService;
  73
  74     private final CpsAdminPersistenceService cpsAdminPersistenceService;
  75
  76     private final CpsValidator cpsValidator;
  77
  78     @Override
  79     public CompositeState getCmHandleState(final String cmHandleId) {
  80         final DataNode stateAsDataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  81             String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId) + "/state",
  82             FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
  83         cpsValidator.validateNameCharacters(cmHandleId);
  84         return new CompositeStateBuilder().fromDataNode(stateAsDataNode).build();
  85     }
  86
  87     @Override
  88     public void saveCmHandleState(final String cmHandleId, final CompositeState compositeState) {
  89         final String cmHandleJsonData = String.format("{\"state\":%s}",
  90                 jsonObjectMapper.asJsonString(compositeState));
  91         cpsDataService.updateDataNodeAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  92                 String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId),
  93                 cmHandleJsonData, OffsetDateTime.now());
  94     }
  95
  96     @Override
  97     public void saveCmHandleStateBatch(final Map<String, CompositeState> cmHandleStatePerCmHandleId) {
  98         final Map<String, String> cmHandlesJsonDataMap = new HashMap<>();
  99         cmHandleStatePerCmHandleId.forEach((cmHandleId, compositeState) -> cmHandlesJsonDataMap.put(
 100                 String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId),
 101                 String.format("{\"state\":%s}", jsonObjectMapper.asJsonString(compositeState))));
 102         cpsDataService.updateDataNodesAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 103                 cmHandlesJsonDataMap, OffsetDateTime.now());
 104     }
 105
 106     @Override
 107     public YangModelCmHandle getYangModelCmHandle(final String cmHandleId) {
 108         cpsValidator.validateNameCharacters(cmHandleId);
 109         return YangDataConverter.convertCmHandleToYangModel(getCmHandleDataNode(cmHandleId), cmHandleId);
 110     }
 111
 112     @Override
 113     public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) {
 114         return cpsModuleService.getModuleDefinitionsByAnchorName(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 115     }
 116
 117     @Override
 118     public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
 119         cpsValidator.validateNameCharacters(cmHandleId);
 120         return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 121     }
 122
 123     @Override
 124     public void saveCmHandle(final YangModelCmHandle yangModelCmHandle) {
 125         final String cmHandleJsonData =
 126                 String.format("{\"cm-handles\":[%s]}", jsonObjectMapper.asJsonString(yangModelCmHandle));
 127         cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 128                 cmHandleJsonData, NO_TIMESTAMP);
 129     }
 130
 131     @Override
 132     public void saveCmHandleBatch(final Collection<YangModelCmHandle> yangModelCmHandles) {
 133         final List<String> cmHandlesJsonData = new ArrayList<>();
 134         yangModelCmHandles.forEach(yangModelCmHandle -> cmHandlesJsonData.add(
 135                 String.format("{\"cm-handles\":[%s]}", jsonObjectMapper.asJsonString(yangModelCmHandle))));
 136         cpsDataService.saveListElementsBatch(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 137                 NCMP_DMI_REGISTRY_PARENT, cmHandlesJsonData, NO_TIMESTAMP);
 138     }
 139
 140     @Override
 141     public void deleteListOrListElement(final String listElementXpath) {
 142         cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 143                 listElementXpath, NO_TIMESTAMP);
 144     }
 145
 146     @Override
 147     public void deleteSchemaSetWithCascade(final String schemaSetName) {
 148         try {
 149             cpsValidator.validateNameCharacters(schemaSetName);
 150             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 151                     CASCADE_DELETE_ALLOWED);
 152         } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
 153             log.warn("Schema set {} does not exist or already deleted", schemaSetName);
 154         }
 155     }
 156
 157     @Override
 158     public DataNode getDataNode(final String xpath) {
 159         return getDataNode(xpath, INCLUDE_ALL_DESCENDANTS);
 160     }
 161
 162     @Override
 163     public DataNode getDataNode(final String xpath, final FetchDescendantsOption fetchDescendantsOption) {
 164         return cpsDataPersistenceService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 165                 xpath, fetchDescendantsOption);
 166     }
 167
 168     @Override
 169     public DataNode getCmHandleDataNode(final String cmHandleId) {
 170         return this.getDataNode(String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId));
 171     }
 172
 173     @Override
 174     public Collection<Anchor> queryAnchors(final Collection<String> moduleNamesForQuery) {
 175         return cpsAdminPersistenceService.queryAnchors(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNamesForQuery);
 176     }
 177
 178     @Override
 179     public Collection<Anchor> getAnchors() {
 180         return cpsAdminPersistenceService.getAnchors(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME);
 181     }
 182
 183     @Override
 184     public void replaceListContent(final String parentNodeXpath, final Collection<DataNode> dataNodes) {
 185         cpsDataService.replaceListContent(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 186                 parentNodeXpath, dataNodes, NO_TIMESTAMP);
 187     }
 188
 189     @Override
 190     public void deleteDataNode(final String dataNodeXpath) {
 191         cpsDataService.deleteDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, dataNodeXpath,
 192                 NO_TIMESTAMP);
 193     }
 194 }