JavaTM 2 Platform
Standard Ed. 6

java.net
介面 CookieStore


public interface CookieStore

表示 cookie 存儲區的 CookieStore 物件。可以存儲和獲取 cookie。

CookieManager 將調用 CookieStore.add 為每個傳入的 HTTP 回應保存 cookie,調用 CookieStore.get 為每個傳出的 HTTP 請求獲取 cookie。CookieStore 負責移除已過期的 HttpCookie 實例。

從以下版本開始:
1.6

方法摘要
 void add(URI uri, HttpCookie cookie)
          將一個 HTTP cookie 添加到存儲區中。
 List<HttpCookie> get(URI uri)
          獲取與給定 URI 關聯或其域與給定 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)
將一個 HTTP cookie 添加到存儲區中。為每個傳入的 HTTP 回應調用此方法。

要存儲的 cookie 可能關聯 URI,也可能不關聯 URI。如果它不關聯 URI,那麼 cookie 的域和路徑屬性將指示其出處。如果它關聯 URI,則不指定它的域和路徑屬性,給定 URI 將指示此 cookie 的出處。

如果對應於給定 URI 的 cookie 已經存在,則使用新的 cookie 替換它。

參數:
uri - 此 cookie 關聯的 uri。如果為 null,則此 cookie 不關聯 URI
cookie - 要存儲的 cookie
拋出:
NullPointerException - 如果 cookienull
另請參見:
get(java.net.URI)

get

List<HttpCookie> get(URI uri)
獲取與給定 URI 關聯或其域與給定 URI 比對的 cookie。只返回未過期的 cookie。為每個傳出的 HTTP 請求調用此方法。

返回:
HttpCookie 的不可變列表;如果沒有與給定 URI 比對的 cookie,則返回空列表
拋出:
NullPointerException - 如果 urinull
另請參見:
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 的不可變列表;如果此 cookie 存儲區中的 cookie 都不關聯 URI,則返回空列表

remove

boolean remove(URI uri,
               HttpCookie cookie)
從存儲區中移除 cookie。

參數:
uri - 此 cookie 關聯的 uri。如果為 null,則添加時要移除的 cookie 不關聯 URI;如果不為 null,則添加時要移除的 cookie 與給定的 URI 關聯。
cookie - 要移除的 cookie
返回:
如果此存儲區包含指定的 cookie,則返回 true
拋出:
NullPointerException - 如果 cookienull

removeAll

boolean removeAll()
移除此 cookie 存儲區中的所有 cookie。

返回:
如果此存儲區由於調用而更改,則返回 true

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only