CookieHandler クラス

定義

名前空間:

System.IdentityModel.Services

アセンブリ:

System.IdentityModel.Services.dll

HTTP クライアントでセッション クッキーを読み取り、書き込み、および削除するための抽象基本クラスを提供します。

public ref class CookieHandler abstract

public abstract class CookieHandler

type CookieHandler = class

Public MustInherit Class CookieHandler

継承

Object

CookieHandler

派生

System.IdentityModel.Services.ChunkedCookieHandler

例

次の例では、MyNamespace.MyCustomCookieHandler 型のカスタム Cookie ハンドラーを使用するように SAM を構成します。

<cookieHandler mode="Custom">  
    <customCookieHandler type="MyNamespace.MyCustomCookieHandler, MyAssembly" />  
</cookieHandler>  

注釈

(SAM) は SessionAuthenticationModule 、 クラスのインスタンスを CookieHandler 使用して、HTTP クライアント上の を含む SessionSecurityToken Cookie または Cookie を読み取り、書き込み、削除します。 セッション トークンを含む Cookie (セッション トークンが複数の Cookie に分割される場合は Cookie) は、セッション Cookie と呼ばれます。

Windows Identity Foundation (WIF) には、 クラスによって ChunkedCookieHandler 実装されるチャンク Cookie ハンドラーと呼ばれる Cookie ハンドラーが付属しています。 チャンク Cookie ハンドラーは、指定されたチャンク サイズに従って、セッション トークンを 1 つ以上の Cookie に分割します。 これは、多くのブラウザーによって課される個々の Cookie のサイズ制限を満たすためです。

から CookieHandler 派生して、独自の Cookie ハンドラーを作成できます。 これを行う場合は、セッション Cookie のDeleteCore削除、読み取り、書WriteCoreき込みの実際の作業を実行するために、、ReadCore、および メソッドをオーバーライドする必要があります。 これらのメソッドは通常、コレクションから HttpRequest.Cookies Cookie を読み取り、コレクションを通じて HttpResponse.Cookies Cookie を書き込むか削除します。 HttpContext要求と応答にアクセスできるオブジェクトは、これらの各メソッドのパラメーターとして提供されます。 必要なメソッドに加えて、 クラスによって CookieHandler 公開される他の仮想メソッド プロパティをオーバーライドして、ハンドラーの動作をカスタマイズすることもできます。

セッション Cookie の既定の動作とプロパティを CookieHandler 指定する クラスによって、いくつかのプロパティが公開されます。 、Domain、および Path の各プロパティはName、Cookie のベース名、有効なドメイン、およびクライアントに格納されるパスを指定します。 プロパティは HideFromClientScript 、Cookie にクライアント側スクリプトからアクセスできるかどうかを指定します。 プロパティは RequireSsl 、Cookie をセキュリティで保護された (HTTPS) 接続経由でのみ送信するかどうかを指定します。 設定した PersistentSessionLifetime 場合、 プロパティを使用して永続的なセッションの有効期限を設定します。これは、ブラウザーが閉じられた後も有効なセッションの有効期限を設定します。 これらのプロパティはすべて、通常、ハンドラーの "コア" メソッドによって基になる HttpCookie オブジェクト (またはオブジェクト) に設定される同等のプロパティを持ちます。 詳細については、各プロパティのドキュメントを参照してください。

SAM によって使用される Cookie ハンドラーは、cookieHandler> 要素を<使用して構成で指定できます。 この要素によって設定された Cookie ハンドラーは、イベントの FederatedAuthentication.FederationConfigurationCreated イベント デリゲートで変更することも、 プロパティを介して SessionAuthenticationModule.CookieHandler 直接設定またはアクセスすることもできます。

コンストラクター

CookieHandler()

CookieHandler クラスを初期化するために、派生クラスのコンストラクターから呼び出されます。

プロパティ

Domain	クッキーで使用するドメインを取得または設定します。
HideFromClientScript	クッキーをクライアント スクリプトから隠す必要があるかどうかを示す値を取得または設定します。
Name	ハンドラーが書き込むクッキーの基本名を取得または設定します。
Path	ハンドラーが書き込むクッキーの仮想パスを取得または設定します。
PersistentSessionLifetime	永続的なセッションの有効期間。 ゼロの場合は、一時的なセッションが常に使用されます。
RequireSsl	クッキーは SSL でのみ使用する必要があるかどうかを指定する値を取得または設定します。

メソッド

Delete()	既定の名前、ドメインおよびパスを持つ現在の要求に関連付けられたクッキーを削除します。
Delete(HttpContext)	既定の名前、ドメインおよびパスを持つ現在の要求に関連付けられたクッキーを削除します。
Delete(String)	指定した名前と既定のドメインおよびパスを持つ現在の要求に関連付けられたクッキーを削除します。
Delete(String, HttpContext)	指定した名前と既定のドメインおよびパスを持つ指定した要求に関連付けられたクッキーを削除します。
Delete(String, String, String, HttpContext)	指定した名前、パス、およびドメインを持つ指定した要求に関連付けられたクッキーを削除します。
DeleteCore(String, String, String, HttpContext)	派生クラスでオーバーライドされると、指定された名前、ドメイン、およびパスを含む指定された要求に関連付けられているクッキーを削除します。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MatchCookiePath(Uri, Uri)	ターゲット ドメインがクッキー ドメイン内にあり、ターゲット パスがクッキー パス内にある場合は、クッキー パス部分の大文字と小文字の区別を一致させます。
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
Read()	既定の名前が含まれる現在の要求に関連付けられているクッキーを読み込みます。
Read(HttpContext)	既定の名前、ドメインおよびパスが含まれる現在の要求に関連付けられているクッキーを読み込みます。
Read(String)	指定された名前を含む現在の要求に関連付けられているクッキーを読み込みます。
Read(String, HttpContext)	指定された名前、ドメインおよびパスを含む指定された要求に関連付けられているクッキーを読み込みます。
ReadCore(String, HttpContext)	派生クラスでオーバーライドされると、指定された名前を持ち、指定された要求に関連付けられているクッキーを読み取ります。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
Write(Byte[], Boolean, DateTime)	指定された値、永続化、および有効期限を含む現在の要求に関連付けられているクッキーを書き込みます。
Write(Byte[], String, DateTime)	指定された名前、値、および有効期限を含む現在の要求に関連付けられているクッキーを書き込みます。
Write(Byte[], String, DateTime, HttpContext)	指定された名前、値、および有効期限を含む指定された要求に関連付けられているクッキーを書き込みます。
Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)	指定された名前、値、ドメイン、パス、有効期限、および可視性を含む指定された要求に関連付けられているクッキーを書き込みます。
WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)	派生クラスでオーバーライドされると、指定された名前、値、ドメイン、パス、有効期限、永続性、および可視性を含む指定された要求に関連付けられているクッキーを書き込みます。

こちらもご覧ください

• ChunkedCookieHandler
• <cookieHandler>