compact1、compact2、compact3

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要求を送信するたびに呼び出されます。

パラメータ:

uri - 返されるCookieに関連付けられたURI

戻り値:

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