Interface IMetadataToConfiguration

Imports SAML metadata to SAML configuration.

Namespace: ComponentSpace.Saml2.Metadata.Import

Assembly: ComponentSpace.Saml2.dll

Syntax

public interface IMetadataToConfiguration

Methods

Import(EntitiesDescriptor)

Imports the SAML metadata entities descriptor.

Declaration

SamlConfiguration Import(EntitiesDescriptor entitiesDescriptor)

Parameters

Type	Name	Description
EntitiesDescriptor	entitiesDescriptor	The entities descriptor.

Returns

Type	Description
SamlConfiguration	The SAML configuration.

Exceptions

Type	Condition
SamlException	Thrown when the SAML metadata cannot be imported.

Import(EntityDescriptor)

Imports the SAML metadata entity descriptor.

Declaration

SamlConfiguration Import(EntityDescriptor entityDescriptor)

Parameters

Type	Name	Description
EntityDescriptor	entityDescriptor	The entity descriptor.

Returns

Type	Description
SamlConfiguration	The SAML configuration.

Exceptions

Type	Condition
SamlException	Thrown when the SAML metadata cannot be imported.

Import(XmlElement)

Imports the SAML metadata XML.

Declaration

SamlConfiguration Import(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The metadata XML.

Returns

Type	Description
SamlConfiguration	The SAML configuration.

Exceptions

Type	Condition
SamlException	Thrown when the SAML metadata cannot be imported.

ImportAsync(String)

Imports the SAML metadata from a file or download URL.

Declaration

Task<SamlConfiguration> ImportAsync(string metadataLocation)

Parameters

Type	Name	Description
System.String	metadataLocation	The SAML metadata file or download URL.

Returns

Type	Description
System.Threading.Tasks.Task<SamlConfiguration>	The SAML configuration.

Exceptions

Type	Condition
SamlException	Thrown when the SAML metadata cannot be imported.

ImportFileAsync(String)

Imports the SAML metadata file.

Declaration

Task<SamlConfiguration> ImportFileAsync(string fileName)

Parameters

Type	Name	Description
System.String	fileName	The SAML metadata file.

Returns

Type	Description
System.Threading.Tasks.Task<SamlConfiguration>	The SAML configuration.

Exceptions

Type	Condition
SamlException	Thrown when the SAML metadata cannot be imported.

ImportUrlAsync(String)

Imports SAML metadata from a download URL.

Declaration

Task<SamlConfiguration> ImportUrlAsync(string url)

Parameters

Type	Name	Description
System.String	url	The metadata download URL.

Returns

Type	Description
System.Threading.Tasks.Task<SamlConfiguration>	The SAML configuration.

Exceptions

Type	Condition
SamlException	Thrown when the SAML metadata cannot be imported.