aai-schema-ingest/src/main/java/org/onap/aai/setup/Translator.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-18 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *   http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.aai.setup;
  22
  23 import java.io.*;
  24 import java.util.List;
  25
  26 /**
  27  * Converts the contents of the schema config file
  28  * (which lists which schema files to be loaded) to
  29  * the format the Ingestors can work with.
  30  *
  31  */
  32 public abstract class Translator {
  33
  34     protected SchemaVersions schemaVersions;
  35
  36     public Translator(SchemaVersions schemaVersions) {
  37         this.schemaVersions = schemaVersions;
  38     }
  39
  40     /**
  41      * Translates the contents of the schema config file
  42      * into the input for the NodeIngestor
  43      *
  44      * @return Map of Version to the list of (string) filenames to be
  45      *         ingested for that version
  46      */
  47
  48     public abstract List<InputStream> getVersionNodeStream(SchemaVersion version) throws IOException;
  49
  50     public abstract List<String> getJsonPayload(SchemaVersion version) throws IOException;
  51
  52     /**
  53      * Translates the contents of the schema config file
  54      * into the input for the EdgeIngestor
  55      *
  56      * @return Map of Version to the List of (String) filenames to be
  57      *         ingested for that version
  58      */
  59
  60     public SchemaVersions getSchemaVersions() {
  61         return this.schemaVersions;
  62     }
  63 }