Class ConfigServerClientSettings

Namespace

Steeltoe.Extensions.Configuration.ConfigServer

Assembly

Steeltoe.Extensions.Configuration.ConfigServerBase.dll

Holds the settings used to configure the Spring Cloud Config Server provider ConfigServerConfigurationProvider.

public class ConfigServerClientSettings

Inheritance

object

ConfigServerClientSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConfigServerClientSettings()

Initializes a new instance of the ConfigServerClientSettings class.

public ConfigServerClientSettings()

Remarks

Initialize Config Server client settings with defaults

Fields

DEFAULT_ACCESS_TOKEN_URI

Default address used by provider to obtain a OAuth Access Token

public const string DEFAULT_ACCESS_TOKEN_URI = null

Field Value

string

DEFAULT_CERTIFICATE_VALIDATION

Default certifcate validation enabled setting

public const bool DEFAULT_CERTIFICATE_VALIDATION = true

Field Value

bool

DEFAULT_CLIENT_ID

Default client id used by provider to obtain a OAuth Access Token

public const string DEFAULT_CLIENT_ID = null

Field Value

string

DEFAULT_CLIENT_SECRET

Default client secret used by provider to obtain a OAuth Access Token

public const string DEFAULT_CLIENT_SECRET = null

Field Value

string

DEFAULT_CONFIGSERVER_SERVICEID

Default discovery first service id setting

public const string DEFAULT_CONFIGSERVER_SERVICEID = "configserver"

Field Value

string

DEFAULT_DISABLE_TOKEN_RENEWAL

Default Disable Vault Token renewal

public const bool DEFAULT_DISABLE_TOKEN_RENEWAL = false

Field Value

bool

DEFAULT_DISCOVERY_ENABLED

Default discovery first enabled setting

public const bool DEFAULT_DISCOVERY_ENABLED = false

Field Value

bool

DEFAULT_ENVIRONMENT

Default enironment used when accessing configuration data

public const string DEFAULT_ENVIRONMENT = "Production"

Field Value

string

DEFAULT_FAILFAST

Default fail fast setting

public const bool DEFAULT_FAILFAST = false

Field Value

bool

DEFAULT_HEALTH_ENABLED

Default health check enabled setting

public const bool DEFAULT_HEALTH_ENABLED = true

Field Value

bool

DEFAULT_HEALTH_TIMETOLIVE

Default health check time to live in milliseconds setting

public const long DEFAULT_HEALTH_TIMETOLIVE = 300000

Field Value

long

DEFAULT_INITIAL_RETRY_INTERVAL

Default initial retry interval in milliseconds

public const int DEFAULT_INITIAL_RETRY_INTERVAL = 1000

Field Value

int

DEFAULT_MAX_RETRY_ATTEMPTS

Default number of retries to be attempted

public const int DEFAULT_MAX_RETRY_ATTEMPTS = 6

Field Value

int

DEFAULT_MAX_RETRY_INTERVAL

Default initial retry interval in milliseconds

public const int DEFAULT_MAX_RETRY_INTERVAL = 2000

Field Value

int

DEFAULT_PROVIDER_ENABLED

Default Config Server provider enabled setting

public const bool DEFAULT_PROVIDER_ENABLED = true

Field Value

bool

DEFAULT_RETRY_ENABLED

Default retry enabled setting

public const bool DEFAULT_RETRY_ENABLED = false

Field Value

bool

DEFAULT_RETRY_MULTIPLIER

Default multiplier for next retry interval

public const double DEFAULT_RETRY_MULTIPLIER = 1.1

Field Value

double

DEFAULT_TIMEOUT_MILLISECONDS

Default timeout in milliseconds

public const int DEFAULT_TIMEOUT_MILLISECONDS = 6000

Field Value

int

DEFAULT_URI

Default Config Server address used by provider

public const string DEFAULT_URI = "http://localhost:8888"

Field Value

string

DEFAULT_VAULT_TOKEN_RENEW_RATE

Default Vault Token renewal rate

public const int DEFAULT_VAULT_TOKEN_RENEW_RATE = 60000

Field Value

int

DEFAULT_VAULT_TOKEN_TTL

Default Vault Token Time to Live setting

public const int DEFAULT_VAULT_TOKEN_TTL = 300000

