Show / Hide Table of Contents

Class MetadataLoader

Loads SAML metadata.

Inheritance
System.Object
MetadataLoader
Implements
IMetadataLoader
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)
System.Object.ToString()
Namespace: ComponentSpace.Saml2.Metadata
Assembly: ComponentSpace.Saml2.dll
Syntax
public class MetadataLoader : IMetadataLoader

Constructors

MetadataLoader(SamlHttpClient)

Initializes a new instance of the MetadataLoader class.

Declaration
public MetadataLoader(SamlHttpClient samlHttpClient)
Parameters
Type Name Description
SamlHttpClient samlHttpClient

The SAML HTTP client.

Methods

Load(XmlElement)

Loads the SAML metadata XML.

Declaration
public virtual EntitiesDescriptor Load(XmlElement xmlElement)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement

The metadata XML.

Returns
Type Description
EntitiesDescriptor

The SAML metadata.

Exceptions
Type Condition
SamlException

Thrown when the SAML metadata cannot be loaded.

LoadFile(String)

Loads the SAML metadata file.

Declaration
public virtual EntitiesDescriptor LoadFile(string fileName)
Parameters
Type Name Description
System.String fileName

The SAML metadata file

Returns
Type Description
EntitiesDescriptor

The SAML metadata.

Exceptions
Type Condition
SamlException

Thrown when the SAML metadata cannot be loaded.

LoadUrlAsync(String)

Loads SAML metadata from a download URL.

Declaration
public virtual async Task<EntitiesDescriptor> LoadUrlAsync(string url)
Parameters
Type Name Description
System.String url

The metadata download URL.

Returns
Type Description
System.Threading.Tasks.Task<EntitiesDescriptor>

The SAML metadata.

Exceptions
Type Condition
SamlException

Thrown when the SAML metadata cannot be loaded.

Implements

IMetadataLoader
In This Article
Back to top Copyright © ComponentSpace Pty Ltd 2017-2022. All rights reserved.