From 02bffef6d216ed03206526d49a4fb20124bfafe9 Mon Sep 17 00:00:00 2001 From: emaclee Date: Thu, 9 Feb 2023 15:17:13 +0000 Subject: JAVA onboarding of YANG model - removed docker compose init container - removed init container script files - created new model loader class to onboard YANG model which runs after the application has set up - new model loader class is created in new package in cps-service (org.onap.cps.ncmp.init) Issue-ID: CPS-1467 Signed-off-by: emaclee Change-Id: I35fe82817aff7783520acf8db66ad504271026bd --- .../api/impl/exception/NcmpStartUpException.java | 37 ++++++ .../java/org/onap/cps/ncmp/init/ModelLoader.java | 52 +++++++++ .../cps/ncmp/init/SubscriptionModelLoader.java | 124 +++++++++++++++++++++ 3 files changed, 213 insertions(+) create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/exception/NcmpStartUpException.java create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/ModelLoader.java create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/SubscriptionModelLoader.java (limited to 'cps-ncmp-service/src/main/java/org/onap') diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/exception/NcmpStartUpException.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/exception/NcmpStartUpException.java new file mode 100644 index 000000000..7ac26f54f --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/exception/NcmpStartUpException.java @@ -0,0 +1,37 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2023 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.api.impl.exception; + +/** + * NCMP start up exception. + */ +public class NcmpStartUpException extends NcmpException { + + /** + * Constructor. + * + * @param message the error message + * @param details the error details + */ + public NcmpStartUpException(final String message, final String details) { + super(message, details); + } +} \ No newline at end of file diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/ModelLoader.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/ModelLoader.java new file mode 100644 index 000000000..6f834b702 --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/ModelLoader.java @@ -0,0 +1,52 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2023 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.init; + +import java.util.Map; +import lombok.NonNull; +import org.springframework.boot.context.event.ApplicationReadyEvent; +import org.springframework.context.ApplicationListener; + +public interface ModelLoader extends ApplicationListener { + + @Override + void onApplicationEvent(@NonNull ApplicationReadyEvent applicationReadyEvent); + + /** + * Create schema set. + * + * @param dataspaceName dataspace name + * @param schemaSetName schemaset name + * @param yangResourceContentMap yang resource content map + * @return true if schema set is created + */ + boolean createSchemaSet(String dataspaceName, String schemaSetName, Map yangResourceContentMap); + + /** + * Create anchor. + * + * @param dataspaceName dataspace name + * @param schemaSetName schemaset name + * @param anchorName anchor name + * @return true if anchor is created + */ + boolean createAnchor(String dataspaceName, String schemaSetName, String anchorName); +} diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/SubscriptionModelLoader.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/SubscriptionModelLoader.java new file mode 100644 index 000000000..6713491e6 --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/SubscriptionModelLoader.java @@ -0,0 +1,124 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2023 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.init; + +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import lombok.NonNull; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.onap.cps.api.CpsAdminService; +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.boot.SpringApplication; +import org.springframework.boot.context.event.ApplicationReadyEvent; +import org.springframework.stereotype.Component; + +@Slf4j +@Component +@RequiredArgsConstructor +public class SubscriptionModelLoader implements ModelLoader { + + private final CpsAdminService cpsAdminService; + private final CpsModuleService cpsModuleService; + 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"; + + /** + * Method calls boarding subscription model when Application is ready. + * + * @param applicationReadyEvent the event to respond to + */ + @Override + public void onApplicationEvent(@NonNull final ApplicationReadyEvent applicationReadyEvent) { + try { + onboardSubscriptionModel(); + } catch (final NcmpStartUpException ncmpStartUpException) { + log.debug("Onboarding model for NCMP failed: {} ", ncmpStartUpException.getMessage()); + SpringApplication.exit(applicationReadyEvent.getApplicationContext(), () -> 1); + } + } + + /** + * Method to onboard subscription model for NCMP. + */ + private void onboardSubscriptionModel() { + final Map yangResourceContentMap = createYangResourceToContentMap(); + if (!yangResourceContentMap.get("subscription.yang").isEmpty()) { + createSchemaSet(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, yangResourceContentMap); + createAnchor(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, SUBSCRIPTION_ANCHOR_NAME); + } + } + + + @Override + public boolean createSchemaSet(final String dataspaceName, + final String schemaSetName, + final Map 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; + } + + /** + * 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 String getFileContentAsString() { + try (InputStream inputStream = ClassLoader.getSystemClassLoader() + .getResourceAsStream("model/subscription.yang")) { + return new String(inputStream.readAllBytes(), StandardCharsets.UTF_8); + } catch (final Exception exception) { + log.debug("Onboarding failed as unable to read file: {}", exception.getCause().toString()); + throw new NcmpStartUpException("Onboarding failed as unable to read file: {}", exception.getMessage()); + } + } + + private Map createYangResourceToContentMap() { + return Map.of("subscription.yang", getFileContentAsString()); + } +} -- cgit 1.2.3-korg