Class HttpPostBinding

Namespace

ComponentSpace.Saml2.Bindings.Post

Assembly

ComponentSpace.Saml2.dll

Supports the HTTP POST binding.

public class HttpPostBinding : IHttpPostBinding

Inheritance

object

HttpPostBinding

Implements

IHttpPostBinding

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

HttpPostBinding(IHttpRequest, IHttpResponse, IHttpPostForm, ILoggerFactory)

Initializes a new instance of the HttpPostBinding class.

public HttpPostBinding(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.

ReceiveMessageAsync()

Receives a SAML message.

public virtual Task<ReceiveResult> ReceiveMessageAsync()

Returns

Task<ReceiveResult>

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

Exceptions

SamlBindingException

Thrown if the SAML message cannot be received.

SendMessageAsync(string, string, bool, string)

Sends a SAML message.

public virtual Task SendMessageAsync(string url, string message, bool isResponse, string relayState)

Parameters

url string

The URL to receive the HTML form.

message string

The SAML message XML.

isResponse bool

The flag indicating whether a SAML request or response.

relayState string

The relay state or null if none.

Returns

Task

A task that represents the operation.

Exceptions

SamlBindingException

Thrown if the SAML message cannot be sent.