Class EntitiesDescriptor

Namespace

ComponentSpace.Saml2.Metadata

Assembly

ComponentSpace.Saml2.dll

Represents an entities descriptor.

public class EntitiesDescriptor

Inheritance

object

EntitiesDescriptor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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.

public EntitiesDescriptor()

EntitiesDescriptor(XmlElement)

Initializes a new instance of the EntitiesDescriptor class from XML.

public EntitiesDescriptor(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The entities descriptor XML.

Exceptions

SamlSerializationException

Thrown when the XML deserialization fails.

Properties

CacheDuration

Gets or sets the cache duration.

public Duration CacheDuration { get; set; }

Property Value

Duration

The cache duration.

EntitiesDescriptors

Gets or sets the list of entities descriptors.

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

Property Value

IList<EntitiesDescriptor>

The list of entities descriptors.

EntityDescriptors

Gets or sets the list of entity descriptors.

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

Property Value

IList<EntityDescriptor>

The list of entity descriptors.

Extensions

Gets or sets the extensions.

public Extensions Extensions { get; set; }

Property Value

Extensions

The extensions.

ID

Gets or sets the ID.

public string ID { get; set; }

Property Value

string

The ID.

Name

Gets or sets the name.

public string Name { get; set; }

Property Value

string

The name.

ValidUntil

Gets or sets the valid until date/time.

public DateTime? ValidUntil { get; set; }

Property Value

DateTime?

The valid until date/time.

Methods

GetAllEntityDescriptors()

Gets the list of all the entity descriptors by combining the lists of entities and entity descriptors.

public IList<EntityDescriptor> GetAllEntityDescriptors()

Returns

IList<EntityDescriptor>

The list of all the entity descriptors.

GetEntityDescriptor(string)

Gets the entity descriptor identified by the entity ID.

public EntityDescriptor GetEntityDescriptor(string entityID)

Parameters

entityID string

The entity ID of the entity descriptor.

Returns

EntityDescriptor

The entity descriptor of null if none.

IsValid(XmlElement)

Indicates whether the XML is an entities descriptor.

public static bool IsValid(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The XML to test.

Returns

bool

true if the XML is an entities descriptor; otherwise false.

ToXml()

Serializes the entities descriptor to XML.

public XmlElement ToXml()

Returns

XmlElement

The entities descriptor as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the entities descriptor to XML.

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

xmlDocument XmlDocument

The owning XML document.

Returns

XmlElement

The entities descriptor as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.