2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2023 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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.ncmp.init;
23 import com.fasterxml.jackson.databind.ObjectMapper;
24 import java.io.InputStream;
25 import java.nio.charset.StandardCharsets;
26 import java.time.OffsetDateTime;
28 import lombok.NonNull;
29 import lombok.RequiredArgsConstructor;
30 import lombok.extern.slf4j.Slf4j;
31 import org.onap.cps.api.CpsAdminService;
32 import org.onap.cps.api.CpsDataService;
33 import org.onap.cps.api.CpsModuleService;
34 import org.onap.cps.ncmp.api.impl.exception.NcmpStartUpException;
35 import org.onap.cps.spi.CascadeDeleteAllowed;
36 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
37 import org.onap.cps.utils.JsonObjectMapper;
38 import org.springframework.beans.factory.annotation.Value;
39 import org.springframework.boot.SpringApplication;
40 import org.springframework.boot.context.event.ApplicationReadyEvent;
43 @RequiredArgsConstructor
44 abstract class AbstractModelLoader implements ModelLoader {
46 private final CpsAdminService cpsAdminService;
47 private final CpsModuleService cpsModuleService;
48 private final CpsDataService cpsDataService;
50 private static final int EXIT_CODE_ON_ERROR = 1;
52 private final JsonObjectMapper jsonObjectMapper = new JsonObjectMapper(new ObjectMapper());
54 @Value("${ncmp.model-loader.maximum-attempt-count:20}")
55 int maximumAttemptCount;
57 @Value("${ncmp.timers.model-loader.retry-time-ms:1000}")
61 public void onApplicationEvent(@NonNull final ApplicationReadyEvent applicationReadyEvent) {
63 onboardOrUpgradeModel();
64 } catch (final NcmpStartUpException ncmpStartUpException) {
65 log.error("Onboarding model for NCMP failed: {} ", ncmpStartUpException.getMessage());
66 SpringApplication.exit(applicationReadyEvent.getApplicationContext(), () -> EXIT_CODE_ON_ERROR);
70 void waitUntilDataspaceIsAvailable(final String dataspaceName) {
71 log.info("Model Loader start-up, waiting for database to be ready");
73 while (cpsAdminService.getDataspace(dataspaceName) == null) {
74 if (attemptCount < maximumAttemptCount) {
76 Thread.sleep(attemptCount * retryTimeMs);
77 log.info("Retrieving dataspace {} ... {} attempt(s) ", dataspaceName, ++attemptCount);
78 } catch (final InterruptedException e) {
79 Thread.currentThread().interrupt();
82 throw new NcmpStartUpException("Retrieval of NCMP dataspace failed",
83 dataspaceName + " not available (yet)");
88 void createSchemaSet(final String dataspaceName, final String schemaSetName, final String resourceName) {
90 final Map<String, String> yangResourceContentMap = createYangResourceToContentMap(resourceName);
91 cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, yangResourceContentMap);
92 } catch (final AlreadyDefinedException alreadyDefinedException) {
93 log.warn("Creating new schema set failed as schema set already exists");
94 } catch (final Exception exception) {
95 log.error("Creating schema set failed: {} ", exception.getMessage());
96 throw new NcmpStartUpException("Creating schema set failed", exception.getMessage());
100 void deleteUnusedSchemaSets(final String dataspaceName, final String... schemaSetNames) {
101 for (final String schemaSetName : schemaSetNames) {
103 cpsModuleService.deleteSchemaSet(
104 dataspaceName, schemaSetName, CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED);
105 } catch (final Exception exception) {
106 log.warn("Deleting schema set failed: {} ", exception.getMessage());
111 void createAnchor(final String dataspaceName, final String schemaSetName, final String anchorName) {
113 cpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName);
114 } catch (final AlreadyDefinedException alreadyDefinedException) {
115 log.warn("Creating new anchor failed as anchor already exists");
116 } catch (final Exception exception) {
117 log.error("Creating anchor failed: {} ", exception.getMessage());
118 throw new NcmpStartUpException("Creating anchor failed", exception.getMessage());
122 void createTopLevelDataNode(final String dataspaceName, final String anchorName, final String dataNodeName) {
123 final String nodeData = jsonObjectMapper.asJsonString(Map.of(dataNodeName, Map.of()));
125 cpsDataService.saveData(dataspaceName, anchorName, nodeData, OffsetDateTime.now());
126 } catch (final AlreadyDefinedException exception) {
127 log.warn("Creating new data node '{}' failed as data node already exists", dataNodeName);
128 } catch (final Exception exception) {
129 log.error("Creating data node failed: {}", exception.getMessage());
130 throw new NcmpStartUpException("Creating data node failed", exception.getMessage());
134 void updateAnchorSchemaSet(final String dataspaceName, final String anchorName, final String schemaSetName) {
136 cpsAdminService.updateAnchorSchemaSet(dataspaceName, anchorName, schemaSetName);
137 } catch (final Exception exception) {
138 log.error("Updating schema set failed: {}", exception.getMessage());
139 throw new NcmpStartUpException("Updating schema set failed", exception.getMessage());
143 Map<String, String> createYangResourceToContentMap(final String resourceName) {
144 return Map.of(resourceName, getFileContentAsString("models/" + resourceName));
147 private String getFileContentAsString(final String fileName) {
148 try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream(fileName)) {
149 return new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
150 } catch (final Exception exception) {
151 final String message = String.format("Onboarding failed as unable to read file: %s", fileName);
153 throw new NcmpStartUpException(message, exception.getMessage());