Class DefaultTenantSettingsCache

The default ITenantSettingsCache which uses Microsoft.Extensions.Caching.Distributed.IDistributedCache as underlying cache storage.

Inheritance
Object
DefaultTenantSettingsCache
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: IRM.AspNetCore.Identity
Assembly: IRM.AspNetCore.Identity.dll
Syntax
public class DefaultTenantSettingsCache : ITenantSettingsCache, IDynamicAuthenticationSchemeCache

Constructors

DefaultTenantSettingsCache(IDistributedCache, ISystemClock, IOptionsMonitor<DynamicAuthenticationOptions>)

Creates an instance of DefaultTenantSettingsCache.

Declaration
public DefaultTenantSettingsCache(IDistributedCache cache, ISystemClock clock, IOptionsMonitor<DynamicAuthenticationOptions> options)
Parameters
Microsoft.Extensions.Caching.Distributed.IDistributedCache cache

The underlying cache.
Microsoft.AspNetCore.Authentication.ISystemClock clock

The Microsoft.AspNetCore.Authentication.ISystemClock.
Microsoft.Extensions.Options.IOptionsMonitor<IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationOptions> options

The IRM.AspNetCore.Authentication.Dynamic.DynamicAuthenticationOptions.

Methods

GetAll(CancellationToken)

Gets a collection of TenantSettings for all tenants, if any.

Declaration
public async Task<List<TenantSettings>> GetAll(CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Threading.CancellationToken cancellationToken

The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.
Returns
System.Threading.Tasks.Task<List<TenantSettings>>

A collection of TenantSettings for all tenants, if any.
Implements

GetAllSchemesAsync()

Declaration
public async Task<IEnumerable<AuthenticationScheme>> GetAllSchemesAsync()
Returns
System.Threading.Tasks.Task<IEnumerable<Microsoft.AspNetCore.Authentication.AuthenticationScheme>>

Implements
IRM.AspNetCore.Authentication.Dynamic.IDynamicAuthenticationSchemeCache.GetAllSchemesAsync()

GetTenantAuthenticationSettings(Guid[], CancellationToken)

Gets a collection of TenantSettings for the specified tenantIds, if any.

Declaration
public async Task<List<TenantSettings>> GetTenantAuthenticationSettings(Guid[] tenantIds, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Guid[] tenantIds

A collection of unique identifier for tenants.
System.Threading.CancellationToken cancellationToken

The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.
Returns
System.Threading.Tasks.Task<List<TenantSettings>>

A collection of TenantSettings for the specified tenantIds, if any.
Implements

SetSignInOptionsAsync(IEnumerable<TenantSettings>, CancellationToken)

Updates the cache with all TenantSettings for all tenants.

Declaration
public Task SetSignInOptionsAsync(IEnumerable<TenantSettings> authenticationSettings, CancellationToken cancellationToken = default(CancellationToken))
Parameters
IEnumerable<TenantSettings> authenticationSettings

The collection of authentication settings.
System.Threading.CancellationToken cancellationToken

The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.
Returns
System.Threading.Tasks.Task

Implements