Class Artifact
Represents an artifact.
Inheritance
System.Object
Artifact
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)
Namespace: ComponentSpace.Saml2.Protocols
Assembly: ComponentSpace.Saml2.dll
Syntax
public class Artifact
Remarks
Refer to the Assertions and Protocol for the OASIS Security Assertion Markup Language (SAML) V2.0 specification for further details.
Constructors
Artifact()
Initializes a new instance of the Artifact
class.
Declaration
public Artifact()
Artifact(String)
Initializes a new instance of the Artifact
class.
Declaration
public Artifact(string artifactValue)
Parameters
Type | Name | Description |
---|---|---|
System.String | artifactValue | The artifact value. |
Artifact(XmlElement)
Initializes a new instance of the Artifact
class from XML.
Declaration
public Artifact(XmlElement xmlElement)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlElement | xmlElement | The artifact XML. |
Exceptions
Type | Condition |
---|---|
SamlSerializationException | Thrown when the XML deserialization fails. |
Properties
ArtifactValue
Gets or sets the artifact value.
Declaration
public string ArtifactValue { get; set; }
Property Value
Type | Description |
---|---|
System.String | The artifact value. |
Methods
IsValid(XmlElement)
Indicates whether the XML is an artifact.
Declaration
public static bool IsValid(XmlElement xmlElement)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlElement | xmlElement | The XML to test. |
Returns
Type | Description |
---|---|
System.Boolean |
|
ToString()
Returns the artifact value.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | The artifact value |
Overrides
System.Object.ToString()
ToXml(XmlDocument)
Serializes the artifact 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 as XML. |
Exceptions
Type | Condition |
---|---|
SamlSerializationException | Thrown when the XML serialization fails. |