Package org.pipservices3.components.config

Class YamlConfigReader

java.lang.Object
org.pipservices3.components.config.ConfigReader
org.pipservices3.components.config.FileConfigReader
org.pipservices3.components.config.YamlConfigReader
All Implemented Interfaces:
org.pipservices3.commons.config.IConfigurable, IConfigReader
public class YamlConfigReader
extends FileConfigReader
Config reader that reads configuration from YAML file.

The reader supports parameterization using Handlebar template engine.

### Configuration parameters ###

  • path: path to configuration file
  • parameters: this entire section is used as template parameters
  • ...

### Example ### 

 
 ======== config.yml ======
 key1: "{{KEY1_VALUE}}"
 key2: "{{KEY2_VALUE}}"
 ===========================
 
 YamlConfigReader configReader = new YamlConfigReader("config.yml");
 
 ConfigParams parameters = ConfigParams.fromTuples("KEY1_VALUE", 123, "KEY2_VALUE", "ABC");
 configReader.readConfig("123", parameters);

  • Field Summary

    Fields inherited from class org.pipservices3.components.config.FileConfigReader

    _path

  • Constructor Summary

    Constructors
    Constructor Description
    YamlConfigReader()
    Creates a new instance of the config reader.
    YamlConfigReader​(String path)
    Creates a new instance of the config reader.

  • Method Summary

    Modifier and Type Method Description
    static org.pipservices3.commons.config.ConfigParams readConfig​(String correlationId, String path, org.pipservices3.commons.config.ConfigParams parameters)
    Reads configuration from a file, parameterize it with given values and returns a new ConfigParams object.
    org.pipservices3.commons.config.ConfigParams readConfig​(String correlationId, org.pipservices3.commons.config.ConfigParams parameters)
    Reads configuration and parameterize it with given values.
    static Object readObject​(String correlationId, String path, org.pipservices3.commons.config.ConfigParams parameters)
    Reads configuration file, parameterizes its content and converts it into JSON object.
    Object readObject​(String correlationId, org.pipservices3.commons.config.ConfigParams parameters)
    Reads configuration file, parameterizes its content and converts it into JSON object.

    Methods inherited from class org.pipservices3.components.config.FileConfigReader

    configure, getPath, setPath

    Methods inherited from class org.pipservices3.components.config.ConfigReader

    parameterize

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • YamlConfigReader

      public YamlConfigReader()
      Creates a new instance of the config reader.

    • YamlConfigReader

      public YamlConfigReader​(String path)
      Creates a new instance of the config reader.
      Parameters:
      path - (optional) a path to configuration file.

  • Method Details

    • readObject

      public Object readObject​(String correlationId, org.pipservices3.commons.config.ConfigParams parameters) throws org.pipservices3.commons.errors.ApplicationException
      Reads configuration file, parameterizes its content and converts it into JSON object.
      Parameters:
      correlationId - (optional) transaction id to trace execution through call chain.
      parameters - values to parameters the configuration.
      Returns:
      a JSON object with configuration.
      Throws:
      org.pipservices3.commons.errors.ApplicationException - when error occured.

    • readConfig

      public org.pipservices3.commons.config.ConfigParams readConfig​(String correlationId, org.pipservices3.commons.config.ConfigParams parameters) throws org.pipservices3.commons.errors.ApplicationException
      Reads configuration and parameterize it with given values.
      Specified by:
      readConfig in interface IConfigReader
      Specified by:
      readConfig in class ConfigReader
      Parameters:
      correlationId - (optional) transaction id to trace execution through call chain.
      parameters - values to parameters the configuration or null to skip parameterization.
      Returns:
      ConfigParams configuration.
      Throws:
      org.pipservices3.commons.errors.ApplicationException - when error occured.

    • readObject

      public static Object readObject​(String correlationId, String path, org.pipservices3.commons.config.ConfigParams parameters) throws org.pipservices3.commons.errors.ApplicationException
      Reads configuration file, parameterizes its content and converts it into JSON object.
      Parameters:
      correlationId - (optional) transaction id to trace execution through call chain.
      path - a path to configuration file.
      parameters - values to parameters the configuration.
      Returns:
      a JSON object with configuration.
      Throws:
      org.pipservices3.commons.errors.ApplicationException - when error occured.

    • readConfig

      public static org.pipservices3.commons.config.ConfigParams readConfig​(String correlationId, String path, org.pipservices3.commons.config.ConfigParams parameters) throws org.pipservices3.commons.errors.ApplicationException
      Reads configuration from a file, parameterize it with given values and returns a new ConfigParams object.
      Parameters:
      correlationId - (optional) transaction id to trace execution through call chain.
      path - a path to configuration file.
      parameters - values to parameters the configuration or null to skip parameterization.
      Returns:
      ConfigParams configuration.
      Throws:
      org.pipservices3.commons.errors.ApplicationException - when error occured.