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;
25 import org.checkerframework.checker.nullness.qual.NonNull;
26 import org.onap.cps.spi.exceptions.DataInUseException;
29 * Service to manage modules.
31 public interface CpsModulePersistenceService {
36 * @param dataspaceName dataspace name
37 * @param schemaSetName schema set name
38 * @param yangResourcesNameToContentMap YANG resources (files) map where key is a name and value is content
40 void storeSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
41 @NonNull Map<String, String> yangResourcesNameToContentMap);
46 * @param dataspaceName dataspace name
47 * @param schemaSetName schema set name
48 * @param cascadeDeleteAllowed indicates the allowance to remove associated anchors and data if exist
49 * @throws DataInUseException if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
50 * is associated anchor record exists in database
52 void deleteSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
53 @NonNull CascadeDeleteAllowed cascadeDeleteAllowed);
56 * Returns YANG resources per specific dataspace / schemaSetName.
58 * @param dataspaceName dataspace name
59 * @param schemaSetName schema set name
60 * @return YANG resources (files) map where key is a name and value is content
63 Map<String, String> getYangSchemaResources(@NonNull String dataspaceName,
64 @NonNull String schemaSetName);
67 * Returns YANG resources per specific dataspace / anchorName.
69 * @param dataspaceName dataspace name
70 * @param anchorName anchor name
71 * @return YANG resources (files) map where key is a name and value is content
74 Map<String, String> getYangSchemaSetResources(@NonNull String dataspaceName,
75 @NonNull String anchorName);