pip_services3_components.config.ConfigReader module
pip_services3_components.config.CachedConfigReader
Cached config reader implementation
- copyright
Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.
- license
MIT, see LICENSE for more details.
-
class
pip_services3_components.config.ConfigReader.ConfigReader Bases:
pip_services3_components.config.IConfigReader.IConfigReader,pip_services3_commons.config.IConfigurable.IConfigurableAbstract config reader that supports configuration parameterization.
### Configuration parameters ### parameters: this entire section is used as template parameters
…
-
add_change_listener(listener: pip_services3_commons.run.INotifiable.INotifiable) Adds a listener that will be notified when configuration is changed
- Parameters
listener – a listener to be added.
-
configure(config: pip_services3_commons.config.ConfigParams.ConfigParams) Configures component by passing configuration parameters.
- Parameters
config – configuration parameters to be set.
-
abstract
read_config_(correlation_id: Optional[str], parameters: pip_services3_commons.config.ConfigParams.ConfigParams) → pip_services3_commons.config.ConfigParams.ConfigParams Reads configuration and parameterize it with given values.
- Parameters
correlation_id – (optional) transaction id to trace execution through call chain.
parameters – values to parameters the configuration or null to skip parameterization.
- Returns
ConfigParams configuration.
-
remove_change_listener(listener: pip_services3_commons.run.INotifiable.INotifiable) Remove a previously added change listener.
- Parameters
listener – a listener to be removed.