Class SAMLHttpResponse

Provides a mechanism for sending a SAML protocol message through a non-standard HTTP response.

Inheritance
object
HttpResponseBase
SAMLHttpResponse
Implements
Inherited Members
Namespace: ComponentSpace.SAML2.Utility
Assembly: ComponentSpace.Saml2.dll
Syntax
public class SAMLHttpResponse : HttpResponseBase, IDisposable

Constructors

SAMLHttpResponse()

Initializes a new instance of the SAMLHttpResponse class.

Declaration
public SAMLHttpResponse()

SAMLHttpResponse(Stream, NameValueCollection, HttpCookieCollection)

Initializes a new instance of the SAMLHttpResponse class.

Declaration
public SAMLHttpResponse(Stream outputStream, NameValueCollection headers, HttpCookieCollection cookies)
Parameters
Type Name Description
Stream outputStream

The stream used to output the SAML message.
NameValueCollection headers

The HTTP headers or null if none
HttpCookieCollection cookies

The HTTP cookies or null if none

SAMLHttpResponse(Stream, HttpCookieCollection)

Initializes a new instance of the SAMLHttpResponse class.

Declaration
public SAMLHttpResponse(Stream outputStream, HttpCookieCollection cookies)
Parameters
Type Name Description
Stream outputStream

The stream used to output the SAML message.
HttpCookieCollection cookies

The HTTP cookies or null if none

SAMLHttpResponse(HttpCookieCollection)

Initializes a new instance of the SAMLHttpResponse class.

Declaration
public SAMLHttpResponse(HttpCookieCollection cookies)
Parameters
Type Name Description
HttpCookieCollection cookies

The HTTP cookies or null if none

Properties

Cookies

Gets the collection of cookies.

Declaration
public override HttpCookieCollection Cookies { get; }
Property Value
Type Description
HttpCookieCollection

The collection of cookies.
Overrides

Headers

Gets the collection of headers.

Declaration
public override NameValueCollection Headers { get; }
Property Value
Type Description
NameValueCollection

The collection of headers.
Overrides

OutputStream

Gets the output stream used to send the SAML message.

For the SAML HTTP-Post binding, the output stream contains the encoded SAML message wrapped in an HTML form.

Declaration
public override Stream OutputStream { get; }
Property Value
Type Description
Stream

The output stream used to send the SAML message.
Overrides

URL

Gets the redirect URL.

For the SAML HTTP-Redirect binding, the URL includes the encoded SAML message.

Declaration
public string URL { get; }
Property Value
Type Description
string

The redirect URL.

Methods

AddHeader(string, string)

Adds an HTTP header.

Declaration
public override void AddHeader(string name, string value)
Parameters
Type Name Description
string name

The header name.
string value

The header value.
Overrides

Dispose()

Dispose of any unmanaged resources.

Declaration
public void Dispose()

Dispose(bool)

Dispose of any unmanaged resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true if called by user code; false if called by the runtime from within the finalizer

GetOutputAsString()

Reads the output stream as a string.

Declaration
public string GetOutputAsString()
Returns
Type Description
string

The output as a string.

Redirect(string, bool)

Redirects to the specified URL.

Declaration
public override void Redirect(string url, bool endResponse)
Parameters
Type Name Description
string url

The target location.
bool endResponse

The flag indicating whether to terminate the current process.
Overrides

Implements