CookieHandlerElement Class

Reference

Definition

Namespace:: System.IdentityModel.Services

Assembly:: System.IdentityModel.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the <cookieHandler> configuration element.

public ref class CookieHandlerElement : System::Configuration::ConfigurationElement

public class CookieHandlerElement : System.Configuration.ConfigurationElement

type CookieHandlerElement = class
    inherit ConfigurationElement

Public Class CookieHandlerElement
Inherits ConfigurationElement

Inheritance: Object

ConfigurationElement
CookieHandlerElement

Remarks

The <cookieHandler> element is a child element of the <federatedAuthentication> element; the FederationConfiguration.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 mentioned earlier, 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.

Constructors

CookieHandlerElement()

Initializes a new instance of the CookieHandlerElement class.

Properties

ChunkedCookieHandler	Gets or sets a chunked cookie handler.
CurrentConfiguration	Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement)
CustomCookieHandler	Gets or sets a custom cookie handler type. This property must be set when a custom cookie handler is being configured.
Domain	Gets or sets the domain value for cookies written by the handler.
ElementInformation	Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement)
ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement)
EvaluationContext	Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement)
HasContext	Gets a value that indicates whether the CurrentConfiguration property is `null`. (Inherited from ConfigurationElement)
HideFromScript	Gets or sets a value that specifies whether the `httpOnly` property of the cookies written by this handler should be set.
Item[ConfigurationProperty]	Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement)
Item[String]	Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement)
LockAllAttributesExcept	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockAllElementsExcept	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockAttributes	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockElements	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockItem	Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement)
Mode	Gets or sets the cookie handler mode.
Name	Gets or sets the base name for any cookies written by the handler.
Path	Gets or sets the path value for cookies written by the handler.
PersistentSessionLifetime	Gets or sets the lifetime of cookies issued by the handler.
Properties	Gets the collection of properties. (Inherited from ConfigurationElement)
RequireSsl	Gets or sets a value that specifies whether the cookie should be used only with SSL.

Methods

DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
Equals(Object)	Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement)
GetConfiguredCookieHandler()	Gets a new cookie handler based on the configuration properties.
GetHashCode()	Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement)
GetTransformedAssemblyString(String)	Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement)
GetTransformedTypeString(String)	Returns the transformed version of the specified type name. (Inherited from ConfigurationElement)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Init()	Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement)
InitializeDefault()	Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement)
IsModified()	Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement)
IsReadOnly()	Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement)
ListErrors(IList)	Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)	Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String)	Throws an exception when a required property is not found. (Inherited from ConfigurationElement)
PostDeserialize()	Called after deserialization. (Inherited from ConfigurationElement)
PreSerialize(XmlWriter)	Called before serialization. (Inherited from ConfigurationElement)
Reset(ConfigurationElement)	Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement)
ResetModified()	Resets the value of the IsModified() method to `false` when implemented in a derived class. (Inherited from ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Sets a property to the specified value. (Inherited from ConfigurationElement)
SetReadOnly()	Sets the IsReadOnly() property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement)

Applies to