Merge "RTD change to document migration to Spring Boot 3.0"
[cps.git] / cps-ncmp-service / src / main / java / org / onap / cps / ncmp / api / impl / inventory / sync / ModuleSyncService.java
1 /*
2  *  ============LICENSE_START=======================================================
3  *  Copyright (C) 2022-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
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.api.impl.inventory.sync;
22
23 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME;
24
25 import java.util.Collection;
26 import java.util.Collections;
27 import java.util.Map;
28 import lombok.RequiredArgsConstructor;
29 import lombok.extern.slf4j.Slf4j;
30 import org.onap.cps.api.CpsAdminService;
31 import org.onap.cps.api.CpsModuleService;
32 import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations;
33 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
34 import org.onap.cps.spi.CascadeDeleteAllowed;
35 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
36 import org.onap.cps.spi.model.ModuleReference;
37 import org.springframework.stereotype.Service;
38
39 @Slf4j
40 @Service
41 @RequiredArgsConstructor
42 public class ModuleSyncService {
43
44     private final DmiModelOperations dmiModelOperations;
45     private final CpsModuleService cpsModuleService;
46
47     private final CpsAdminService cpsAdminService;
48
49     /**
50      * This method registers a cm handle and initiates modules sync.
51      *
52      * @param yangModelCmHandle the yang model of cm handle.
53      */
54     public void syncAndCreateSchemaSetAndAnchor(final YangModelCmHandle yangModelCmHandle) {
55
56         final Collection<ModuleReference> allModuleReferencesFromCmHandle =
57                 dmiModelOperations.getModuleReferences(yangModelCmHandle);
58
59         final Collection<ModuleReference> identifiedNewModuleReferencesFromCmHandle = cpsModuleService
60                 .identifyNewModuleReferences(allModuleReferencesFromCmHandle);
61
62         final Map<String, String> newModuleNameToContentMap;
63         if (identifiedNewModuleReferencesFromCmHandle.isEmpty()) {
64             newModuleNameToContentMap = Collections.emptyMap();
65         } else {
66             newModuleNameToContentMap = dmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle,
67                     identifiedNewModuleReferencesFromCmHandle);
68         }
69         createSchemaSetAndAnchor(yangModelCmHandle, newModuleNameToContentMap, allModuleReferencesFromCmHandle);
70     }
71
72     private void createSchemaSetAndAnchor(final YangModelCmHandle yangModelCmHandle,
73                                           final Map<String, String> newModuleNameToContentMap,
74                                           final Collection<ModuleReference> allModuleReferencesFromCmHandle) {
75         final String schemaSetAndAnchorName = yangModelCmHandle.getId();
76         cpsModuleService.createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetAndAnchorName,
77                         newModuleNameToContentMap, allModuleReferencesFromCmHandle);
78         cpsAdminService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetAndAnchorName,
79             schemaSetAndAnchorName);
80     }
81
82     /**
83      * Deletes the SchemaSet for schema set id if the SchemaSet Exists.
84      *
85      * @param schemaSetId the schema set id to be deleted
86      */
87     public void deleteSchemaSetIfExists(final String schemaSetId) {
88         try {
89             cpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, schemaSetId,
90                 CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED);
91             log.debug("SchemaSet for {} has been deleted. Ready to be recreated.", schemaSetId);
92         } catch (final SchemaSetNotFoundException e) {
93             log.debug("No SchemaSet for {}. Assuming CmHandle has not been previously Module Synced.", schemaSetId);
94         }
95     }
96
97 }