cps-service/src/main/java/org/onap/cps/api/CpsModuleService.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  *
  16  *  SPDX-License-Identifier: Apache-2.0
  17  *  ============LICENSE_END=========================================================
  18  */
  19
  20 package org.onap.cps.api;
  21
  22 import java.util.Map;
  23 import org.checkerframework.checker.nullness.qual.NonNull;
  24 import org.onap.cps.spi.CascadeDeleteAllowed;
  25 import org.onap.cps.spi.exceptions.DataInUseException;
  26 import org.onap.cps.spi.model.SchemaSet;
  27
  28 /**
  29  * Responsible for managing module sets.
  30  */
  31 public interface CpsModuleService {
  32
  33     /**
  34      * Create schema set.
  35      *
  36      * @param dataspaceName                 dataspace name
  37      * @param schemaSetName                 schema set name
  38      * @param yangResourcesNameToContentMap yang resources (files) as a mep where key is resource name
  39      *                                      and value is content
  40      */
  41     void createSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
  42                          @NonNull Map<String, String> yangResourcesNameToContentMap);
  43
  44     /**
  45      * Read schema set in the given dataspace.
  46      *
  47      * @param dataspaceName dataspace name
  48      * @param schemaSetName schema set name
  49      * @return a SchemaSet
  50      */
  51     SchemaSet getSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName);
  52
  53     /**
  54      * Deletes Schema Set.
  55      *
  56      * @param dataspaceName        dataspace name
  57      * @param schemaSetName        schema set name
  58      * @param cascadeDeleteAllowed indicates the allowance to remove associated anchors and data if exist
  59      * @throws DataInUseException if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
  60      *                           is associated anchor record exists in database
  61      */
  62     void deleteSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
  63         @NonNull CascadeDeleteAllowed cascadeDeleteAllowed);
  64 }