cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/CmDataSubscriptionModelLoader.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2024 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.init;
  22
  23 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DATASPACE_NAME;
  24 import static org.onap.cps.utils.ContentType.JSON;
  25
  26 import java.time.OffsetDateTime;
  27 import lombok.extern.slf4j.Slf4j;
  28 import org.onap.cps.api.CpsAnchorService;
  29 import org.onap.cps.api.CpsDataService;
  30 import org.onap.cps.api.CpsDataspaceService;
  31 import org.onap.cps.api.CpsModuleService;
  32 import org.onap.cps.ncmp.api.impl.exception.NcmpStartUpException;
  33 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
  34 import org.springframework.beans.factory.annotation.Value;
  35 import org.springframework.stereotype.Service;
  36
  37 @Slf4j
  38 @Service
  39 public class CmDataSubscriptionModelLoader extends AbstractModelLoader {
  40
  41     private static final String MODEL_FILENAME = "cm-data-subscriptions@2023-11-13.yang";
  42     private static final String SCHEMASET_NAME = "cm-data-subscriptions";
  43     private static final String ANCHOR_NAME = "cm-data-subscriptions";
  44     private static final String REGISTRY_DATANODE_NAME = "datastores";
  45     private static final String DATASTORE_PASSTHROUGH_OPERATIONAL = "ncmp-datastores:passthrough-operational";
  46     private static final String DATASTORE_PASSTHROUGH_RUNNING = "ncmp-datastores:passthrough-running";
  47
  48     private static final String DEPRECATED_MODEL_FILENAME = "subscription.yang";
  49     private static final String DEPRECATED_ANCHOR_NAME = "AVC-Subscriptions";
  50     private static final String DEPRECATED_SCHEMASET_NAME = "subscriptions";
  51     private static final String DEPRECATED_REGISTRY_DATANODE_NAME = "subscription-registry";
  52
  53
  54
  55     public CmDataSubscriptionModelLoader(final CpsDataspaceService cpsDataspaceService,
  56                                          final CpsModuleService cpsModuleService,
  57                                          final CpsAnchorService cpsAnchorService,
  58                                          final CpsDataService cpsDataService) {
  59         super(cpsDataspaceService, cpsModuleService, cpsAnchorService, cpsDataService);
  60     }
  61
  62     @Value("${ncmp.model-loader.subscription:true}")
  63     private boolean subscriptionModelLoaderEnabled;
  64
  65     @Override
  66     public void onboardOrUpgradeModel() {
  67         if (subscriptionModelLoaderEnabled) {
  68             waitUntilDataspaceIsAvailable(NCMP_DATASPACE_NAME);
  69             onboardSubscriptionModels();
  70             log.info("Subscription Models onboarded successfully");
  71         } else {
  72             log.info("Subscription Model Loader is disabled");
  73         }
  74     }
  75
  76     private void onboardSubscriptionModels() {
  77         createSchemaSet(NCMP_DATASPACE_NAME, DEPRECATED_SCHEMASET_NAME, DEPRECATED_MODEL_FILENAME);
  78         createAnchor(NCMP_DATASPACE_NAME, DEPRECATED_SCHEMASET_NAME, DEPRECATED_ANCHOR_NAME);
  79         createTopLevelDataNode(NCMP_DATASPACE_NAME, DEPRECATED_ANCHOR_NAME, DEPRECATED_REGISTRY_DATANODE_NAME);
  80
  81         createSchemaSet(NCMP_DATASPACE_NAME, SCHEMASET_NAME, MODEL_FILENAME);
  82         createAnchor(NCMP_DATASPACE_NAME, SCHEMASET_NAME, ANCHOR_NAME);
  83         createTopLevelDataNode(NCMP_DATASPACE_NAME, ANCHOR_NAME, REGISTRY_DATANODE_NAME);
  84         createDatastore(DATASTORE_PASSTHROUGH_OPERATIONAL, DATASTORE_PASSTHROUGH_RUNNING);
  85     }
  86
  87     private void createDatastore(final String... datastoreNames) {
  88         for (final String datastoreName : datastoreNames) {
  89             final String nodeData = "{\"datastore\":[{\"name\":\"" + datastoreName + "\",\"cm-handles\":{}}]}";
  90             try {
  91                 cpsDataService.saveData(NCMP_DATASPACE_NAME, ANCHOR_NAME, "/" + REGISTRY_DATANODE_NAME, nodeData,
  92                         OffsetDateTime.now(), JSON);
  93             } catch (final AlreadyDefinedException exception) {
  94                 log.info("Creating new child data node '{}' for data node '{}' failed as data node already exists",
  95                         datastoreName, REGISTRY_DATANODE_NAME);
  96             } catch (final Exception exception) {
  97                 log.error("Creating data node failed: {}", exception.getMessage());
  98                 throw new NcmpStartUpException("Creating data node failed", exception.getMessage());
  99             }
 100         }
 101     }
 102
 103 }