Class KeyDescriptor

Represents a key descriptor.

Inheritance
System.Object
KeyDescriptor
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 KeyDescriptor
Remarks

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

Constructors

KeyDescriptor()

Initializes a new instance of the KeyDescriptor class.

Declaration
public KeyDescriptor()

KeyDescriptor(XmlElement)

Initializes a new instance of the KeyDescriptor class from XML.

Declaration
public KeyDescriptor(XmlElement xmlElement)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement

The key descriptor XML.
Exceptions
Type Condition
SamlSerializationException

Thrown when the XML deserialization fails.

Properties

EncryptionMethods

Gets or sets the list of encryption methods.

Declaration
public IList<EncryptionMethod> EncryptionMethods { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<EncryptionMethod>

The list of encryption methods.

KeyInfo

Gets or sets the key info.

Declaration
public XmlElement KeyInfo { get; set; }
Property Value
Type Description
System.Xml.XmlElement

The key info.

Use

Gets or sets the use.

Declaration
public string Use { get; set; }
Property Value
Type Description
System.String

The use.
See Also

Methods

IsValid(XmlElement)

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

ToXml()

Serializes the key descriptor to XML.

Declaration
public XmlElement ToXml()
Returns
Type Description
System.Xml.XmlElement

The key descriptor as XML.
Exceptions
Type Condition
SamlSerializationException

Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the key 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 key descriptor as XML.
Exceptions
Type Condition
SamlSerializationException

Thrown when the XML serialization fails.