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.io.File;
  23 import org.onap.cps.exceptions.CpsValidationException;
  24 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  25
  26 /**
  27  * Responsible for managing module sets.
  28  */
  29 public interface CpsModuleService {
  30
  31     /**
  32      * Parse and validate a string representing a yang model to generate a schema context.
  33      *
  34      * @param yangModelContent the input stream
  35      * @return the schema context
  36      */
  37     SchemaContext parseAndValidateModel(String yangModelContent);
  38
  39     /**
  40      * Parse and validate a file representing a yang model to generate a schema context.
  41      *
  42      * @param yangModelFile the yang file
  43      * @return the schema context
  44      */
  45     SchemaContext parseAndValidateModel(File yangModelFile);
  46
  47     /**
  48      * Store schema context for a yang model.
  49      *
  50      * @param schemaContext the schema context
  51      * @param dataspaceName the dataspace name
  52      * @throws CpsValidationException if input data already exists.
  53      */
  54     void storeSchemaContext(SchemaContext schemaContext, String dataspaceName);
  55 }