次の方法で共有

CookieHandler クラス

  • リファレンス

定義

名前空間:
System.IdentityModel.Services
アセンブリ:
System.IdentityModel.Services.dll

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

public ref class CookieHandler abstract
public abstract class CookieHandler
type CookieHandler = class
Public MustInherit Class CookieHandler
継承
Object
CookieHandler
派生

例

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

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

注釈

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

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

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

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

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

コンストラクター

CookieHandler()

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

プロパティ

Domain

Cookie に使用されるドメインを取得または設定します。
HideFromClientScript

Cookie をクライアント スクリプトから非表示にする必要があるかどうかを示す値を取得または設定します。
Name

ハンドラーによって書き込まれた Cookie の基本名を取得または設定します。
Path

ハンドラーによって書き込まれた Cookie の仮想パスを取得または設定します。
PersistentSessionLifetime

永続的なセッションの有効期間。 ゼロの場合、一時的なセッションは常に使用されます。
RequireSsl

Cookie を SSL でのみ使用するかどうかを指定する値を取得または設定します。

メソッド

Delete()

既定の名前、ドメイン、パスを持つ現在の要求に関連付けられている Cookie を削除します。
Delete(HttpContext)

既定の名前、ドメイン、パスを持つ現在の要求に関連付けられている Cookie を削除します。
Delete(String, HttpContext)

指定した名前と既定のドメインとパスを持つ、指定した要求に関連付けられている Cookie を削除します。
Delete(String, String, String, HttpContext)

指定した名前、パス、およびドメインを持つ、指定した要求に関連付けられている Cookie を削除します。
Delete(String)

指定した名前と既定のドメインとパスを持つ現在の要求に関連付けられている Cookie を削除します。
DeleteCore(String, String, String, HttpContext)

派生クラスでオーバーライドされると、指定した名前、ドメイン、およびパスを持つ、指定した要求に関連付けられている Cookie を削除します。
Equals(Object)

指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MatchCookiePath(Uri, Uri)

ターゲット ドメインが Cookie ドメイン内にあり、ターゲット パスが Cookie パス内にある場合は、Cookie パス部分の大文字と小文字が一致します。
MemberwiseClone()

現在の Objectの簡易コピーを作成します。

(継承元 Object)
Read()

既定の名前を持つ現在の要求に関連付けられている Cookie を読み取ります。
Read(HttpContext)

既定の名前、ドメイン、パスを持つ現在の要求に関連付けられている Cookie を読み取ります。
Read(String, HttpContext)

指定した名前と既定のドメインとパスを持つ、指定した要求に関連付けられている Cookie を読み取ります。
Read(String)

指定した名前を持つ現在の要求に関連付けられている Cookie を読み取ります。
ReadCore(String, HttpContext)

派生クラスでオーバーライドされると、指定した名前を持ち、指定した要求に関連付けられている Cookie を読み取ります。
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)
Write(Byte[], Boolean, DateTime)

指定した値、永続化、および有効期限を持つ、現在の要求に関連付けられている Cookie を書き込みます。
Write(Byte[], String, DateTime, HttpContext)

指定した名前、値、および有効期限を持つ、指定した要求に関連付けられた Cookie を書き込みます。
Write(Byte[], String, DateTime)

指定した名前、値、および有効期限を持つ、現在の要求に関連付けられている Cookie を書き込みます。
Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)

指定した名前、値、ドメイン、パス、有効期限、および可視性を持つ、指定された要求に関連付けられた Cookie を書き込みます。
WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)

派生クラスでオーバーライドされると、指定した名前、値、ドメイン、パス、有効期限、永続化、および可視性を持つ、指定された要求に関連付けられた Cookie を書き込みます。

適用対象

こちらもご覧ください