Table of Contents

Class Status

Namespace
ComponentSpace.Saml2.Protocols
Assembly
ComponentSpace.Saml2.dll

Represents a status.

public class Status
Inheritance
Status
Inherited Members

Remarks

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

Constructors

Status()

Initializes a new instance of the Status class.

public Status()

Status(string, string)

Initializes a new instance of the Status class.

public Status(string statusCode, string statusMessage)

Parameters

statusCode string

The status code.

statusMessage string

The status message or null if none.

Status(string, string, string)

Initializes a new instance of the Status class.

public Status(string statusCode, string subordinateStatusCode, string statusMessage)

Parameters

statusCode string

The status code.

subordinateStatusCode string

The subordinate status code or null if none.

statusMessage string

The status message or null if none.

Status(XmlElement)

Initializes a new instance of the Status class from XML.

public Status(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The status XML.

Exceptions

SamlSerializationException

Thrown when the XML deserialization fails.

Properties

StatusCode

Gets or sets the status code.

public StatusCode StatusCode { get; set; }

Property Value

StatusCode

The status code.

StatusDetail

Gets or sets the status detail.

public StatusDetail StatusDetail { get; set; }

Property Value

StatusDetail

The status detail.

StatusMessage

Gets or sets the status message.

public StatusMessage StatusMessage { get; set; }

Property Value

StatusMessage

The status message.

Methods

IsValid(XmlElement)

Indicates whether the XML is a status.

public static bool IsValid(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The XML to test.

Returns

bool

true if the XML is status; otherwise false.

ToString()

Returns the status.

public override string ToString()

Returns

string

The status

ToXml(XmlDocument)

Serializes the status to XML.

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

xmlDocument XmlDocument

The owning XML document.

Returns

XmlElement

The status as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.