Class AttributeConsumingService

Represents an attribute consuming service.

Inheritance

System.Object

AttributeConsumingService

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 AttributeConsumingService

Remarks

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

Constructors

AttributeConsumingService()

Initializes a new instance of the AttributeConsumingService class.

Declaration

public AttributeConsumingService()

AttributeConsumingService(XmlElement)

Initializes a new instance of the AttributeConsumingService class from XML.

Declaration

public AttributeConsumingService(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The attribute consuming service XML.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML deserialization fails.

Properties

Index

Gets or sets the index.

Declaration

public int Index { get; set; }

Property Value

Type	Description
System.Int32	The index.

IsDefault

Gets or sets the is default flag.

Declaration

public bool IsDefault { get; set; }

Property Value

Type	Description
System.Boolean	The is default flag.

RequestedAttributes

Gets or sets the list of requested attributes.

Declaration

public IList<RequestedAttribute> RequestedAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<RequestedAttribute>	The list of requested attributes.

ServiceDescriptions

Gets or sets the list of service descriptions.

Declaration

public IList<LocalizedNameType> ServiceDescriptions { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<LocalizedNameType>	The list of service descriptions.

ServiceNames

Gets or sets the list of service names.

Declaration

public IList<LocalizedNameType> ServiceNames { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<LocalizedNameType>	The list of service names.

Methods

IsValid(XmlElement)

Indicates whether the XML is an attribute consuming service.

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 attribute consuming service; otherwise false.

ToXml(XmlDocument)

Serializes the attribute consuming service 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 attribute consuming service as XML.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.