Class StatusCode

Represents a status code.

Inheritance

System.Object

StatusCode

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 StatusCode

Remarks

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

Constructors

StatusCode()

Initializes a new instance of the StatusCode class.

Declaration

public StatusCode()

StatusCode(String)

Initializes a new instance of the StatusCode class.

Declaration

public StatusCode(string code)

Parameters

Type	Name	Description
System.String	code	The status code.

See Also

SamlConstants.PrimaryStatusCodes

SamlConstants.SecondaryStatusCodes

StatusCode(XmlElement)

Initializes a new instance of the StatusCode class from XML.

Declaration

public StatusCode(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The status code XML.

Exceptions

Type	Condition
SamlSerializationException	Thrown when the XML deserialization fails.

Properties

Code

Gets or sets the status code.

Declaration

public string Code { get; set; }

Property Value

Type	Description
System.String	The status code.

See Also

SamlConstants.PrimaryStatusCodes

SamlConstants.SecondaryStatusCodes

SubordinateStatusCode

Gets or sets the subordinate status code.

Declaration

public StatusCode SubordinateStatusCode { get; set; }

Property Value

Type	Description
StatusCode	The subordinate status code.

Methods

IsValid(XmlElement)

Indicates whether the XML is a status code.

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 status code; otherwise false.

ToString()

Returns the status code.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The status code.

Overrides

System.Object.ToString()

ToXml(XmlDocument)

Serializes the status code 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 status code as XML.

Exceptions

Type	Condition
SamlSerializationException	Thrown when the XML serialization fails.