appc-config/appc-config-params/provider/src/main/java/org/onap/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.onap.sdnc.config.params.transformer.tosca;
  26
  27 import java.io.OutputStream;
  28 import org.onap.sdnc.config.params.data.PropertyDefinition;
  29 import org.onap.sdnc.config.params.transformer.tosca.exceptions.ArtifactProcessorException;
  30
  31 public interface ArtifactProcessor {
  32     /**
  33      * Generates Tosca artifact from PropertyDefinition object.
  34      *
  35      * @param artifact PropertyDefinition object which is to be converted to Tosca.
  36      * @param stream Stream to which the generated Tosca is to be written.
  37      * @throws ArtifactProcessorException If the Tosca Generation failed
  38      */
  39     void generateArtifact(PropertyDefinition artifact, OutputStream stream)
  40             throws ArtifactProcessorException;
  41
  42     /**
  43      * Generates Tosca artifact from PropertyDefinition string.
  44      *
  45      * @param artifact PropertyDefinition string which is to be converted to Tosca.
  46      * @param stream Stream to which the generated Tosca is to be written.
  47      * @throws ArtifactProcessorException If the Tosca Generation failed
  48      */
  49     void generateArtifact(String artifact, OutputStream stream) throws ArtifactProcessorException;
  50
  51     /**
  52      * Generates the PropertyDefinition object from a Tosca artifact.
  53      *
  54      * @param toscaArtifact Tosca artifact which is to be converted.
  55      * @return PropertyDefinition object generated from Tosca
  56      * @throws ArtifactProcessorException If the PropertyDefinition Generation failed
  57      */
  58     PropertyDefinition readArtifact(String toscaArtifact) throws ArtifactProcessorException;
  59 }