Class AffiliationDescriptor

Represents an affiliation descriptor.

Inheritance

System.Object

AffiliationDescriptor

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

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

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

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: ComponentSpace.SAML2.Metadata

Assembly: ComponentSpace.Saml2.dll

Syntax

public class AffiliationDescriptor

Remarks

Refer to the Metadata for the OASIS Security Assertion Markup Language (SAML) V2.0 specification for further details.

Constructors

AffiliationDescriptor()

Initializes a new instance of the AffiliationDescriptor class.

Declaration

public AffiliationDescriptor()

AffiliationDescriptor(XmlElement)

Initializes a new instance of the AffiliationDescriptor class from XML.

Declaration

public AffiliationDescriptor(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The affiliation descriptor XML.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML deserialization fails.

Properties

AffiliateMembers

Gets or sets the list of affiliate members.

Declaration

public IList<EntityIDType> AffiliateMembers { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<EntityIDType>	The list of affiliate members.

AffiliationOwnerID

Gets or sets the affiliation owner ID.

Declaration

public string AffiliationOwnerID { get; set; }

Property Value

Type	Description
System.String	The affiliation owner ID.

CacheDuration

Gets or sets the cache duration.

Declaration

public Duration CacheDuration { get; set; }

Property Value

Type	Description
Duration	The cache duration.

Extensions

Gets or sets the extensions.

Declaration

public Extensions Extensions { get; set; }

Property Value

Type	Description
Extensions	The extensions.

ID

Gets or sets the ID.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	The ID.

KeyDescriptors

Gets or sets the list of key descriptors.

Declaration

public IList<KeyDescriptor> KeyDescriptors { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<KeyDescriptor>	The list of key descriptors.

Signature

Gets or sets the digital signature.

Declaration

public XmlElement Signature { get; set; }

Property Value

Type	Description
System.Xml.XmlElement	The digital signature.

Remarks

To generate or verify signatures, use SAMLMetadataSignature.

See Also

SAMLMetadataSignature

ValidUntil

Gets or sets the valid until date/time.

Declaration

public DateTime ValidUntil { get; set; }

Property Value

Type	Description
System.DateTime	The valid until date/time.

Methods

IsValid(XmlElement)

Indicates whether the XML is an affiliation descriptor.

Declaration

public static bool IsValid(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The XML to test.

Returns

Type	Description
System.Boolean	true if the XML is an affiliation descriptor; otherwise false.

ToXml()

Serializes the affiliation descriptor to XML.

Declaration

public XmlElement ToXml()

Returns

Type	Description
System.Xml.XmlElement	The affiliation descriptor as XML.

Remarks

An XML document is created.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the affiliation descriptor to XML.

Declaration

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

Type	Name	Description
System.Xml.XmlDocument	xmlDocument	The owning XML document.

Returns

Type	Description
System.Xml.XmlElement	The affiliation descriptor as XML.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.