java.net

インタフェース CookieStore

public interface CookieStore

CookieStore オブジェクトは、Cookie のストレージを表します。Cookie の格納と取得を行えます。

CookieManager は、HTTP 応答を受信するたびに CookieStore.add を呼び出して Cookie を保存し、HTTP 要求を送信するたびに CookieStore.get を呼び出して Cookie を取得します。CookieStore には、有効期限が切れた HttpCookie インスタンスを削除する責任があります。

導入されたバージョン:

1.6

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	add(URI uri, HttpCookie cookie) 1 つの HTTP Cookie をストアに追加します。
List<HttpCookie>	get(URI uri) 指定された URI に関連付けられた Cookie、指定された URI にドメインが一致する Cookie のいずれかを取得します。
List<HttpCookie>	getCookies() Cookie ストア内の有効期限の切れていないすべての Cookie を取得します。
List<URI>	getURIs() この Cookie ストア内の Cookie を識別するすべての URI を取得します。
boolean	remove(URI uri, HttpCookie cookie) ある Cookie をストアから削除します。
boolean	removeAll() この Cookie ストア内のすべての Cookie を削除します。

メソッドの詳細

add

void add(URI uri,
       HttpCookie cookie)

1 つの HTTP Cookie をストアに追加します。これは、HTTP 応答を受信するたびに呼び出されます。

格納する Cookie は、URI に関連付けても付けなくてもかまいません。Cookie が URI に関連付けられていない場合、Cookie のドメイン属性とパス属性がその発生場所を示します。Cookie が URI に関連付けられていて、そのドメイン属性とパス属性が指定されていない場合は、その指定された URI がこの Cookie の発生場所を示します。

指定された URI に対応する Cookie がすでに存在している場合、その Cookie は新しい Cookie で置き換えられます。

パラメータ:

uri - この Cookie が関連付けられる URI。この Cookie を URI に関連付けない場合は null

cookie - 格納する Cookie

例外:

NullPointerException - cookie が null の場合

関連項目:

get(java.net.URI)

get

List<HttpCookie> get(URI uri)

指定された URI に関連付けられた Cookie、指定された URI にドメインが一致する Cookie のいずれかを取得します。有効期限が切れていない Cookie のみが返されます。これは、HTTP 要求を送信するたびに呼び出されます。

戻り値:

HttpCookie の不変のリスト。指定された URI に一致する Cookie が存在しない場合は空のリストを返す

例外:

NullPointerException - uri が null の場合

関連項目:

add(java.net.URI, java.net.HttpCookie)

getCookies

List<HttpCookie> getCookies()

Cookie ストア内の有効期限の切れていないすべての Cookie を取得します。

戻り値:

HTTP Cookie の不変のリスト。ストア内に HTTP Cookie が存在しない場合は空のリストを返す

getURIs

List<URI> getURIs()

この Cookie ストア内の Cookie を識別するすべての URI を取得します。

戻り値:

URI の不変のリスト。URI に関連付けられた Cookie がこの Cookie ストア内に存在しない場合は、空のリストを返す

remove

boolean remove(URI uri,
             HttpCookie cookie)

ある Cookie をストアから削除します。

パラメータ:

uri - この Cookie が関連付けられている URI。null の場合、削除対象の Cookie は追加時に URI に関連付けられていません。null でない場合、削除対象の Cookie は追加時に、指定した URI に関連付けられています。

cookie - 削除する Cookie

戻り値:

指定された Cookie がこのストア内に格納されていた場合は true

例外:

NullPointerException - cookie が null の場合

removeAll

boolean removeAll()

この Cookie ストア内のすべての Cookie を削除します。

戻り値:

この呼び出しの結果、このストアが変更された場合は true