BaseConfigurationManager Class

Definition

Represents a generic configuration manager.

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

Constructors

BaseConfigurationManager()

The default constructor.

BaseConfigurationManager(LKGConfigurationCacheOptions)

Constructor.

Fields

DefaultAutomaticRefreshInterval

12 hours is the default time interval that afterwards will obtain new configuration.

DefaultLastKnownGoodConfigurationLifetime

1 hour is the default time interval that a last known good configuration will last for.

DefaultRefreshInterval

5 minutes 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 TimeSpan that controls how often an automatic metadata refresh should occur.

IsLastKnownGoodValid

Indicates whether the last known good configuration is still fresh, 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

Indicates whether the last known good feature should be used, true by default.

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