Class SoapBinding

Supports the SOAP binding.

Inheritance

object

SoapBinding

Implements

ISoapBinding

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: ComponentSpace.Saml2.Bindings.Soap

Assembly: ComponentSpace.Saml2.dll

Syntax

public class SoapBinding : ISoapBinding

Remarks

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

Constructors

SoapBinding(IHttpRequest, IHttpResponse, SamlHttpClient, ILoggerFactory)

Initializes a new instance of the SoapBinding class.

Declaration

public SoapBinding(IHttpRequest request, IHttpResponse response, SamlHttpClient samlHttpClient, ILoggerFactory loggerFactory)

Parameters

Type	Name	Description
IHttpRequest	request	The HTTP request.
IHttpResponse	response	The HTTP response.
SamlHttpClient	samlHttpClient	The SAML HTTP client.
ILoggerFactory	loggerFactory	The logger factory.

Methods

IsValid()

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

Declaration

public virtual bool IsValid()

Returns

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

ReceiveRequestAsync()

Receives a SAML request.

Declaration

public virtual Task<ReceiveResult> ReceiveRequestAsync()

Returns

Type	Description
Task<ReceiveResult>	A task that represents the operation and returns the HTTP SOAP result.

Exceptions

Type	Condition
SamlBindingException	Thrown if the SAML request cannot be received.

SendRequestReceiveResponseAsync(string, string)

Sends a SAML request and receives a SAML response.

Declaration

public virtual Task<ReceiveResult> SendRequestReceiveResponseAsync(string url, string message)

Parameters

Type	Name	Description
string	url	The URL to receive the SAML message.
string	message	The SAML message XML.

Returns

Type	Description
Task<ReceiveResult>	A task that represents the operation and returns the HTTP SOAP result.

Exceptions

Type	Condition
SamlBindingException	Thrown if the SAML request cannot be sent or the SAML response cannot be received.

SendResponseAsync(string)

Sends a SAML response.

Declaration

public virtual Task SendResponseAsync(string message)

Parameters

Type	Name	Description
string	message	The SAML message XML.

Returns

Type	Description
Task	A task that represents the operation.

Exceptions

Type	Condition
SamlBindingException	Thrown if the SAML message cannot be sent.

Implements

ISoapBinding