Class SamlConfigurationResolver

Namespace

ComponentSpace.Saml2.Configuration.Resolver

Assembly

ComponentSpace.Saml2.dll

Resolves configuration using the SAML configuration.

public class SamlConfigurationResolver : AbstractSamlConfigurationResolver, ISamlConfigurationResolver

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)

Constructors

SamlConfigurationResolver(IOptionsMonitor<SamlConfigurations>, ISamlConfigurationChangeListener)

Initializes a new instance of the SamlConfigurationResolver class.

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

Parameters

samlConfigurations IOptionsMonitor<SamlConfigurations>

The SAML configurations.

samlConfigurationChangeListener ISamlConfigurationChangeListener

The SAML configuration change listener.

Methods

GetLocalIdentityProviderConfigurationAsync(string)

Gets the LocalIdentityProviderConfiguration.

public override 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 override 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 override 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 override 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 override 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 override 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 override 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 override 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.

ToString()

Returns the configuration as a string.

public override string ToString()

Returns

string

The configuration as a string.