Class ArtifactResponse

Represents an artifact response.

Inheritance
System.Object
StatusResponseType
ArtifactResponse
Inherited Members
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.Protocols
Assembly: ComponentSpace.Saml2.dll
Syntax
public class ArtifactResponse : StatusResponseType
Remarks

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

Constructors

ArtifactResponse()

Initializes a new instance of the ArtifactResponse class.

Declaration
public ArtifactResponse()

ArtifactResponse(XmlElement)

Initializes a new instance of the ArtifactResponse class from XML.

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

The artifact response XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML deserialization fails.

Properties

SAMLMessage

Gets or sets the SAML message.

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

The SAML message or null if none.

Methods

IsValid(XmlElement)

Indicates whether the XML is an artifact response.

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 artifact response; otherwise false.

ToString()

Converts the artifact response to a string.

Declaration
public override string ToString()
Returns
Type Description
System.String

The artifact response as a string.
Overrides
System.Object.ToString()

ToXml()

Serializes the artifact response to XML.

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

The artifact response as XML.
Remarks

An XML document is created.

Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the artifact response 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 artifact response as XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.