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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020-2022 Nordix Foundation
   4  *  Modifications Copyright (C) 2020-2021 Pantheon.tech
   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.api;
  23
  24 import java.util.Collection;
  25 import java.util.Map;
  26 import org.checkerframework.checker.nullness.qual.NonNull;
  27 import org.onap.cps.spi.CascadeDeleteAllowed;
  28 import org.onap.cps.spi.exceptions.DataInUseException;
  29 import org.onap.cps.spi.model.ModuleReference;
  30 import org.onap.cps.spi.model.SchemaSet;
  31
  32 /**
  33  * Responsible for managing module sets.
  34  */
  35 public interface CpsModuleService {
  36
  37     /**
  38      * Create schema set.
  39      *
  40      * @param dataspaceName                 dataspace name
  41      * @param schemaSetName                 schema set name
  42      * @param yangResourcesNameToContentMap yang resources (files) as a mep where key is resource name
  43      *                                      and value is content
  44      */
  45     void createSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
  46                          @NonNull Map<String, String> yangResourcesNameToContentMap);
  47
  48     /**
  49      * Create a schema set from new modules and existing modules.
  50      * @param dataspaceName             Dataspace name
  51      * @param schemaSetName             schema set name
  52      * @param newModuleNameToContentMap YANG resources map where key is a module name and value is content
  53      * @param moduleReferences          List of YANG resources module references of the modules
  54      */
  55     void createSchemaSetFromModules(@NonNull String dataspaceName, @NonNull String schemaSetName,
  56                                     @NonNull Map<String, String> newModuleNameToContentMap,
  57                                     Collection<ModuleReference> moduleReferences);
  58
  59     /**
  60      * Read schema set in the given dataspace.
  61      *
  62      * @param dataspaceName dataspace name
  63      * @param schemaSetName schema set name
  64      * @return a SchemaSet
  65      */
  66     SchemaSet getSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName);
  67
  68     /**
  69      * Deletes Schema Set.
  70      *
  71      * @param dataspaceName        dataspace name
  72      * @param schemaSetName        schema set name
  73      * @param cascadeDeleteAllowed indicates the allowance to remove associated anchors and data if exist
  74      * @throws DataInUseException if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
  75      *                           is associated anchor record exists in database
  76      */
  77     void deleteSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
  78         @NonNull CascadeDeleteAllowed cascadeDeleteAllowed);
  79
  80     /**
  81      * Retrieve module references for the given dataspace name.
  82      *
  83      * @param dataspaceName        dataspace name
  84      * @return a list of ModuleReference objects
  85      */
  86     Collection<ModuleReference> getYangResourceModuleReferences(String dataspaceName);
  87
  88     /**
  89      * Retrieve module references for the given dataspace name and anchor name.
  90      *
  91      * @param dataspaceName dataspace name
  92      * @param anchorName    anchor name
  93      * @return a list of ModuleReference objects
  94      */
  95     Collection<ModuleReference> getYangResourcesModuleReferences(String dataspaceName, String anchorName);
  96
  97     /**
  98      * Identify previously unknown Yang Resource module references.
  99      *
 100      * @param moduleReferencesToCheck the moduleReferencesToCheck
 101      * @returns collection of module references
 102      */
 103     Collection<ModuleReference> identifyNewModuleReferences(
 104         Collection<ModuleReference> moduleReferencesToCheck);
 105
 106 }