Class SamlConfigurationResolver

Resolves configuration using the SAML configuration.

Inheritance

object

AbstractSamlConfigurationResolver

SamlConfigurationResolver

Implements

ISamlConfigurationResolver

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: ComponentSpace.Saml2.Configuration.Resolver

Assembly: ComponentSpace.Saml2.dll

Syntax

public class SamlConfigurationResolver : AbstractSamlConfigurationResolver, ISamlConfigurationResolver

Constructors

SamlConfigurationResolver(IOptionsMonitor<SamlConfigurations>, ISamlConfigurationChangeListener)

Initializes a new instance of the SamlConfigurationResolver class.

Declaration

public SamlConfigurationResolver(IOptionsMonitor<SamlConfigurations> samlConfigurations, ISamlConfigurationChangeListener samlConfigurationChangeListener)

Parameters

Type	Name	Description
IOptionsMonitor<SamlConfigurations>	samlConfigurations	The SAML configurations.
ISamlConfigurationChangeListener	samlConfigurationChangeListener	The SAML configuration change listener.

Methods

GetLocalIdentityProviderConfigurationAsync(string)

Gets the LocalIdentityProviderConfiguration.

Declaration

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

Parameters

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

Returns

Type	Description
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
string	configurationName	The configuration name or null if none.

Returns

Type	Description
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
string	configurationName	The configuration name or null if none.
string	partnerName	The partner name.

Returns

Type	Description
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
string	configurationName	The configuration name or null if none.

Returns

Type	Description
Task<IList<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
string	configurationName	The configuration name or null if none.
string	partnerName	The partner name.

Returns

Type	Description
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
string	configurationName	The configuration name or null if none.

Returns

Type	Description
Task<IList<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
string	configurationName	The configuration name or null if none.

Returns

Type	Description
Task<bool>	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
string	configurationName	The configuration name or null if none.

Returns

Type	Description
Task<bool>	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
string	The configuration as a string.

Overrides

object.ToString()

Implements

ISamlConfigurationResolver