Class HttpArtifact
Represents an artifact used in the HTTP artifact binding.
Inherited Members
Namespace: ComponentSpace.Saml2.Bindings.Artifact
Assembly: ComponentSpace.Saml2.dll
Syntax
public abstract class HttpArtifact
Remarks
Refer to the Bindings for the OASIS Security Assertion Markup Language (SAML) V2.0 specification for further details.
Constructors
HttpArtifact()
Initializes a new instance of the HttpArtifact
class.
Declaration
public HttpArtifact()
HttpArtifact(Byte[])
Initializes a new instance of the HttpArtifact
class.
Declaration
public HttpArtifact(byte[] artifact)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | artifact | The artifact as a byte array |
Exceptions
Type | Condition |
---|---|
SamlBindingException | Thrown when the artifact is invalid. |
Fields
ArtifactMinimumLength
The minimum length in bytes
Declaration
public const int ArtifactMinimumLength = 4
Field Value
Type | Description |
---|---|
System.Int32 |
EndpointIndexLength
The endpoint index length in bytes
Declaration
public const int EndpointIndexLength = 2
Field Value
Type | Description |
---|---|
System.Int32 |
TypeCodeLength
The type code length in bytes
Declaration
public const int TypeCodeLength = 2
Field Value
Type | Description |
---|---|
System.Int32 |
Properties
EndpointIndex
Gets or sets the 2 byte endpoint index.
Declaration
public byte[] EndpointIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Byte[] | The 2 byte endpoint index. |
Exceptions
Type | Condition |
---|---|
SamlBindingException | Thrown when the endpoint index is invalid. |
TypeCode
Gets or sets the 2 byte type code.
Declaration
public byte[] TypeCode { get; set; }
Property Value
Type | Description |
---|---|
System.Byte[] | The 2 byte type code. |
Exceptions
Type | Condition |
---|---|
SamlBindingException | Thrown when the type code is invalid. |
Methods
FromArray(Byte[])
Initializes the HttpArtifact
class from a byte array.
Declaration
public void FromArray(byte[] artifact)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | artifact | The artifact as a byte array |
Exceptions
Type | Condition |
---|---|
SamlBindingException | Thrown when the artifact is invalid. |
ToArray()
Returns the artifact as a byte array.
Declaration
public virtual byte[] ToArray()
Returns
Type | Description |
---|---|
System.Byte[] | The artifact as a byte array. |
ToString()
Returns the artifact as a string.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | The artifact as a string. |