Field Value

int

Properties

AccessTokenUri

Gets or sets address used by provider to obtain a OAuth Access Token

public virtual string AccessTokenUri { get; set; }

Property Value

string

ClientCertificate

public virtual X509Certificate2 ClientCertificate { get; set; }

Property Value

X509Certificate2

ClientId

Gets or sets client id used by provider to obtain a OAuth Access Token

public virtual string ClientId { get; set; }

Property Value

string

ClientSecret

Gets or sets client secret used by provider to obtain a OAuth Access Token

public virtual string ClientSecret { get; set; }

Property Value

string

DisableTokenRenewal

public virtual bool DisableTokenRenewal { get; set; }

Property Value

bool

DiscoveryEnabled

Gets or sets a value indicating whether discovery first behavior is enabled

public virtual bool DiscoveryEnabled { get; set; }

Property Value

bool

DiscoveryServiceId

Gets or sets a value of the service id used during discovery first behavior

public virtual string DiscoveryServiceId { get; set; }

Property Value

string

Enabled

Gets or sets a value indicating whether enables/Disables the Config Server provider

public virtual bool Enabled { get; set; }

Property Value

bool

Environment

Gets or sets the environment used when accessing configuration data

public virtual string Environment { get; set; }

Property Value

string

FailFast

Gets or sets a value indicating whether enables/Disables failfast behavior

public virtual bool FailFast { get; set; }

Property Value

bool

Headers

Gets or sets headers that will be added to the config server request

public virtual Dictionary<string, string> Headers { get; set; }

Property Value

Dictionary<string, string>

HealthEnabled

Gets or sets a value indicating whether health check is enabled

public virtual bool HealthEnabled { get; set; }

Property Value

bool

HealthTimeToLive

Gets or sets a value for the health check cache time to live

public virtual long HealthTimeToLive { get; set; }

Property Value

long

Label

Gets or sets the label used when accessing configuration data

public virtual string Label { get; set; }

Property Value

string

Name

Gets or sets the application name used when accessing configuration data

public virtual string Name { get; set; }

Property Value

string

Password

Gets or sets the password used when accessing the Config Server

public virtual string Password { get; set; }

Property Value

string

PollingInterval

Gets or sets the frequency with which app should check config server for changes in configuration

public virtual TimeSpan PollingInterval { get; set; }

Property Value

TimeSpan

RawUri

Gets returns the HttpRequestUrl, unescaped

[Obsolete("Will be removed, use RawUris instead")]
public virtual string RawUri { get; }

Property Value

string

RawUris

Gets returns HttpRequestUrls, unescaped

public virtual string[] RawUris { get; }

Property Value

string[]

RetryAttempts

Gets or sets the max number of retries the client will attempt

public virtual int RetryAttempts { get; set; }

Property Value

int

RetryEnabled

Gets or sets a value indicating whether enables/Disables config server client retry on failures

public virtual bool RetryEnabled { get; set; }

Property Value

bool

RetryInitialInterval

Gets or sets initial retry interval in milliseconds

public virtual int RetryInitialInterval { get; set; }

Property Value

int

RetryMaxInterval

Gets or sets max retry interval in milliseconds

public virtual int RetryMaxInterval { get; set; }

Property Value

int

RetryMultiplier

Gets or sets multiplier for next retry interval

public virtual double RetryMultiplier { get; set; }

Property Value

double

Timeout

Gets or sets returns the request timeout in milliseconds

public virtual int Timeout { get; set; }

Property Value

int

Token

Gets or sets returns the token use for Vault

public virtual string Token { get; set; }

Property Value

string

TokenRenewRate

Gets or sets vault token renew rate in Milliseconds

public virtual int TokenRenewRate { get; set; }

Property Value

int

TokenTtl

Gets or sets vault token Time to Live setting in Millisecoonds

public virtual int TokenTtl { get; set; }

Property Value

int

Uri

Gets or sets the Config Server address

public virtual string Uri { get; set; }

Property Value

string

Username

Gets or sets the username used when accessing the Config Server

public virtual string Username { get; set; }

Property Value

string

ValidateCertificates

Gets or sets a value indicating whether enables/Disables whether provider validates server certificates

public virtual bool ValidateCertificates { get; set; }

Property Value

bool