Class PAOSBinding

Supports the reverse SOAP (PAOS) binding.

Inheritance
object
PAOSBinding
Inherited Members
Namespace: ComponentSpace.SAML2.Bindings
Assembly: ComponentSpace.Saml2.dll
Syntax
public static class PAOSBinding
Remarks

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

Methods

ReceiveRequest(WebRequest)

Receives a SAML request. The SAML request is extracted from the received SOAP message.

Declaration
public static XmlElement ReceiveRequest(WebRequest webRequest)
Parameters
Type Name Description
WebRequest webRequest

The WebRequest object used to receive the request.
Returns
Type Description
XmlElement

The SAML request.
Remarks

The client can use this method to send an HTTP request and receive a SAML request from the service provider.

Exceptions
Type Condition
SAMLBindingException

Thrown when the receive fails.

ReceiveRequest(string)

Receives a SAML request. The SAML request is extracted from the received SOAP message.

Declaration
public static XmlElement ReceiveRequest(string destinationURL)
Parameters
Type Name Description
string destinationURL

The destination URL.
Returns
Type Description
XmlElement

The SAML request.
Remarks

The client can use this method to send an HTTP request and receive a SAML request from the service provider.

Exceptions
Type Condition
SAMLBindingException

Thrown when the receive fails.

ReceiveResponse(HttpRequestBase)

Receives a SAML response. The SAML response is extracted from the received SOAP message.

Declaration
public static XmlElement ReceiveResponse(HttpRequestBase httpRequest)
Parameters
Type Name Description
HttpRequestBase httpRequest

The HTTP request containing the SAML response.
Returns
Type Description
XmlElement

The SAML response.
Remarks

The service provider can use this method to receive a SAML response and send an HTTP response to the client.

Exceptions
Type Condition
SAMLBindingException

Thrown when the receive fails.

SendRequest(HttpResponseBase, XmlElement)

Sends a SAML request. The SAML request is wrapped in a SOAP message prior to sending.

Declaration
public static void SendRequest(HttpResponseBase httpResponse, XmlElement samlMessage)
Parameters
Type Name Description
HttpResponseBase httpResponse

The HTTP response that will return the SAML request.
XmlElement samlMessage

The SAML request.
Remarks

The service provider can use this method to return a SAML request in response to the client's HTTP request.

Exceptions
Type Condition
SAMLBindingException

Thrown when the send fails.

SendResponse(WebRequest, XmlElement)

Sends the SAML response. The SAML response is wrapped in a SOAP message prior to sending.

Declaration
public static void SendResponse(WebRequest webRequest, XmlElement samlMessage)
Parameters
Type Name Description
WebRequest webRequest

The WebRequest object used to send the response.
XmlElement samlMessage

The SAML response.
Remarks

The client can use this method to send a SAML response and receive an HTTP response from the service provider.

Exceptions
Type Condition
SAMLBindingException

Thrown when the send fails.

SendResponse(string, XmlElement)

Sends the SAML response. The SAML response is wrapped in a SOAP message prior to sending.

Declaration
public static void SendResponse(string destinationURL, XmlElement samlMessage)
Parameters
Type Name Description
string destinationURL

The destination URL.
XmlElement samlMessage

The SAML response.
Remarks

The client can use this method to send a SAML response and receive an HTTP response from the service provider.

Exceptions
Type Condition
SAMLBindingException

Thrown when the send fails.

See Also