ConfigurationManager<T> Class

Definition

Manages the retrieval of Configuration data.

public class ConfigurationManager<T> : Microsoft.IdentityModel.Protocols.IConfigurationManager<T> where T : class
type ConfigurationManager<'T (requires 'T : null)> = class
    interface IConfigurationManager<'T (requires 'T : null)>
Public Class ConfigurationManager(Of T)
Implements IConfigurationManager(Of T)

Type Parameters

T

The type of IDocumentRetriever.

Inheritance
System.Object
ConfigurationManager<T>
Implements

Constructors

ConfigurationManager<T>(String, IConfigurationRetriever<T>)

Instantiaties a new ConfigurationManager<T> that manages automatic and controls refreshing on configuration data.

ConfigurationManager<T>(String, IConfigurationRetriever<T>, HttpClient)

Instantiaties a new ConfigurationManager<T> that manages automatic and controls refreshing on configuration data.

ConfigurationManager<T>(String, IConfigurationRetriever<T>, IDocumentRetriever)

Instantiaties a new ConfigurationManager<T> that manages automatic and controls refreshing on configuration data.

Fields

DefaultAutomaticRefreshInterval

1 day is the default time interval that afterwards, GetConfigurationAsync() will obtain new configuration.

DefaultRefreshInterval

30 seconds is the default time interval that must pass for RequestRefresh() to obtain a new configuration.

MinimumAutomaticRefreshInterval

5 minutes is the minimum value for automatic refresh. AutomaticRefreshInterval can not be set less than this value.

MinimumRefreshInterval

1 second is the minimum time interval that must pass for RequestRefresh() to obtain new configuration.

Properties

AutomaticRefreshInterval

Gets or sets the System.TimeSpan that controls how often an automatic metadata refresh should occur.

RefreshInterval

The minimum time between retrievals, in the event that a retrieval failed, or that a refresh was explicitly requested.

Methods

GetConfigurationAsync()

Obtains an updated version of Configuration.

GetConfigurationAsync(CancellationToken)

Obtains an updated version of Configuration.

RequestRefresh()

Requests that then next call to GetConfigurationAsync() obtain new configuration.

If the last refresh was greater than RefreshInterval then the next call to GetConfigurationAsync() will retrieve new configuration.

If RefreshInterval == System.TimeSpan.MaxValue then this method does nothing.

Applies to