src/main/java/org/onap/aai/babel/xml/generator/api/ArtifactGenerator.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved.
   6  * Copyright (c) 2017-2019 European Software Marketing Ltd.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.aai.babel.xml.generator.api;
  23
  24 import java.util.List;
  25 import java.util.Map;
  26 import org.onap.aai.babel.xml.generator.data.Artifact;
  27 import org.onap.aai.babel.xml.generator.data.GenerationData;
  28
  29 /**
  30  * Artifact Generation. Note that there is only one implementation of this interface currently.
  31  *
  32  */
  33 @FunctionalInterface // for SONAR only
  34 public interface ArtifactGenerator {
  35
  36     /**
  37      * Implementation of the method to generate AAI artifacts.
  38      *
  39      * @param csarArchive
  40      *            original CSAR (zip format)
  41      * @param input
  42      *            List of input tosca files
  43      * @param additionalParams
  44      * @return Translated/Error data as a {@link GenerationData} object
  45      */
  46     public GenerationData generateArtifact(byte[] csarArchive, List<Artifact> input,
  47             Map<String, String> additionalParams);
  48 }