Class ConfigServerConfigurationSource

Namespace

Steeltoe.Extensions.Configuration.ConfigServer

Assembly

Steeltoe.Extensions.Configuration.ConfigServerBase.dll

public class ConfigServerConfigurationSource : IConfigurationSource

Inheritance

object

ConfigServerConfigurationSource

Implements

IConfigurationSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConfigServerConfigurationSource(IConfiguration, ILoggerFactory)

Initializes a new instance of the ConfigServerConfigurationSource class.

public ConfigServerConfigurationSource(IConfiguration configuration, ILoggerFactory logFactory = null)

Parameters

configuration IConfiguration

configuration used by the Config Server client. Values will override those found in default settings

logFactory ILoggerFactory

optional logger factory used by the client

ConfigServerConfigurationSource(ConfigServerClientSettings, IConfiguration, ILoggerFactory)

Initializes a new instance of the ConfigServerConfigurationSource class.

public ConfigServerConfigurationSource(ConfigServerClientSettings defaultSettings, IConfiguration configuration, ILoggerFactory logFactory = null)

Parameters

defaultSettings ConfigServerClientSettings

the default settings used by the Config Server client

configuration IConfiguration

configuration used by the Config Server client. Values will override those found in default settings

logFactory ILoggerFactory

optional logger factory used by the client

ConfigServerConfigurationSource(ConfigServerClientSettings, IList<IConfigurationSource>, IDictionary<string, object>, ILoggerFactory)

Initializes a new instance of the ConfigServerConfigurationSource class.

public ConfigServerConfigurationSource(ConfigServerClientSettings defaultSettings, IList<IConfigurationSource> sources, IDictionary<string, object> properties = null, ILoggerFactory logFactory = null)

Parameters

defaultSettings ConfigServerClientSettings

the default settings used by the Config Server client

sources IList<IConfigurationSource>

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

properties IDictionary<string, object>

properties to be used when sources are built

logFactory ILoggerFactory

optional logger factory used by the client

ConfigServerConfigurationSource(IList<IConfigurationSource>, IDictionary<string, object>, ILoggerFactory)

Initializes a new instance of the ConfigServerConfigurationSource class.

public ConfigServerConfigurationSource(IList<IConfigurationSource> sources, IDictionary<string, object> properties = null, ILoggerFactory logFactory = null)

Parameters

sources IList<IConfigurationSource>

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

properties IDictionary<string, object>

properties to be used when sources are built

logFactory ILoggerFactory

optional logger factory used by the client

Fields

_properties

protected IDictionary<string, object> _properties

Field Value

IDictionary<string, object>

_sources

protected IList<IConfigurationSource> _sources

Field Value

IList<IConfigurationSource>

Properties

Configuration

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

public IConfiguration Configuration { get; protected set; }

Property Value

IConfiguration

DefaultSettings

Gets the default settings the Config Server client uses to contact the Config Server

public ConfigServerClientSettings DefaultSettings { get; }

Property Value

ConfigServerClientSettings

LogFactory

Gets the logger factory used by the Config Server client

public ILoggerFactory LogFactory { get; }

Property Value

ILoggerFactory

Methods

Build(IConfigurationBuilder)

Returns a ConfigServerConfigurationProvider configured using the values from this ConfigServerConfigurationSource

public virtual IConfigurationProvider Build(IConfigurationBuilder builder)

Parameters

builder IConfigurationBuilder

not required

Returns

IConfigurationProvider

configuration provider