catalog-be-plugins/etsi-nfv-nsd-csar-plugin/src/main/java/org/openecomp/sdc/be/plugins/etsi/nfv/nsd/tosca/yaml/ToscaTemplateYamlGenerator.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  *
  16  *  SPDX-License-Identifier: Apache-2.0
  17  *  ============LICENSE_END=========================================================
  18  */
  19
  20 package org.openecomp.sdc.be.plugins.etsi.nfv.nsd.tosca.yaml;
  21
  22 import org.openecomp.sdc.be.tosca.model.ToscaTemplate;
  23 import org.springframework.beans.factory.config.BeanDefinition;
  24 import org.springframework.context.annotation.Scope;
  25 import org.springframework.stereotype.Component;
  26 import org.yaml.snakeyaml.DumperOptions;
  27 import org.yaml.snakeyaml.DumperOptions.FlowStyle;
  28 import org.yaml.snakeyaml.Yaml;
  29 import org.yaml.snakeyaml.nodes.Tag;
  30 import org.yaml.snakeyaml.representer.Representer;
  31
  32 /**
  33  * Handles a Tosca Template YAML parsing
  34  */
  35 @Component
  36 @Scope(BeanDefinition.SCOPE_PROTOTYPE)
  37 public class ToscaTemplateYamlGenerator {
  38
  39     private final ToscaTemplate toscaTemplate;
  40     private final Representer representer;
  41     private final DumperOptions dumperOptions;
  42
  43     public ToscaTemplateYamlGenerator(final ToscaTemplate toscaTemplate) {
  44         this.toscaTemplate = toscaTemplate;
  45         this.representer = new NsdTemplateRepresenter();
  46         initRepresenter();
  47         this.dumperOptions = new DumperOptions();
  48         initDumperOptions();
  49     }
  50
  51     /**
  52      * Parses the ToscaTemplate to a String YAML.
  53      *
  54      * @return the YAML representing the ToscaTemplate
  55      */
  56     public String parseToYamlString() {
  57         final Yaml yaml = new Yaml(representer, dumperOptions);
  58         return yaml.dumpAsMap(toscaTemplate);
  59     }
  60
  61     private void initDumperOptions() {
  62         dumperOptions.setAllowReadOnlyProperties(false);
  63         dumperOptions.setPrettyFlow(true);
  64         dumperOptions.setDefaultFlowStyle(FlowStyle.FLOW);
  65         dumperOptions.setCanonical(false);
  66     }
  67
  68     private void initRepresenter() {
  69         representer.addClassTag(toscaTemplate.getClass(), Tag.MAP);
  70         representer.setPropertyUtils(new UnsortedPropertyUtils());
  71     }
  72
  73 }