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