CookieHandlerElement Class

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Represents the <cookieHandler> configuration element.

Namespace: Microsoft.IdentityModel.Web.Configuration
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As CookieHandlerElement

Syntax

'Declaration
Public Class CookieHandlerElement
    Inherits ConfigurationElement

public class CookieHandlerElement : ConfigurationElement

public ref class CookieHandlerElement : public ConfigurationElement

public class CookieHandlerElement extends ConfigurationElement

public class CookieHandlerElement extends ConfigurationElement

Remarks

The <cookieHandler> element is a subelement of the <federatedAuthentication> element; the FederatedAuthenticationElement.CookieHandler property is set to an instance of the CookieHandlerElement class. The <cookieHandler> element is used to configure the cookie handler used by the Session Authentication Module (SAM), which is represented by the SessionAuthenticationModule class.

A cookie handler can be configured in one of the following ways:

To configure a chunked cookie handler, set the Mode property to either Default or Chunked and set the ChunkedCookieHandler property with the configuration element for your chunked cookie handler. The CustomCookieHandler property should not be set.
To configure a chunked cookie handler with the default chunk size, you can set the Mode property as above, but leave both the ChunkedCookieHandler and the CustomCookieHandler properties unset.
To configure a custom cookie handler, set the Mode property to Custom and set the CustomCookieHandler property with the configuration element that identifies the type of your custom cookie handler. This type must derive from the CookieHandler class. The ChunkedCookieHandler property should not be set.

Inheritance Hierarchy

System.Object
System.Configuration.ConfigurationElement
Microsoft.IdentityModel.Web.Configuration.CookieHandlerElement

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)