Class EntitiesDescriptor

Represents an entities descriptor.

Inheritance

System.Object

EntitiesDescriptor

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 EntitiesDescriptor

Remarks

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

Constructors

EntitiesDescriptor()

Initializes a new instance of the EntitiesDescriptor class.

Declaration

public EntitiesDescriptor()

EntitiesDescriptor(XmlElement)

Initializes a new instance of the EntitiesDescriptor class from XML.

Declaration

public EntitiesDescriptor(XmlElement xmlElement)

Parameters

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

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML deserialization fails.

Properties

CacheDuration

Gets or sets the cache duration.

Declaration

public Duration CacheDuration { get; set; }

Property Value

Type	Description
Duration	The cache duration.

EntitiesDescriptors

Gets or sets the list of entities descriptors.

Declaration

public IList<EntitiesDescriptor> EntitiesDescriptors { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<EntitiesDescriptor>	The list of entities descriptors.

EntityDescriptors

Gets or sets the list of entity descriptors.

Declaration

public IList<EntityDescriptor> EntityDescriptors { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<EntityDescriptor>	The list of entity descriptors.

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.

Name

Gets or sets the name.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	The name.

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

GetEntityDescriptor(String)

Gets the entity descriptor identified by the entity ID.

Declaration

public EntityDescriptor GetEntityDescriptor(string entityID)

Parameters

Type	Name	Description
System.String	entityID	The entity ID of the entity descriptor.

Returns

Type	Description
EntityDescriptor	The entity descriptor of null if none.

IsValid(XmlElement)

Indicates whether the XML is an entities 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 entities descriptor; otherwise false.

ToXml()

Serializes the entities descriptor to XML.

Declaration

public XmlElement ToXml()

Returns

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

Remarks

An XML document is created.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the entities 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 entities descriptor as XML.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.