Merge "RTD change to document migration to Spring Boot 3.0"
[cps.git] / cps-ncmp-service / src / main / java / org / onap / cps / ncmp / init / SubscriptionModelLoader.java
index 231ba75..4d1a91c 100644 (file)
 
 package org.onap.cps.ncmp.init;
 
-import java.io.InputStream;
-import java.nio.charset.StandardCharsets;
-import java.time.OffsetDateTime;
-import java.util.Map;
-import lombok.RequiredArgsConstructor;
+import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DATASPACE_NAME;
+
 import lombok.extern.slf4j.Slf4j;
 import org.onap.cps.api.CpsAdminService;
 import org.onap.cps.api.CpsDataService;
 import org.onap.cps.api.CpsModuleService;
-import org.onap.cps.ncmp.api.impl.exception.NcmpStartUpException;
-import org.onap.cps.spi.exceptions.AlreadyDefinedException;
 import org.springframework.beans.factory.annotation.Value;
-import org.springframework.boot.SpringApplication;
-import org.springframework.boot.context.event.ApplicationReadyEvent;
-import org.springframework.stereotype.Component;
+import org.springframework.stereotype.Service;
 
 @Slf4j
-@Component
-@RequiredArgsConstructor
-public class SubscriptionModelLoader implements ModelLoader {
-
-    private final CpsAdminService cpsAdminService;
-    private final CpsModuleService cpsModuleService;
-    private final CpsDataService cpsDataService;
-    private static final String SUBSCRIPTION_MODEL_FILENAME = "subscription.yang";
-    private static final String SUBSCRIPTION_MODEL_RESOURCE_PATH = "model/" + SUBSCRIPTION_MODEL_FILENAME;
-    private static final String SUBSCRIPTION_DATASPACE_NAME = "NCMP-Admin";
-    private static final String SUBSCRIPTION_ANCHOR_NAME = "AVC-Subscriptions";
-    private static final String SUBSCRIPTION_SCHEMASET_NAME = "subscriptions";
-    private static final String SUBSCRIPTION_REGISTRY_DATANODE_NAME = "subscription-registry";
+@Service
+public class SubscriptionModelLoader extends AbstractModelLoader {
 
-    @Value("${ncmp.model-loader.subscription:false}")
-    private boolean subscriptionModelLoaderEnabled;
+    private static final String MODEL_FILENAME = "subscription.yang";
+    private static final String ANCHOR_NAME = "AVC-Subscriptions";
+    private static final String SCHEMASET_NAME = "subscriptions";
+    private static final String REGISTRY_DATANODE_NAME = "subscription-registry";
 
-    /**
-     * Method calls boarding subscription model when Application is ready.
-     *
-     * @param applicationReadyEvent the event to respond to
-     */
-    @Override
-    public void onApplicationEvent(final ApplicationReadyEvent applicationReadyEvent) {
-        try {
-            if (subscriptionModelLoaderEnabled) {
-                onboardSubscriptionModel(createYangResourceToContentMap());
-            } else {
-                log.info("Subscription Model Loader is disabled");
-            }
-        } catch (final NcmpStartUpException ncmpStartUpException) {
-            log.debug("Onboarding model for NCMP failed: {} ", ncmpStartUpException.getMessage());
-            SpringApplication.exit(applicationReadyEvent.getApplicationContext(), () -> 1);
-        }
+    public SubscriptionModelLoader(final CpsAdminService cpsAdminService,
+                                   final CpsModuleService cpsModuleService,
+                                   final CpsDataService cpsDataService) {
+        super(cpsAdminService, cpsModuleService, cpsDataService);
     }
 
-    /**
-     * Method to onboard subscription model for NCMP.
-     */
-    private void onboardSubscriptionModel(final Map<String, String> yangResourceContentMap) {
-        createSchemaSet(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, yangResourceContentMap);
-        createAnchor(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, SUBSCRIPTION_ANCHOR_NAME);
-        createTopLevelDataNode(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_ANCHOR_NAME,
-            SUBSCRIPTION_REGISTRY_DATANODE_NAME);
-    }
-
-
-    @Override
-    public boolean createSchemaSet(final String dataspaceName,
-                                   final String schemaSetName,
-                                   final Map<String, String> yangResourceContentMap) {
-        try {
-            cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, yangResourceContentMap);
-        } catch (final AlreadyDefinedException exception) {
-            log.info("Creating new schema set failed as schema set already exists");
-        } catch (final Exception exception) {
-            log.debug("Creating schema set for subscription model failed: {} ", exception.getMessage());
-            throw new NcmpStartUpException("Creating schema set failed", exception.getMessage());
-        }
-        return true;
-    }
+    @Value("${ncmp.model-loader.subscription:true}")
+    private boolean subscriptionModelLoaderEnabled;
 
-    /**
-     * Create Anchor.
-     *
-     * @param dataspaceName dataspace name
-     * @param schemaSetName schema set name
-     * @param anchorName anchor name
-     */
     @Override
-    public boolean createAnchor(final String dataspaceName, final String schemaSetName,
-                             final String anchorName) {
-        try {
-            cpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName);
-        } catch (final AlreadyDefinedException exception) {
-            log.info("Creating new anchor failed as anchor already exists");
-        } catch (final Exception exception) {
-            log.debug("Creating anchor for subscription model failed: {} ", exception.getMessage());
-            throw new NcmpStartUpException("Creating anchor failed", exception.getMessage());
-        }
-        return true;
-    }
-
-    private void createTopLevelDataNode(final String dataspaceName,
-                                        final String anchorName,
-                                        final String dataNodeName) {
-        final String nodeData = "{\"" + dataNodeName + "\":{}}";
-        try {
-            cpsDataService.saveData(dataspaceName, anchorName, nodeData, OffsetDateTime.now());
-        } catch (final AlreadyDefinedException exception) {
-            log.info("Creating new data node '{}' failed as data node already exists", dataNodeName);
-        } catch (final Exception exception) {
-            log.debug("Creating data node for subscription model failed: {}", exception.getMessage());
-            throw new NcmpStartUpException("Creating data node failed", exception.getMessage());
+    public void onboardOrUpgradeModel() {
+        if (subscriptionModelLoaderEnabled) {
+            waitUntilDataspaceIsAvailable(NCMP_DATASPACE_NAME);
+            onboardSubscriptionModel();
+            log.info("Subscription Model onboarded successfully");
+        } else {
+            log.info("Subscription Model Loader is disabled");
         }
     }
 
-    private String getFileContentAsString(final String fileName) {
-        try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream(fileName)) {
-            return new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
-        } catch (final Exception exception) {
-            final String message = String.format("Onboarding failed as unable to read file: %s", fileName);
-            log.debug(message);
-            throw new NcmpStartUpException(message, exception.getMessage());
-        }
+    private void onboardSubscriptionModel() {
+        createSchemaSet(NCMP_DATASPACE_NAME, SCHEMASET_NAME, MODEL_FILENAME);
+        createAnchor(NCMP_DATASPACE_NAME, SCHEMASET_NAME, ANCHOR_NAME);
+        createTopLevelDataNode(NCMP_DATASPACE_NAME, ANCHOR_NAME, REGISTRY_DATANODE_NAME);
     }
 
-    private Map<String, String> createYangResourceToContentMap() {
-        return Map.of(SUBSCRIPTION_MODEL_FILENAME, getFileContentAsString(SUBSCRIPTION_MODEL_RESOURCE_PATH));
-    }
 }