Show / Hide Table of Contents

Class SAMLHttpResponse

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

Inheritance
System.Object
System.Web.HttpResponseBase
SAMLHttpResponse
Implements
System.IDisposable
Inherited Members
System.Web.HttpResponseBase.AddCacheItemDependency(System.String)
System.Web.HttpResponseBase.AddCacheItemDependencies(System.Collections.ArrayList)
System.Web.HttpResponseBase.AddCacheItemDependencies(System.String[])
System.Web.HttpResponseBase.AddCacheDependency(System.Web.Caching.CacheDependency[])
System.Web.HttpResponseBase.AddFileDependency(System.String)
System.Web.HttpResponseBase.AddFileDependencies(System.Collections.ArrayList)
System.Web.HttpResponseBase.AddFileDependencies(System.String[])
System.Web.HttpResponseBase.AddOnSendingHeaders(System.Action<System.Web.HttpContextBase>)
System.Web.HttpResponseBase.AppendCookie(System.Web.HttpCookie)
System.Web.HttpResponseBase.AppendHeader(System.String, System.String)
System.Web.HttpResponseBase.AppendToLog(System.String)
System.Web.HttpResponseBase.ApplyAppPathModifier(System.String)
System.Web.HttpResponseBase.BeginFlush(System.AsyncCallback, System.Object)
System.Web.HttpResponseBase.BinaryWrite(System.Byte[])
System.Web.HttpResponseBase.Clear()
System.Web.HttpResponseBase.ClearContent()
System.Web.HttpResponseBase.ClearHeaders()
System.Web.HttpResponseBase.Close()
System.Web.HttpResponseBase.DisableKernelCache()
System.Web.HttpResponseBase.DisableUserCache()
System.Web.HttpResponseBase.End()
System.Web.HttpResponseBase.EndFlush(System.IAsyncResult)
System.Web.HttpResponseBase.Flush()
System.Web.HttpResponseBase.FlushAsync()
System.Web.HttpResponseBase.Pics(System.String)
System.Web.HttpResponseBase.Redirect(System.String)
System.Web.HttpResponseBase.RedirectToRoute(System.Object)
System.Web.HttpResponseBase.RedirectToRoute(System.String)
System.Web.HttpResponseBase.RedirectToRoute(System.Web.Routing.RouteValueDictionary)
System.Web.HttpResponseBase.RedirectToRoute(System.String, System.Object)
System.Web.HttpResponseBase.RedirectToRoute(System.String, System.Web.Routing.RouteValueDictionary)
System.Web.HttpResponseBase.RedirectToRoutePermanent(System.Object)
System.Web.HttpResponseBase.RedirectToRoutePermanent(System.String)
System.Web.HttpResponseBase.RedirectToRoutePermanent(System.Web.Routing.RouteValueDictionary)
System.Web.HttpResponseBase.RedirectToRoutePermanent(System.String, System.Object)
System.Web.HttpResponseBase.RedirectToRoutePermanent(System.String, System.Web.Routing.RouteValueDictionary)
System.Web.HttpResponseBase.RedirectPermanent(System.String)
System.Web.HttpResponseBase.RedirectPermanent(System.String, System.Boolean)
System.Web.HttpResponseBase.RemoveOutputCacheItem(System.String)
System.Web.HttpResponseBase.RemoveOutputCacheItem(System.String, System.String)
System.Web.HttpResponseBase.SetCookie(System.Web.HttpCookie)
System.Web.HttpResponseBase.TransmitFile(System.String)
System.Web.HttpResponseBase.TransmitFile(System.String, System.Int64, System.Int64)
System.Web.HttpResponseBase.Write(System.Char)
System.Web.HttpResponseBase.Write(System.Char[], System.Int32, System.Int32)
System.Web.HttpResponseBase.Write(System.Object)
System.Web.HttpResponseBase.Write(System.String)
System.Web.HttpResponseBase.WriteFile(System.String)
System.Web.HttpResponseBase.WriteFile(System.String, System.Boolean)
System.Web.HttpResponseBase.WriteFile(System.String, System.Int64, System.Int64)
System.Web.HttpResponseBase.WriteFile(System.IntPtr, System.Int64, System.Int64)
System.Web.HttpResponseBase.WriteSubstitution(System.Web.HttpResponseSubstitutionCallback)
System.Web.HttpResponseBase.PushPromise(System.String)
System.Web.HttpResponseBase.PushPromise(System.String, System.String, System.Collections.Specialized.NameValueCollection)
System.Web.HttpResponseBase.Buffer
System.Web.HttpResponseBase.BufferOutput
System.Web.HttpResponseBase.Cache
System.Web.HttpResponseBase.CacheControl
System.Web.HttpResponseBase.Charset
System.Web.HttpResponseBase.ClientDisconnectedToken
System.Web.HttpResponseBase.ContentEncoding
System.Web.HttpResponseBase.ContentType
System.Web.HttpResponseBase.Expires
System.Web.HttpResponseBase.ExpiresAbsolute
System.Web.HttpResponseBase.Filter
System.Web.HttpResponseBase.HeadersWritten
System.Web.HttpResponseBase.HeaderEncoding
System.Web.HttpResponseBase.IsClientConnected
System.Web.HttpResponseBase.IsRequestBeingRedirected
System.Web.HttpResponseBase.Output
System.Web.HttpResponseBase.RedirectLocation
System.Web.HttpResponseBase.Status
System.Web.HttpResponseBase.StatusCode
System.Web.HttpResponseBase.StatusDescription
System.Web.HttpResponseBase.SubStatusCode
System.Web.HttpResponseBase.SupportsAsyncFlush
System.Web.HttpResponseBase.SuppressContent
System.Web.HttpResponseBase.SuppressDefaultCacheControlHeader
System.Web.HttpResponseBase.SuppressFormsAuthenticationRedirect
System.Web.HttpResponseBase.TrySkipIisCustomErrors
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
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
System.IO.Stream outputStream

The stream used to output the SAML message.

System.Collections.Specialized.NameValueCollection headers

The HTTP headers or null if none

System.Web.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
System.IO.Stream outputStream

The stream used to output the SAML message.

System.Web.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
System.Web.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
System.Web.HttpCookieCollection

The collection of cookies.

Overrides
System.Web.HttpResponseBase.Cookies

Headers

Gets the collection of headers.

Declaration
public override NameValueCollection Headers { get; }
Property Value
Type Description
System.Collections.Specialized.NameValueCollection

The collection of headers.

Overrides
System.Web.HttpResponseBase.Headers

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
System.IO.Stream

The output stream used to send the SAML message.

Overrides
System.Web.HttpResponseBase.OutputStream

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
System.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
System.String name

The header name.

System.String value

The header value.

Overrides
System.Web.HttpResponseBase.AddHeader(System.String, System.String)

Dispose()

Dispose of any unmanaged resources.

Declaration
public void Dispose()

Dispose(Boolean)

Dispose of any unmanaged resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean 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
System.String

The output as a string.

Redirect(String, Boolean)

Redirects to the specified URL.

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

The target location.

System.Boolean endResponse

The flag indicating whether to terminate the current process.

Overrides
System.Web.HttpResponseBase.Redirect(System.String, System.Boolean)

Implements

System.IDisposable
In This Article
Back to top Copyright © ComponentSpace Pty Ltd 2004-2022. All rights reserved.