cps/cps-service/src/main/java/org/onap/cps/api/CpService.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 java.io.IOException;
  24 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  25 import org.opendaylight.yangtools.yang.model.parser.api.YangParserException;
  26
  27 /**
  28  * Configuration and persistency service interface which holds methods for parsing and storing yang models and data.
  29  */
  30 public interface CpService {
  31
  32     /**
  33      * Parse and validate a string representing a yang model to generate a schema context.
  34      *
  35      * @param yangModelContent the input stream
  36      * @return the schema context
  37      */
  38     SchemaContext parseAndValidateModel(final String yangModelContent) throws IOException, YangParserException;
  39
  40     /**
  41      * Parse and validate a file representing a yang model to generate a schema context.
  42      *
  43      * @param yangModelFile the yang file
  44      * @return the schema context
  45      */
  46     SchemaContext parseAndValidateModel(final File yangModelFile) throws IOException, YangParserException;
  47
  48     /**
  49      * Store schema context for a yang model.
  50      *
  51      * @param schemaContext the schema context
  52      */
  53     void storeSchemaContext(final SchemaContext schemaContext);
  54
  55     /**
  56      * Store the JSON structure in the database.
  57      *
  58      * @param jsonStructure the JSON structure.
  59      * @return entity ID.
  60      */
  61     Integer storeJsonStructure(final String jsonStructure);
  62 }