Class KeyDescriptor

Namespace

ComponentSpace.Saml2.Metadata

Assembly

ComponentSpace.Saml2.dll

Represents a key descriptor.

public class KeyDescriptor

Inheritance

object

KeyDescriptor

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

KeyDescriptor()

Initializes a new instance of the KeyDescriptor class.

public KeyDescriptor()

KeyDescriptor(XmlElement)

Initializes a new instance of the KeyDescriptor class from XML.

public KeyDescriptor(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The key descriptor XML.

Exceptions

SamlSerializationException

Thrown when the XML deserialization fails.

Properties

EncryptionMethods

Gets or sets the list of encryption methods.

public IList<EncryptionMethod> EncryptionMethods { get; set; }

Property Value

IList<EncryptionMethod>

The list of encryption methods.

KeyInfo

Gets or sets the key info.

public XmlElement KeyInfo { get; set; }

Property Value

XmlElement

The key info.

Use

Gets or sets the use.

public string Use { get; set; }

Property Value

string

The use.

See Also

KeyDescriptor.KeyTypes

Methods

IsValid(XmlElement)

Indicates whether the XML is a key descriptor.

public static bool IsValid(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The XML to test.

Returns

bool

true if the XML is a key descriptor; otherwise false.

ToXml()

Serializes the key descriptor to XML.

public XmlElement ToXml()

Returns

XmlElement

The key descriptor as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the key descriptor to XML.

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

xmlDocument XmlDocument

The owning XML document.

Returns

XmlElement

The key descriptor as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.