Class ConfigServerConfigurationSource
Inheritance
Namespace: Steeltoe.Extensions.Configuration.ConfigServer
Assembly: Steeltoe.Extensions.Configuration.ConfigServerBase.dll
Syntax
public class ConfigServerConfigurationSource : IConfigurationSource
Constructors
| Edit this page View SourceConfigServerConfigurationSource(IConfiguration, ILoggerFactory)
Initializes a new instance of the ConfigServerConfigurationSource class.
Declaration
public ConfigServerConfigurationSource(IConfiguration configuration, ILoggerFactory logFactory = null)
Parameters
Type | Name | Description |
---|---|---|
IConfiguration | configuration | configuration used by the Config Server client. Values will override those found in default settings |
ILoggerFactory | logFactory | optional logger factory used by the client |
ConfigServerConfigurationSource(IList<IConfigurationSource>, IDictionary<String, Object>, ILoggerFactory)
Initializes a new instance of the ConfigServerConfigurationSource class.
Declaration
public ConfigServerConfigurationSource(IList<IConfigurationSource> sources, IDictionary<string, object> properties = null, ILoggerFactory logFactory = null)
Parameters
Type | Name | Description |
---|---|---|
IList<IConfigurationSource> | sources | configuration sources used by the Config Server client. The Configuration will be built from these sources and the values will override those found in DefaultSettings |
IDictionary<System.String, System.Object> | properties | properties to be used when sources are built |
ILoggerFactory | logFactory | optional logger factory used by the client |
ConfigServerConfigurationSource(ConfigServerClientSettings, IConfiguration, ILoggerFactory)
Initializes a new instance of the ConfigServerConfigurationSource class.
Declaration
public ConfigServerConfigurationSource(ConfigServerClientSettings defaultSettings, IConfiguration configuration, ILoggerFactory logFactory = null)
Parameters
Type | Name | Description |
---|---|---|
ConfigServerClientSettings | defaultSettings | the default settings used by the Config Server client |
IConfiguration | configuration | configuration used by the Config Server client. Values will override those found in default settings |
ILoggerFactory | logFactory | optional logger factory used by the client |
ConfigServerConfigurationSource(ConfigServerClientSettings, IList<IConfigurationSource>, IDictionary<String, Object>, ILoggerFactory)
Initializes a new instance of the ConfigServerConfigurationSource class.
Declaration
public ConfigServerConfigurationSource(ConfigServerClientSettings defaultSettings, IList<IConfigurationSource> sources, IDictionary<string, object> properties = null, ILoggerFactory logFactory = null)
Parameters
Type | Name | Description |
---|---|---|
ConfigServerClientSettings | defaultSettings | the default settings used by the Config Server client |
IList<IConfigurationSource> | sources | configuration sources used by the Config Server client. The Configuration will be built from these sources and the values will override those found in DefaultSettings |
IDictionary<System.String, System.Object> | properties | properties to be used when sources are built |
ILoggerFactory | logFactory | optional logger factory used by the client |
Fields
| Edit this page View Source_properties
Declaration
protected IDictionary<string, object> _properties
Field Value
Type | Description |
---|---|
IDictionary<System.String, System.Object> |
_sources
Declaration
protected IList<IConfigurationSource> _sources
Field Value
Type | Description |
---|---|
IList<IConfigurationSource> |
Properties
| Edit this page View SourceConfiguration
Gets or sets gets the configuration the Config Server client uses to contact the Config Server. Values returned override the default values provided in DefaultSettings
Declaration
public IConfiguration Configuration { get; protected set; }
Property Value
Type | Description |
---|---|
IConfiguration |
DefaultSettings
Gets the default settings the Config Server client uses to contact the Config Server
Declaration
public ConfigServerClientSettings DefaultSettings { get; }
Property Value
Type | Description |
---|---|
ConfigServerClientSettings |
LogFactory
Gets the logger factory used by the Config Server client
Declaration
public ILoggerFactory LogFactory { get; }
Property Value
Type | Description |
---|---|
ILoggerFactory |
Methods
| Edit this page View SourceBuild(IConfigurationBuilder)
Returns a ConfigServerConfigurationProvider configured using the values from this ConfigServerConfigurationSource
Declaration
public virtual IConfigurationProvider Build(IConfigurationBuilder builder)
Parameters
Type | Name | Description |
---|---|---|
IConfigurationBuilder | builder | not required |
Returns
Type | Description |
---|---|
IConfigurationProvider | configuration provider |