appc-config/appc-config-params/provider/src/main/java/org/openecomp/sdnc/config/params/transformer/tosca/ArtifactProcessor.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 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  *
  19  *  ECOMP is a trademark and service mark of AT&T Intellectual Property.
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.openecomp.sdnc.config.params.transformer.tosca;
  24
  25 import org.openecomp.sdnc.config.params.data.PropertyDefinition;
  26 import org.openecomp.sdnc.config.params.transformer.tosca.exceptions.ArtifactProcessorException;
  27
  28 import java.io.OutputStream;
  29
  30 public interface ArtifactProcessor
  31 {
  32     /**
  33      * Generates Tosca artifact from PropertyDefinition object.
  34      *
  35      * @param artifact
  36      *                PropertyDefinition object which is to be converted to Tosca.
  37      * @param stream
  38      *                Stream to which the generated Tosca is to be written.
  39      * @throws ArtifactProcessorException
  40      *                If the Tosca Generation failed
  41      */
  42     void generateArtifact(PropertyDefinition artifact, OutputStream stream) throws ArtifactProcessorException;
  43
  44     /**
  45      * Generates Tosca artifact from PropertyDefinition string.
  46      *
  47      * @param artifact
  48      *               PropertyDefinition string which is to be converted to Tosca.
  49      * @param stream
  50      *               Stream to which the generated Tosca is to be written.
  51      * @throws ArtifactProcessorException
  52      *               If the Tosca Generation failed
  53      */
  54     void generateArtifact(String artifact, OutputStream stream) throws ArtifactProcessorException;
  55
  56     /**
  57      * Generates the PropertyDefinition object from a Tosca artifact.
  58      *
  59      * @param toscaArtifact
  60      *                Tosca artifact which is to be converted.
  61      * @return PropertyDefinition object generated from Tosca
  62      * @throws ArtifactProcessorException
  63      *                If the PropertyDefinition Generation failed
  64      */
  65     PropertyDefinition readArtifact(String toscaArtifact) throws ArtifactProcessorException;
  66 }