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.Collection;
  24 import java.util.Map;
  25 import org.onap.cps.spi.model.ModuleReference;
  26
  27 /**
  28  * Service to manage modules.
  29  */
  30 public interface CpsModulePersistenceService {
  31
  32     /**
  33      * TODO
  34      * clean up method to conform with spi proposal - https://jira.onap.org/browse/CPS-103
  35      * Store the module from a yang model in the database.
  36      * @deprecated
  37      *
  38      * @param namespace     module namespace
  39      * @param moduleContent module content
  40      * @param revision      module revision
  41      * @param dataspaceName the name of the dataspace the module is associated with
  42      */
  43     @Deprecated(forRemoval = true)
  44     void storeModule(final String namespace, final String moduleContent, final String revision,
  45                      final String dataspaceName);
  46
  47
  48     /**
  49      * Stores Schema Set.
  50      *
  51      * @param dataspaceName                 dataspace name
  52      * @param schemaSetName                 schema set name
  53      * @param yangResourcesNameToContentMap YANG resources (files) map where key is a name and value is content
  54      */
  55     void storeSchemaSet(String dataspaceName, String schemaSetName, Map<String, String> yangResourcesNameToContentMap);
  56
  57     /**
  58      * Returns Modules references per specific namespace / schemaSetName.
  59      *
  60      * @param namespace     module namespace
  61      * @param schemaSetName schema set name
  62      * @return collection of ModuleRef
  63      */
  64     Collection<ModuleReference> getModuleReferences(String namespace, String schemaSetName);
  65 }