Class SamlCachedConfigurationResolver

Namespace

ComponentSpace.Saml2.Configuration.Resolver

Assembly

ComponentSpace.Saml2.dll

Resolves configuration via a cache of the SAML configuration provided by the underlying configuration resolver.

public class SamlCachedConfigurationResolver : ISamlCachedConfigurationResolver, ISamlConfigurationResolver

Inheritance

object

SamlCachedConfigurationResolver

Implements

ISamlCachedConfigurationResolver

ISamlConfigurationResolver

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

SamlCachedConfigurationResolver(IOptionsMonitor<SamlCachedConfigurationResolverOptions>, IServiceProvider, IMemoryCache, ILoggerFactory)

Initializes a new instance of the SamlCachedConfigurationResolver class.

public SamlCachedConfigurationResolver(IOptionsMonitor<SamlCachedConfigurationResolverOptions> samlCachedConfigurationResolverOptions, IServiceProvider serviceProvider, IMemoryCache memoryCache, ILoggerFactory loggerFactory)

Parameters

samlCachedConfigurationResolverOptions IOptionsMonitor<SamlCachedConfigurationResolverOptions>

The cached SAML configuration resolver options.

serviceProvider IServiceProvider

The service provider used to instantiate the SAML configuration resolver being cached.

memoryCache IMemoryCache

The memory cache used to store configuration.

loggerFactory ILoggerFactory

The logger factory.

Methods

GetLocalIdentityProviderConfigurationAsync(string)

Gets the LocalIdentityProviderConfiguration.

public virtual Task<LocalIdentityProviderConfiguration> GetLocalIdentityProviderConfigurationAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<LocalIdentityProviderConfiguration>

A task that represents the operation and returns the local identity provider configuration.

Exceptions

SamlException

Thrown when the local identity provider configuration cannot be found.

GetLocalServiceProviderConfigurationAsync(string)

Gets the LocalServiceProviderConfiguration.

public virtual Task<LocalServiceProviderConfiguration> GetLocalServiceProviderConfigurationAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<LocalServiceProviderConfiguration>

A task that represents the operation and returns the local service provider configuration.

Exceptions

SamlException

Thrown when the local service provider configuration cannot be found.

GetPartnerIdentityProviderConfigurationAsync(string, string)

Gets the PartnerIdentityProviderConfiguration given the partner name.

public virtual Task<PartnerIdentityProviderConfiguration> GetPartnerIdentityProviderConfigurationAsync(string configurationName = null, string partnerName = null)

Parameters

configurationName string

The configuration name or null if none.

partnerName string

The partner name.

Returns

Task<PartnerIdentityProviderConfiguration>

A task that represents the operation and returns the partner identity provider configuration.

Exceptions

SamlException

Thrown when the partner identity provider configuration cannot be found.

GetPartnerIdentityProviderNamesAsync(string)

Gets the names of the partner identity providers.

public virtual Task<IList<string>> GetPartnerIdentityProviderNamesAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<IList<string>>

A task that represents the operation and returns the names of the partner identity providers.

Exceptions

SamlException

Thrown when the partner identity provider names cannot be retrieved.

GetPartnerServiceProviderConfigurationAsync(string, string)

Gets the PartnerServiceProviderConfiguration given the partner name.

public virtual Task<PartnerServiceProviderConfiguration> GetPartnerServiceProviderConfigurationAsync(string configurationName = null, string partnerName = null)

Parameters

configurationName string

The configuration name or null if none.

partnerName string

The partner name.

Returns

Task<PartnerServiceProviderConfiguration>

A task that represents the operation and returns the partner service provider configuration.

Exceptions

SamlException

Thrown when the partner service provider configuration cannot be found.

GetPartnerServiceProviderNamesAsync(string)

Gets the names of the partner service providers.

public virtual Task<IList<string>> GetPartnerServiceProviderNamesAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<IList<string>>

A task that represents the operation and returns the names of the partner service providers.

Exceptions

SamlException

Thrown when the partner service provider names cannot be retrieved.

IsLocalIdentityProviderAsync(string)

Indicates whether a local identity provider is configured.

public virtual Task<bool> IsLocalIdentityProviderAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<bool>

true if a local identity provider is configured; otherwise false.

IsLocalServiceProviderAsync(string)

Indicates whether a local service provider is configured.

public virtual Task<bool> IsLocalServiceProviderAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<bool>

true if a local service provider is configured; otherwise false.

RemoveLocalIdentityProviderConfigurationAsync(string)

Removes the local identity provider configuration from the cache.

public virtual Task RemoveLocalIdentityProviderConfigurationAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task

A task that represents the operation.

RemoveLocalServiceProviderConfigurationAsync(string)

Removes the local service provider configuration from the cache.

public virtual Task RemoveLocalServiceProviderConfigurationAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task

A task that represents the operation.

RemovePartnerIdentityProviderConfigurationAsync(string, string)

Removes the partner identity provider configuration from the cache.

public virtual Task RemovePartnerIdentityProviderConfigurationAsync(string configurationName = null, string partnerName = null)

Parameters

configurationName string

The configuration name or null if none.

partnerName string

The partner name.

Returns

Task

A task that represents the operation.

RemovePartnerServiceProviderConfigurationAsync(string, string)

Removes the partner service provider configuration from the cache.

public virtual Task RemovePartnerServiceProviderConfigurationAsync(string configurationName = null, string partnerName = null)

Parameters

configurationName string

The configuration name or null if none.

partnerName string

The partner name.

Returns

Task

A task that represents the operation.

ToString()

Returns the configuration as a string.

public override string ToString()

Returns

string

The configuration as a string.