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  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.openecomp.sdnc.config.params.transformer.tosca;
  26
  27 import org.openecomp.sdnc.config.params.data.PropertyDefinition;
  28 import org.openecomp.sdnc.config.params.transformer.tosca.exceptions.ArtifactProcessorException;
  29
  30 import java.io.OutputStream;
  31
  32 public interface ArtifactProcessor
  33 {
  34     /**
  35      * Generates Tosca artifact from PropertyDefinition object.
  36      *
  37      * @param artifact
  38      *                PropertyDefinition object which is to be converted to Tosca.
  39      * @param stream
  40      *                Stream to which the generated Tosca is to be written.
  41      * @throws ArtifactProcessorException
  42      *                If the Tosca Generation failed
  43      */
  44     void generateArtifact(PropertyDefinition artifact, OutputStream stream) throws ArtifactProcessorException;
  45
  46     /**
  47      * Generates Tosca artifact from PropertyDefinition string.
  48      *
  49      * @param artifact
  50      *               PropertyDefinition string which is to be converted to Tosca.
  51      * @param stream
  52      *               Stream to which the generated Tosca is to be written.
  53      * @throws ArtifactProcessorException
  54      *               If the Tosca Generation failed
  55      */
  56     void generateArtifact(String artifact, OutputStream stream) throws ArtifactProcessorException;
  57
  58     /**
  59      * Generates the PropertyDefinition object from a Tosca artifact.
  60      *
  61      * @param toscaArtifact
  62      *                Tosca artifact which is to be converted.
  63      * @return PropertyDefinition object generated from Tosca
  64      * @throws ArtifactProcessorException
  65      *                If the PropertyDefinition Generation failed
  66      */
  67     PropertyDefinition readArtifact(String toscaArtifact) throws ArtifactProcessorException;
  68 }