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.
   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  *
  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.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.spi;
  23
  24 import java.util.List;
  25 import java.util.Map;
  26 import org.checkerframework.checker.nullness.qual.NonNull;
  27 import org.onap.cps.spi.exceptions.DataInUseException;
  28 import org.onap.cps.spi.model.ModuleReference;
  29
  30 /**
  31  * Service to manage modules.
  32  */
  33 public interface CpsModulePersistenceService {
  34
  35     /**
  36      * Stores Schema Set.
  37      *
  38      * @param dataspaceName                 dataspace name
  39      * @param schemaSetName                 schema set name
  40      * @param yangResourcesNameToContentMap YANG resources (files) map where key is a name and value is content
  41      */
  42     void storeSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
  43         @NonNull Map<String, String> yangResourcesNameToContentMap);
  44
  45     /**
  46      * Deletes Schema Set.
  47      *
  48      * @param dataspaceName        dataspace name
  49      * @param schemaSetName        schema set name
  50      * @param cascadeDeleteAllowed indicates the allowance to remove associated anchors and data if exist
  51      * @throws DataInUseException if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
  52      *                           is associated anchor record exists in database
  53      */
  54     void deleteSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
  55         @NonNull CascadeDeleteAllowed cascadeDeleteAllowed);
  56
  57     /**
  58      * Returns YANG resources per specific dataspace / schemaSetName.
  59      *
  60      * @param dataspaceName   dataspace name
  61      * @param schemaSetName schema set name
  62      * @return YANG resources (files) map where key is a name and value is content
  63      */
  64     @NonNull
  65     Map<String, String> getYangSchemaResources(@NonNull String dataspaceName,
  66         @NonNull String schemaSetName);
  67
  68     /**
  69      * Returns YANG resources per specific dataspace / anchorName.
  70      *
  71      * @param dataspaceName dataspace name
  72      * @param anchorName anchor name
  73      * @return YANG resources (files) map where key is a name and value is content
  74      */
  75     @NonNull
  76     Map<String, String> getYangSchemaSetResources(@NonNull String dataspaceName,
  77         @NonNull String anchorName);
  78
  79     /**
  80      * Returns all YANG resources module references.
  81      *
  82      * @return List of all YANG resources module information in the database
  83      */
  84     List<ModuleReference> getAllYangResourcesModuleReferences();
  85 }