Interface for configuration readers that retrieve a configuration from various sources and make it available for other components.
Description
The IConfigReader interface is used in configuration readers that retrieve a configuration from various sources and make it availale for other components.
Important points
- Some IConfigReader implementations may support configuration parameterization.
- The parameterization allows to use configuration as a template and inject there dynamic values. The values may come from application command like arguments or environment variables.
Instance methods
addChangeListener
Adds a listener that will be notified when configuration is changed
void addChangeListener(INotifiable listener)
- listener: INotifiable - a listener to be added.
removeChangeListener
Remove a previously added change listener.
void removeChangeListener(INotifiable listener)
- listener: INotifiable - a listener to be removed.
readConfig
Reads configuration and parameterizes it with given values.
public
ConfigParams readConfig(IContext context, ConfigParams parameters) throws Exception
- context: IContext - (optional) a context to trace execution through a call chain.
- parameters: ConfigParams - values to parameters the configuration or null to skip parameterization.
- returns: Promise<ConfigParams> - ConfigParams configuration.