Class HTTPArtifact
Represents an artifact used in the HTTP artifact binding.
Inherited Members
Namespace: ComponentSpace.SAML2.Bindings
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[] typeCode)
  Parameters
| Type | Name | Description | 
|---|---|---|
| byte[] | typeCode | The 2 byte type code.  | 
      
HTTPArtifact(byte[], byte[])
Initializes a new instance of the HTTPArtifact class.
Declaration
public HTTPArtifact(byte[] typeCode, byte[] endpointIndex)
  Parameters
| Type | Name | Description | 
|---|---|---|
| byte[] | typeCode | The 2 byte type code.  | 
      
| byte[] | endpointIndex | The 2 byte endpoint index.  | 
      
Fields
ArtifactMinimumLength
The minimum length in bytes
Declaration
public const int ArtifactMinimumLength = 4
  Field Value
| Type | Description | 
|---|---|
| int | 
EndpointIndexLength
The endpoint index length in bytes
Declaration
public const int EndpointIndexLength = 2
  Field Value
| Type | Description | 
|---|---|
| int | 
TypeCodeLength
The type code length in bytes
Declaration
public const int TypeCodeLength = 2
  Field Value
| Type | Description | 
|---|---|
| int | 
Properties
EndpointIndex
Gets or sets the 2 byte endpoint index.
Declaration
public byte[] EndpointIndex { get; set; }
  Property Value
| Type | Description | 
|---|---|
| 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 | 
|---|---|
| byte[] | The 2 byte type code.  | 
      
Exceptions
| Type | Condition | 
|---|---|
| SAMLBindingException | Thrown when the type code is invalid.  | 
      
Methods
FromArray(byte[])
Initializes the Artifact class from a byte array.
Declaration
public void FromArray(byte[] artifact)
  Parameters
| Type | Name | Description | 
|---|---|---|
| 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 byte[] ToArray()
  Returns
| Type | Description | 
|---|---|
| byte[] | The artifact as a byte array.  |