Class HttpArtifactBinding

Namespace

ComponentSpace.Saml2.Bindings.Artifact

Assembly

ComponentSpace.Saml2.dll

Supports the HTTP artifact binding.

public class HttpArtifactBinding : IHttpArtifactBinding

Inheritance

object

HttpArtifactBinding

Implements

IHttpArtifactBinding

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

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

Constructors

HttpArtifactBinding(IHttpRequest, IHttpResponse, IHttpPostForm, ILoggerFactory)

Initializes a new instance of the HttpArtifactBinding class.

public HttpArtifactBinding(IHttpRequest request, IHttpResponse response, IHttpPostForm httpPostForm, ILoggerFactory loggerFactory)

Parameters

request IHttpRequest

The HTTP request.

response IHttpResponse

The HTTP response.

httpPostForm IHttpPostForm

The HTTP Post form generator.

loggerFactory ILoggerFactory

The logger factory.

Methods

IsValid()

Indicates whether the current HTTP request is valid for the binding.

public virtual bool IsValid()

Returns

bool

true if the current HTTP request is valid for the binding; otherwise false.

ReceiveArtifactAsync()

Receives an HTTP artifact.

public virtual Task<ReceiveResult> ReceiveArtifactAsync()

Returns

Task<ReceiveResult>

A task that represents the operation and returns the HTTP artifact result.

Exceptions

SamlBindingException

Thrown if the HTTP artifact cannot be received.

SendArtifactAsync(string, ArtifactEncoding, HttpArtifact, string)

Sends an HTTP artifact.

public virtual Task SendArtifactAsync(string url, ArtifactEncoding encoding, HttpArtifact artifact, string relayState = null)

Parameters

url string

The URL to receive the artifact.

encoding ArtifactEncoding

The HTTP artifact encoding used to transport the artifact.

artifact HttpArtifact

The HTTP artifact.

relayState string

The relay state or null if none.

Returns

Task

A task that represents the operation.

Exceptions

SamlBindingException

Thrown if the HTTP artifact cannot be sent.