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.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     @Override
  77     public CompositeState getCmHandleState(final String cmHandleId) {
  78         final DataNode stateAsDataNode = cpsDataService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  79             String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId) + "/state",
  80             FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
  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 = String.format("{\"state\":%s}",
  87             jsonObjectMapper.asJsonString(compositeState));
  88         cpsDataService.updateDataNodeAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
  89             String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId),
  90             cmHandleJsonData, OffsetDateTime.now());
  91     }
  92
  93     @Override
  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                 String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId),
  98                 String.format("{\"state\":%s}", jsonObjectMapper.asJsonString(compositeState))));
  99         cpsDataService.updateDataNodesAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 100                 cmHandlesJsonDataMap, OffsetDateTime.now());
 101     }
 102
 103     @Override
 104     public YangModelCmHandle getYangModelCmHandle(final String cmHandleId) {
 105         CpsValidator.validateNameCharacters(cmHandleId);
 106         return YangDataConverter.convertCmHandleToYangModel(getCmHandleDataNode(cmHandleId), cmHandleId);
 107     }
 108
 109     @Override
 110     public Collection<ModuleDefinition> getModuleDefinitionsByCmHandleId(final String cmHandleId) {
 111         return cpsModuleService.getModuleDefinitionsByAnchorName(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 112     }
 113
 114     @Override
 115     public Collection<ModuleReference> getYangResourcesModuleReferences(final String cmHandleId) {
 116         CpsValidator.validateNameCharacters(cmHandleId);
 117         return cpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, cmHandleId);
 118     }
 119
 120     @Override
 121     public void saveCmHandle(final YangModelCmHandle yangModelCmHandle) {
 122         final String cmHandleJsonData =
 123                 String.format("{\"cm-handles\":[%s]}", jsonObjectMapper.asJsonString(yangModelCmHandle));
 124         cpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
 125                 cmHandleJsonData, NO_TIMESTAMP);
 126     }
 127
 128     @Override
 129     public void saveCmHandleBatch(final Collection<YangModelCmHandle> yangModelCmHandles) {
 130         final List<String> cmHandlesJsonData = new ArrayList<>();
 131         yangModelCmHandles.forEach(yangModelCmHandle -> cmHandlesJsonData.add(
 132                 String.format("{\"cm-handles\":[%s]}", jsonObjectMapper.asJsonString(yangModelCmHandle))));
 133         cpsDataService.saveListElementsBatch(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 134                 NCMP_DMI_REGISTRY_PARENT, cmHandlesJsonData, NO_TIMESTAMP);
 135     }
 136
 137     @Override
 138     public void deleteListOrListElement(final String listElementXpath) {
 139         cpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 140                 listElementXpath, NO_TIMESTAMP);
 141     }
 142
 143     @Override
 144     public void deleteSchemaSetWithCascade(final String schemaSetName) {
 145         try {
 146             CpsValidator.validateNameCharacters(schemaSetName);
 147             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetName,
 148                     CASCADE_DELETE_ALLOWED);
 149         } catch (final SchemaSetNotFoundException schemaSetNotFoundException) {
 150             log.warn("Schema set {} does not exist or already deleted", schemaSetName);
 151         }
 152     }
 153
 154     @Override
 155     public DataNode getDataNode(final String xpath) {
 156         return cpsDataPersistenceService.getDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 157                 xpath, INCLUDE_ALL_DESCENDANTS);
 158     }
 159
 160     @Override
 161     public DataNode getCmHandleDataNode(final String cmHandleId) {
 162         return this.getDataNode(String.format(CM_HANDLE_XPATH_TEMPLATE, cmHandleId));
 163     }
 164
 165     @Override
 166     public Collection<Anchor> queryAnchors(final Collection<String> moduleNamesForQuery) {
 167         return  cpsAdminPersistenceService.queryAnchors(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, moduleNamesForQuery);
 168     }
 169
 170     @Override
 171     public Collection<Anchor> getAnchors() {
 172         return cpsAdminPersistenceService.getAnchors(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME);
 173     }
 174
 175     @Override
 176     public void replaceListContent(final String parentNodeXpath, final Collection<DataNode> dataNodes) {
 177         cpsDataService.replaceListContent(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
 178                 parentNodeXpath, dataNodes, NO_TIMESTAMP);
 179     }
 180
 181     @Override
 182     public void deleteDataNode(final String dataNodeXpath) {
 183         cpsDataService.deleteDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, dataNodeXpath,
 184                 NO_TIMESTAMP);
 185     }
 186 }