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
  26 /**
  27  * Service to manage modules.
  28  */
  29 public interface CpsModulePersistenceService {
  30
  31     /**
  32      * Stores Schema Set.
  33      *
  34      * @param dataspaceName                 dataspace name
  35      * @param schemaSetName                 schema set name
  36      * @param yangResourcesNameToContentMap YANG resources (files) map where key is a name and value is content
  37      */
  38     void storeSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
  39             @NonNull Map<String, String> yangResourcesNameToContentMap);
  40
  41     /**
  42      * Returns YANG resources per specific namespace / schemaSetName.
  43      *
  44      * @param namespace     module namespace
  45      * @param schemaSetName schema set name
  46      * @return YANG resources (files) map where key is a name and value is content
  47      */
  48     @NonNull
  49     Map<String, String> getYangSchemaResources(@NonNull String namespace, @NonNull String schemaSetName);
  50 }