Class Artifact

Represents an artifact.

Inheritance
object
Artifact
Inherited Members
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
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
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
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
XmlElement xmlElement

The XML to test.
Returns
Type Description
bool

true if the XML is an artifact; otherwise false.

ToString()

Returns the artifact value.

Declaration
public override string ToString()
Returns
Type Description
string

The artifact value
Overrides

ToXml(XmlDocument)

Serializes the artifact to XML.

Declaration
public XmlElement ToXml(XmlDocument xmlDocument)
Parameters
Type Name Description
XmlDocument xmlDocument

The owning XML document.
Returns
Type Description
XmlElement

The artifact as XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.