Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class Microsoft.IdentityModel.Tokens.BaseConfigurationManager
Assembly: Microsoft.IdentityModel.Tokens
Inheritance: object → BaseConfigurationManager
Represents a generic configuration manager.
Fields and Constants
public static readonly
System.TimeSpan
DefaultAutomaticRefreshInterval
Default time interval (12 hours) after which a new configuration is obtained automatically.
public static readonly
System.TimeSpan
DefaultLastKnownGoodConfigurationLifetime
Default time interval (1 hour) for which the last known good configuration remains valid.
public static readonly
System.TimeSpan
DefaultRefreshInterval
Default time interval (5 minutes) that must pass for <see cref="M:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.RequestRefresh" /> to obtain a new configuration.
public static readonly
System.TimeSpan
MinimumAutomaticRefreshInterval
Minimum time interval (5 minutes) for automatic refresh. <see cref="P:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.AutomaticRefreshInterval" /> cannot be set to less than this value.
public static readonly
System.TimeSpan
MinimumRefreshInterval
Minimum time interval (1 second) that must pass before calling <see cref="M:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.RequestRefresh" /> to obtain new configuration.
Properties
public
System.TimeSpan
AutomaticRefreshInterval
Gets or sets the <see cref="T:System.TimeSpan" /> that controls how often an automatic metadata refresh should occur.
public
BaseConfiguration
LastKnownGoodConfiguration
The last known good configuration or LKG (a configuration retrieved in the past that we were able to successfully validate a token against).
public
System.TimeSpan
LastKnownGoodLifetime
The length of time that a last known good configuration is valid for.
public
string
MetadataAddress
The metadata address to retrieve the configuration from.
public
System.TimeSpan
RefreshInterval
The minimum time between retrievals, in the event that a retrieval failed, or that a refresh was explicitly requested.
public
bool
UseLastKnownGoodConfiguration
Gets or sets a value indicating whether to use the last known good configuration. Default is true.
public
bool
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.
Methods
GetBaseConfigurationAsync(System.Threading.CancellationToken cancel)
Obtains an updated version of <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration" /> if the appropriate refresh interval has passed.
This method may return a cached version of the configuration.
Returns Configuration of type Configuration.
cancel
A cancellation token that can be used to cancel the asynchronous operation.
Remarks
This method on the base class throws a <see cref="T:System.NotImplementedException" />
as it is meant to be overridden by the class that extends it.
public
void
RequestRefresh()
Indicate that the configuration may be stale (as indicated by failing to process incoming tokens).
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object