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

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2018 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 package org.onap.aai.babel.xml.generator.api;
  22
  23 import java.util.List;
  24 import java.util.Map;
  25 import org.onap.aai.babel.xml.generator.data.Artifact;
  26 import org.onap.aai.babel.xml.generator.data.GenerationData;
  27
  28 /** Artifact Generation. Note that there is only one implementation of this interface currently. */
  29 public interface ArtifactGenerator {
  30
  31     /**
  32      * Implementation of the method to generate AAI artifacts.
  33      *
  34      * @param csarArchive original CSAR (zip format)
  35      * @param input List of input tosca files
  36      * @param additionalParams
  37      * @return Translated/Error data as a {@link GenerationData} object
  38      */
  39     public GenerationData generateArtifact(byte[] csarArchive, List<Artifact> input,
  40             Map<String, String> additionalParams);
  41 }