java.net

クラス CookieHandler

java.lang.Object

java.net.CookieHandler

直系の既知のサブクラス:

CookieManager

public abstract class CookieHandler
extends Object

CookieHandler オブジェクトは、HTTP プロトコルハンドラに HTTP 状態管理ポリシー実装を組み込むためのコールバックメカニズムを提供します。HTTP 状態管理メカニズムは、HTTP の要求と応答を使ってステートフルセッションを作成する方法を指定します。

HTTP プロトコルハンドラが使用すべきシステム全体の CookieHandler を登録するには、CookieHandler.setDefault(CookieHandler) を実行します。現在登録されている CookieHandler を取得するには、CookieHandler.getDefault() を呼び出します。 HTTP 状態管理の詳細については、RFC 2965: HTTP State Management Mechanism を参照してください。

導入されたバージョン:

1.5

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
CookieHandler()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract Map<String,List<String>>	get(URI uri, Map<String,List<String>> requestHeaders) 要求ヘッダー内に指定された URI の Cookie キャッシュから適用可能なすべての Cookie を取得します。
static CookieHandler	getDefault() システム全体の Cookie ハンドラを取得します。
abstract void	put(URI uri, Map<String,List<String>> responseHeaders) 応答ヘッダー内に存在する Set-Cookie2 という名前の応答ヘッダーフィールドなど、適用可能なすべての Cookie を Cookie キャッシュ内に設定します。
static void	setDefault(CookieHandler cHandler) システム全体の Cookie ハンドラを設定 (または設定解除) します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

CookieHandler

public CookieHandler()

メソッドの詳細

getDefault

public static CookieHandler getDefault()

システム全体の Cookie ハンドラを取得します。

戻り値:

システム全体の Cookie ハンドラ。null が返された場合、それは、システム全体の Cookie ハンドラが現在設定されていないことを意味する。

例外:

SecurityException - セキュリティーマネージャーがインストールされていて、それが NetPermission(「getCookieHandler」) を拒否した場合

関連項目:

setDefault(CookieHandler)

setDefault

public static void setDefault(CookieHandler cHandler)

システム全体の Cookie ハンドラを設定 (または設定解除) します。 注: 標準でない HTTP プロトコルハンドラは、この設定を無視する可能性があります。

パラメータ:

cHandler - HTTP Cookie ハンドラ。設定解除する場合は null。

例外:

SecurityException - セキュリティーマネージャーがインストールされていて、それが NetPermission(「setCookieHandler」) を拒否した場合

関連項目:

getDefault()

get

public abstract Map<String,List<String>> get(URI uri,
                           Map<String,List<String>> requestHeaders)
                                      throws IOException

要求ヘッダー内に指定された URI の Cookie キャッシュから適用可能なすべての Cookie を取得します。

引数として渡される URI は、Cookie の使用目的を指定します。たとえば、スキームには Cookie が http または https のどちらで送信されるのかや、Javascript などの別のコンテキストで使用されるのかを反映するべきです。ホスト部分には Cookie の転送先または Javascript の場合はそれらのオリジンを反映するべきです。

どれを返すかを決定する際に、URI および Cookie の属性とセキュリティ設定を考慮することは、実装に任されています。

HTTP プロトコルの実装者は、Cookie の選択に関係するすべての要求ヘッダーが追加されてから要求が送信されるまでの間に、必ずこのメソッドが呼び出されるようにしてください。

パラメータ:

uri - Cookie の使用目的を表す URI

requestHeaders - 現在の要求ヘッダーを表す、要求ヘッダーフィールド名からフィールド値のリストへのマップ

戻り値:

フィールド名「Cookie」または「Cookie2」を持つ状態管理ヘッダーから状態情報が格納された Cookie のリストへの不変のマップ

例外:

IOException - 入出力エラーが発生した場合

IllegalArgumentException - どちらかの引数が null の場合

関連項目:

put(URI, Map)

put

public abstract void put(URI uri,
       Map<String,List<String>> responseHeaders)
                  throws IOException

応答ヘッダー内に存在する Set-Cookie2 という名前の応答ヘッダーフィールドなど、適用可能なすべての Cookie を Cookie キャッシュ内に設定します。

パラメータ:

uri - Cookie の生成元の URI

responseHeaders - 返された応答ヘッダーフィールドを表す、フィールド名からフィールド値のリストへの不変のマップ

例外:

IOException - 入出力エラーが発生した場合

IllegalArgumentException - どちらかの引数が null の場合

関連項目:

get(URI, Map)