org.apache.camel.spi.ModelToYAMLDumper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-api Show documentation
The Camel API
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.spi;

import java.util.List;
import java.util.Map;

import org.apache.camel.CamelContext;
import org.apache.camel.NamedNode;

/**
 * SPI for dumping model definitions into YAML representation.
 */
public interface ModelToYAMLDumper {

    /**
     * Service factory key.
     */
    String FACTORY = "modelyaml-dumper";

    /**
     * Dumps the definition as YAML
     *
     * @param  context    the CamelContext
     * @param  definition the definition, such as a {@link NamedNode}
     * @return            the output in YAML (is formatted)
     * @throws Exception  is throw if error marshalling to YAML
     */
    String dumpModelAsYaml(CamelContext context, NamedNode definition) throws Exception;

    /**
     * Dumps the definition as YAML
     *
     * @param  context             the CamelContext
     * @param  definition          the definition, such as a {@link NamedNode}
     * @param  resolvePlaceholders whether to resolve property placeholders in the dumped YAML
     * @param  uriAsParameters     whether to expand uri into a key/value parameters
     * @param  generatedIds        whether to include auto generated IDs
     * @return                     the output in YAML (is formatted)
     * @throws Exception           is throw if error marshalling to YAML
     */
    String dumpModelAsYaml(
            CamelContext context, NamedNode definition,
            boolean resolvePlaceholders, boolean uriAsParameters, boolean generatedIds)
            throws Exception;

    /**
     * Dumps the beans as YAML
     *
     * @param  context   the CamelContext
     * @param  beans     list of beans (BeanFactoryDefinition)
     * @return           the output in YAML (is formatted)
     * @throws Exception is throw if error marshalling to YAML
     */
    String dumpBeansAsYaml(CamelContext context, List