Class SamlConfigurationResolver

Resolves configuration using the SAML configuration.

Inheritance

System.Object

AbstractSamlConfigurationResolver

SamlConfigurationResolver

Implements

ISamlConfigurationResolver

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: ComponentSpace.Saml2.Configuration.Resolver

Assembly: ComponentSpace.Saml2.dll

Syntax

public class SamlConfigurationResolver : AbstractSamlConfigurationResolver, ISamlConfigurationResolver

Constructors

SamlConfigurationResolver(IOptionsMonitor<SamlConfigurations>)

Initializes a new instance of the SamlConfigurationResolver class.

Declaration

public SamlConfigurationResolver(IOptionsMonitor<SamlConfigurations> samlConfigurations)

Parameters

Type	Name	Description
Microsoft.Extensions.Options.IOptionsMonitor<SamlConfigurations>	samlConfigurations	The SAML configurations.

Methods

GetLocalIdentityProviderConfigurationAsync(String)

Gets the LocalIdentityProviderConfiguration.

Declaration

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

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<LocalIdentityProviderConfiguration>	A task that represents the operation and returns the local identity provider configuration.

Overrides

AbstractSamlConfigurationResolver.GetLocalIdentityProviderConfigurationAsync(String)

Exceptions

Type	Condition
SamlException	Thrown when the local identity provider configuration cannot be found.

GetLocalServiceProviderConfigurationAsync(String)

Gets the LocalServiceProviderConfiguration.

Declaration

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

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<LocalServiceProviderConfiguration>	A task that represents the operation and returns the local service provider configuration.

Overrides

AbstractSamlConfigurationResolver.GetLocalServiceProviderConfigurationAsync(String)

Exceptions

Type	Condition
SamlException	Thrown when the local service provider configuration cannot be found.

GetPartnerIdentityProviderConfigurationAsync(String, String)

Gets the PartnerIdentityProviderConfiguration given the partner name.

Declaration

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

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.
System.String	partnerName	The partner name.

Returns

Type	Description
System.Threading.Tasks.Task<PartnerIdentityProviderConfiguration>	A task that represents the operation and returns the partner identity provider configuration.

Overrides

AbstractSamlConfigurationResolver.GetPartnerIdentityProviderConfigurationAsync(String, String)

Exceptions

Type	Condition
SamlException	Thrown when the partner identity provider configuration cannot be found.

GetPartnerIdentityProviderNamesAsync(String)

Gets the names of the partner identity providers.

Declaration

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

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.String>>	A task that represents the operation and returns the names of the partner identity providers.

Overrides

AbstractSamlConfigurationResolver.GetPartnerIdentityProviderNamesAsync(String)

Exceptions

Type	Condition
SamlException	Thrown when the partner identity provider names cannot be retrieved.

GetPartnerServiceProviderConfigurationAsync(String, String)

Gets the PartnerServiceProviderConfiguration given the partner name.

Declaration

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

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.
System.String	partnerName	The partner name.

Returns

Type	Description
System.Threading.Tasks.Task<PartnerServiceProviderConfiguration>	A task that represents the operation and returns the partner service provider configuration.

Overrides

AbstractSamlConfigurationResolver.GetPartnerServiceProviderConfigurationAsync(String, String)

Exceptions

Type	Condition
SamlException	Thrown when the partner service provider configuration cannot be found.

GetPartnerServiceProviderNamesAsync(String)

Gets the names of the partner service providers.

Declaration

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

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.String>>	A task that represents the operation and returns the names of the partner service providers.

Overrides

AbstractSamlConfigurationResolver.GetPartnerServiceProviderNamesAsync(String)

Exceptions

Type	Condition
SamlException	Thrown when the partner service provider names cannot be retrieved.

IsLocalIdentityProviderAsync(String)

Indicates whether a local identity provider is configured.

Declaration

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

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	true if a local identity provider is configured; otherwise false.

Overrides

AbstractSamlConfigurationResolver.IsLocalIdentityProviderAsync(String)

IsLocalServiceProviderAsync(String)

Indicates whether a local service provider is configured.

Declaration

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

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	true if a local service provider is configured; otherwise false.

Overrides

AbstractSamlConfigurationResolver.IsLocalServiceProviderAsync(String)

ToString()

Returns the configuration as a string.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The configuration as a string.

Overrides

System.Object.ToString()

Implements

ISamlConfigurationResolver