BaseConfigurationManager Class

Definition

Represents a generic configuration manager.

public abstract class BaseConfigurationManager
type BaseConfigurationManager = class
Public MustInherit Class BaseConfigurationManager
Inheritance
BaseConfigurationManager
Derived

Constructors

BaseConfigurationManager()

Initializes a new instance of the BaseConfigurationManager class.

BaseConfigurationManager(LKGConfigurationCacheOptions)

Initializes a new instance of the BaseConfigurationManager class.

Fields

DefaultAutomaticRefreshInterval

Default time interval (12 hours) after which a new configuration is obtained automatically.

DefaultLastKnownGoodConfigurationLifetime

Default time interval (1 hour) for which the last known good configuration remains valid.

DefaultRefreshInterval

Default time interval (5 minutes) that must pass for RequestRefresh() to obtain a new configuration.

MinimumAutomaticRefreshInterval

Minimum time interval (5 minutes) for automatic refresh. AutomaticRefreshInterval cannot be set to less than this value.

MinimumRefreshInterval

Minimum time interval (1 second) that must pass before calling RequestRefresh() to obtain new configuration.

Properties

AutomaticRefreshInterval

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

IsLastKnownGoodValid

Gets a value indicating whether the last known good configuration is still valid, depends on when the LKG was first used and it's lifetime.

LastKnownGoodConfiguration

The last known good configuration or LKG (a configuration retrieved in the past that we were able to successfully validate a token against).

LastKnownGoodLifetime

The length of time that a last known good configuration is valid for.

MetadataAddress

The metadata address to retrieve the configuration from.

RefreshInterval

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

UseLastKnownGoodConfiguration

Gets or sets a value indicating whether to use the last known good configuration. Default is true.

Methods

GetBaseConfigurationAsync(CancellationToken)

Obtains an updated version of BaseConfiguration if the appropriate refresh interval has passed. This method may return a cached version of the configuration.

RequestRefresh()

Indicate that the configuration may be stale (as indicated by failing to process incoming tokens).

Applies to