cps-service/src/main/java/org/onap/cps/spi/CpsModulePersistenceService.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation
   4  *  Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
   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
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  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.spi;
  22
  23 import java.util.Map;
  24 import org.checkerframework.checker.nullness.qual.NonNull;
  25 import org.onap.cps.spi.exceptions.DataInUseException;
  26
  27 /**
  28  * Service to manage modules.
  29  */
  30 public interface CpsModulePersistenceService {
  31
  32     /**
  33      * Stores Schema Set.
  34      *
  35      * @param dataspaceName                 dataspace name
  36      * @param schemaSetName                 schema set name
  37      * @param yangResourcesNameToContentMap YANG resources (files) map where key is a name and value is content
  38      */
  39     void storeSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
  40         @NonNull Map<String, String> yangResourcesNameToContentMap);
  41
  42     /**
  43      * Deletes Schema Set.
  44      *
  45      * @param dataspaceName        dataspace name
  46      * @param schemaSetName        schema set name
  47      * @param cascadeDeleteAllowed indicates the allowance to remove associated anchors and data if exist
  48      * @throws DataInUseException if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
  49      *                           is associated anchor record exists in database
  50      */
  51     void deleteSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
  52         @NonNull CascadeDeleteAllowed cascadeDeleteAllowed);
  53
  54     /**
  55      * Returns YANG resources per specific dataspace / schemaSetName.
  56      *
  57      * @param dataspaceName   dataspace name
  58      * @param schemaSetName schema set name
  59      * @return YANG resources (files) map where key is a name and value is content
  60      */
  61     @NonNull
  62     Map<String, String> getYangSchemaResources(@NonNull String dataspaceName,
  63         @NonNull String schemaSetName);
  64
  65     /**
  66      * Returns YANG resources per specific dataspace / anchorName.
  67      *
  68      * @param dataspaceName dataspace name
  69      * @param anchorName anchor name
  70      * @return YANG resources (files) map where key is a name and value is content
  71      */
  72     @NonNull
  73     Map<String, String> getYangSchemaSetResources(@NonNull String dataspaceName,
  74         @NonNull String anchorName);
  75 }