2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020-2022 Nordix Foundation
4 * Modifications Copyright (C) 2020-2021 Pantheon.tech
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.api;
24 import java.util.Collection;
26 import org.onap.cps.spi.CascadeDeleteAllowed;
27 import org.onap.cps.spi.exceptions.DataInUseException;
28 import org.onap.cps.spi.model.ModuleDefinition;
29 import org.onap.cps.spi.model.ModuleReference;
30 import org.onap.cps.spi.model.SchemaSet;
33 * Responsible for managing module sets.
35 public interface CpsModuleService {
40 * @param dataspaceName dataspace name
41 * @param schemaSetName schema set name
42 * @param yangResourcesNameToContentMap yang resources (files) as a mep where key is resource name
43 * and value is content
45 void createSchemaSet(String dataspaceName, String schemaSetName,
46 Map<String, String> yangResourcesNameToContentMap);
49 * Create a schema set from new modules and existing modules.
50 * @param dataspaceName Dataspace name
51 * @param schemaSetName schema set name
52 * @param newModuleNameToContentMap YANG resources map where key is a module name and value is content
53 * @param moduleReferences List of YANG resources module references of the modules
55 void createSchemaSetFromModules(String dataspaceName, String schemaSetName,
56 Map<String, String> newModuleNameToContentMap,
57 Collection<ModuleReference> moduleReferences);
60 * Read schema set in the given dataspace.
62 * @param dataspaceName dataspace name
63 * @param schemaSetName schema set name
66 SchemaSet getSchemaSet(String dataspaceName, String schemaSetName);
71 * @param dataspaceName dataspace name
72 * @param schemaSetName schema set name
73 * @param cascadeDeleteAllowed indicates the allowance to remove associated anchors and data if exist
74 * @throws DataInUseException if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
75 * is associated anchor record exists in database
77 void deleteSchemaSet(String dataspaceName, String schemaSetName,
78 CascadeDeleteAllowed cascadeDeleteAllowed);
81 * Retrieve module references for the given dataspace name.
83 * @param dataspaceName dataspace name
84 * @return a list of ModuleReference objects
86 Collection<ModuleReference> getYangResourceModuleReferences(String dataspaceName);
89 * Retrieve module references for the given dataspace name and anchor name.
91 * @param dataspaceName dataspace name
92 * @param anchorName anchor name
93 * @return a list of ModuleReference objects
95 Collection<ModuleReference> getYangResourcesModuleReferences(String dataspaceName, String anchorName);
98 * Retrieve module definitions for the given dataspace name and anchor name.
100 * @param dataspaceName dataspace name
101 * @param anchorName anchor name
102 * @return a collection of module definitions (moduleName, revision, yang resource content)
104 Collection<ModuleDefinition> getModuleDefinitionsByAnchorName(String dataspaceName, String anchorName);
107 * Identify previously unknown Yang Resource module references.
108 * The system will ignore the namespace of all module references.
110 * @param moduleReferencesToCheck the moduleReferencesToCheck
111 * @returns collection of module references (namespace will be always blank)
113 Collection<ModuleReference> identifyNewModuleReferences(
114 Collection<ModuleReference> moduleReferencesToCheck);