2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020 Nordix Foundation
4 * Modifications Copyright (C) 2020 Bell Canada.
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.spi;
24 import java.util.Collection;
25 import java.util.List;
27 import org.checkerframework.checker.nullness.qual.NonNull;
28 import org.onap.cps.spi.exceptions.DataInUseException;
29 import org.onap.cps.spi.model.ModuleReference;
32 * Service to manage modules.
34 public interface CpsModulePersistenceService {
39 * @param dataspaceName dataspace name
40 * @param schemaSetName schema set name
41 * @param yangResourcesNameToContentMap YANG resources (files) map where key is a name and value is content
43 void storeSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
44 @NonNull Map<String, String> yangResourcesNameToContentMap);
47 * Stores a schema set from new modules and existing modules.
49 * @param dataspaceName Dataspace name
50 * @param schemaSetName Schema set name
51 * @param newYangResourcesModuleNameToContentMap YANG resources map where key is a module name and value is content
52 * @param moduleReferences List of YANG resources module references
54 void storeSchemaSetFromModules(@NonNull String dataspaceName, @NonNull String schemaSetName,
55 @NonNull Map<String, String> newYangResourcesModuleNameToContentMap,
56 @NonNull List<ModuleReference> moduleReferences);
61 * @param dataspaceName dataspace name
62 * @param schemaSetName schema set name
63 * @param cascadeDeleteAllowed indicates the allowance to remove associated anchors and data if exist
64 * @throws DataInUseException if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
65 * is associated anchor record exists in database
67 void deleteSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
68 @NonNull CascadeDeleteAllowed cascadeDeleteAllowed);
71 * Returns YANG resources per specific dataspace / schemaSetName.
73 * @param dataspaceName dataspace name
74 * @param schemaSetName schema set name
75 * @return YANG resources (files) map where key is a name and value is content
78 Map<String, String> getYangSchemaResources(@NonNull String dataspaceName,
79 @NonNull String schemaSetName);
82 * Returns YANG resources per specific dataspace / anchorName.
84 * @param dataspaceName dataspace name
85 * @param anchorName anchor name
86 * @return YANG resources (files) map where key is a name and value is content
89 Map<String, String> getYangSchemaSetResources(@NonNull String dataspaceName,
90 @NonNull String anchorName);
93 * Returns all YANG resources module references for the given dataspace name.
95 * @param dataspaceName dataspace name
96 * @return Collection of all YANG resources module information in the database
98 Collection<ModuleReference> getAllYangResourceModuleReferences(final String dataspaceName);
101 * Get all YANG resource module references for the given anchor name and dataspace name.
103 * @param dataspaceName dataspace name
104 * @param anchorName anchor name
105 * @return a collection of module names and revisions
107 Collection<ModuleReference> getAllYangResourceModuleReferences(final String dataspaceName,
108 final String anchorName);