2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020 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.List;
26 import org.checkerframework.checker.nullness.qual.NonNull;
27 import org.onap.cps.spi.CascadeDeleteAllowed;
28 import org.onap.cps.spi.exceptions.DataInUseException;
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(@NonNull String dataspaceName, @NonNull String schemaSetName,
46 @NonNull Map<String, String> yangResourcesNameToContentMap);
49 * Create a schema set from new modules and existing modules.
51 * @param dataspaceName Dataspace name
52 * @param schemaSetName schema set name
53 * @param newYangResourcesModuleNameToContentMap YANG resources map where key is a module name and value is content
54 * @param moduleReferenceList List of YANG resources module references
56 void createSchemaSetFromModules(@NonNull String dataspaceName, @NonNull String schemaSetName,
57 @NonNull Map<String, String> newYangResourcesModuleNameToContentMap,
58 @NonNull List<ModuleReference> moduleReferenceList);
61 * Read schema set in the given dataspace.
63 * @param dataspaceName dataspace name
64 * @param schemaSetName schema set name
67 SchemaSet getSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName);
72 * @param dataspaceName dataspace name
73 * @param schemaSetName schema set name
74 * @param cascadeDeleteAllowed indicates the allowance to remove associated anchors and data if exist
75 * @throws DataInUseException if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
76 * is associated anchor record exists in database
78 void deleteSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
79 @NonNull CascadeDeleteAllowed cascadeDeleteAllowed);
82 * Retrieve all modules and revisions known by CPS for all Yang Resources.
84 * @return a list of ModuleReference objects
86 List<ModuleReference> getAllYangResourcesModuleReferences();