CookieHandlerElement 类

定义

命名空间:

System.IdentityModel.Services

程序集:

System.IdentityModel.Services.dll

表示 <cookieHandler> 配置元素。

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

public class CookieHandlerElement : System.Configuration.ConfigurationElement

type CookieHandlerElement = class
    inherit ConfigurationElement

Public Class CookieHandlerElement
Inherits ConfigurationElement

继承

Object

ConfigurationElement

CookieHandlerElement

注解

元素 <cookieHandler> 是 元素的 <federatedAuthentication> 子元素; FederationConfiguration.CookieHandler 属性设置为 类的 CookieHandlerElement 实例。 元素 <cookieHandler> 用于配置会话身份验证模块 (SAM) 使用的 Cookie 处理程序，该处理程序由 SessionAuthenticationModule 类表示。

可以通过以下方式之一配置 Cookie 处理程序：

• 若要配置分块 Cookie 处理程序，请将 Mode 属性设置为 Default 或 Chunked ，并使用 ChunkedCookieHandler 分块 Cookie 处理程序的配置元素设置 属性。 CustomCookieHandler不应设置 属性。

• 若要使用默认区块大小配置分块 Cookie 处理程序，可以如前所述设置 Mode 属性，但同时保留 ChunkedCookieHandler 和 CustomCookieHandler 属性未设置。

• 若要配置自定义 Cookie 处理程序，请将 Mode 属性设置为 Custom ，并使用 CustomCookieHandler 标识自定义 Cookie 处理程序类型的配置元素设置属性。 此类型必须派生自 CookieHandler 类。 ChunkedCookieHandler不应设置 属性。

构造函数

CookieHandlerElement()

初始化 CookieHandlerElement 类的新实例。

属性

ChunkedCookieHandler	获取或设置分块 Cookie 处理程序。
CurrentConfiguration	获取对顶级 Configuration 实例的引用，该实例表示当前 ConfigurationElement 实例所属的配置层次结构。 (继承自 ConfigurationElement)
CustomCookieHandler	获取或设置自定义 Cookie 处理程序类型。 当配置自定义 cookie 处理程序时必须设置此属性。
Domain	获取或设置处理程序编写的 Cookie 的域值。
ElementInformation	获取包含 ConfigurationElement 对象的不可自定义的信息和功能的 ElementInformation 对象。 (继承自 ConfigurationElement)
ElementProperty	获取表示 ConfigurationElement 对象本身的 ConfigurationElementProperty 对象。 (继承自 ConfigurationElement)
EvaluationContext	获取 ConfigurationElement 对象的 ContextInformation 对象。 (继承自 ConfigurationElement)
HasContext	获取一个值，该值指示 CurrentConfiguration 属性是否为 null。 (继承自 ConfigurationElement)
HideFromScript	获取或设置指定是否应设置此处理程序编写的 Cookie 的 httpOnly 属性的值。
Item[ConfigurationProperty]	获取或设置此配置元素的属性或特性。 (继承自 ConfigurationElement)
Item[String]	获取或设置此配置元素的属性、特性或子元素。 (继承自 ConfigurationElement)
LockAllAttributesExcept	获取被锁定的特性的集合。 (继承自 ConfigurationElement)
LockAllElementsExcept	获取被锁定的元素的集合。 (继承自 ConfigurationElement)
LockAttributes	获取被锁定的特性的集合。 (继承自 ConfigurationElement)
LockElements	获取被锁定的元素的集合。 (继承自 ConfigurationElement)
LockItem	获取或设置一个值，该值指示是否已锁定该元素。 (继承自 ConfigurationElement)
Mode	获取或设置 Cookie 处理程序流模式。
Name	获取或设置处理程序编写的任何 Cookie 的基名称。
Path	获取或设置处理程序编写的 Cookie 的路径值。
PersistentSessionLifetime	获取或设置处理程序颁发的 Cookie 的生命周期。
Properties	获取属性的集合。 (继承自 ConfigurationElement)
RequireSsl	获取或设置一个值，该值指定是否应只用 SSL 验证 Cookie。

方法

DeserializeElement(XmlReader, Boolean)	从配置文件读取 XML。 (继承自 ConfigurationElement)
Equals(Object)	将当前的 ConfigurationElement 实例与指定的对象进行比较。 (继承自 ConfigurationElement)
GetConfiguredCookieHandler()	基于配置属性获取新的 Cookie 处理程序。
GetHashCode()	获取表示当前 ConfigurationElement 实例的唯一值。 (继承自 ConfigurationElement)
GetTransformedAssemblyString(String)	返回指定程序集名称的转换版本。 (继承自 ConfigurationElement)
GetTransformedTypeString(String)	返回指定类型名称的转换版本。 (继承自 ConfigurationElement)
GetType()	获取当前实例的 Type。 (继承自 Object)
Init()	将 ConfigurationElement 对象设置为其初始状态。 (继承自 ConfigurationElement)
InitializeDefault()	用于初始化 ConfigurationElement 对象的默认值集。 (继承自 ConfigurationElement)
IsModified()	指示自上次保存或加载该配置元素后并在派生类中实现该元素时，该元素是否已被修改。 (继承自 ConfigurationElement)
IsReadOnly()	获取一个值，该值指示 ConfigurationElement 对象是否为只读。 (继承自 ConfigurationElement)
ListErrors(IList)	将此 ConfigurationElement 对象以及所有子元素中无效属性的错误添加到传递的列表中。 (继承自 ConfigurationElement)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
OnDeserializeUnrecognizedAttribute(String, String)	获取一个值，该值指示反序列化过程中是否遇到未知特性。 (继承自 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	获取一个值，该值指示反序列化过程中是否遇到未知元素。 (继承自 ConfigurationElement)
OnRequiredPropertyNotFound(String)	找不到所需属性时引发异常。 (继承自 ConfigurationElement)
PostDeserialize()	反序列化后调用。 (继承自 ConfigurationElement)
PreSerialize(XmlWriter)	在序列化之前调用。 (继承自 ConfigurationElement)
Reset(ConfigurationElement)	重置 ConfigurationElement 对象的内部状态，包括锁和属性集合。 (继承自 ConfigurationElement)
ResetModified()	在派生类中实现时，将 IsModified() 方法的值重置为 false。 (继承自 ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	当在派生类中实现后，将此配置元素的内容写入配置文件。 (继承自 ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)	当在派生类中实现后，将此配置元素的外部标记写入配置文件。 (继承自 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	将属性设置为指定值。 (继承自 ConfigurationElement)
SetReadOnly()	设置 ConfigurationElement 对象及所有子元素的 IsReadOnly() 属性。 (继承自 ConfigurationElement)
ToString()	返回表示当前对象的字符串。 (继承自 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	修改 ConfigurationElement 对象以移除所有不应该保存的值。 (继承自 ConfigurationElement)

另请参阅

• <cookieHandler>