HttpCookie

在漢源等地區(qū)，都構建了全面的區(qū)域性戰(zhàn)略布局，加強發(fā)展的系統(tǒng)性、市場前瞻性、產品創(chuàng)新能力，以專注、極致的服務理念，為客戶提供做網站、成都網站制作 網站設計制作定制網站開發(fā),公司網站建設,企業(yè)網站建設,成都品牌網站建設,全網整合營銷推廣,成都外貿網站制作,漢源網站建設費用合理。

java.lang.Object

|---java.net.HttpCookie

public final class HttpCookie
extends Object
implements Cloneable

一個 HttpCookie 對象代表一個 HTTP cookie，它攜帶服務器和用戶代理之間的狀態(tài)信息。 Cookie 被廣泛用于創(chuàng)建有狀態(tài)會話。

有 3 個 HTTP cookie 規(guī)范：

網景 RFC 2109 草案 - http://www.ietf.org/rfc/rfc2109.txt RFC 2965 -http://www.ietf.org/rfc/rfc2965.txt

HttpCookie 類可以接受所有這 3 種語法形式。

構造函數摘要

構造函數	描述
HttpCookie(String name, String value)	構造一個具有指定名稱和值的 cookie。

方法總結

修飾符和類型	方法	描述
Object	clone()	創(chuàng)建并返回此對象的副本。
static boolean	domainMatches(String domain, String host)	檢查主機名是否在域中的實用方法。
boolean	equals(Object obj)	測試兩個 HTTP cookie 的相等性。
String	getComment()	返回描述此 cookie 用途的注釋，如果 cookie 沒有注釋，則返回 null。
String	getCommentURL()	返回描述此 cookie 用途的評論 URL，如果 cookie 沒有評論 URL，則返回 null。
boolean	getDiscard()	返回 cookie 的丟棄屬性
String	getDomain()	返回為此 cookie 設置的域名。
long	getMaxAge()	返回 cookie 的最長期限，以秒為單位。
String	getName()	返回 cookie 的名稱。
String	getPath()	返回瀏覽器將此 cookie 返回到的服務器上的路徑。
String	getPortlist()	返回 cookie 的端口列表屬性
boolean	getSecure()	如果發(fā)送此 cookie 應限制為安全協議，則返回 true；如果可以使用任何協議發(fā)送，則返回 false。
String	getValue()	返回 cookie 的值。
int	getVersion()	返回此 cookie 遵守的協議版本。
boolean	hasExpired()	報告此 HTTP cookie 是否已過期。
int	hashCode()	返回此 HTTP cookie 的哈希碼。
boolean	isHttpOnly()	如果此 cookie 包含 HttpOnly 屬性，則返回 true。
static ListHttpCookie	parse(String header)	從 set-cookie 或 set-cookie2 標頭字符串構造 cookie。
void	setComment(String purpose)	指定描述 cookie 用途的注釋。
void	setCommentURL(String purpose)	指定描述 cookie 用途的評論 URL。
void	setDiscard(boolean discard)	指定用戶代理是否應無條件丟棄 cookie。
void	setDomain(String pattern)	指定應在其中顯示此 cookie 的域。
void	setHttpOnly(boolean httpOnly)	指示是否應將 cookie 視為僅 HTTP。
void	setMaxAge(long expiry)	以秒為單位設置 cookie 的最長期限。
void	setPath(String uri)	指定客戶端應將 cookie 返回到的 cookie 路徑。
void	setPortlist(String ports)	指定 cookie 的端口列表，它限制 cookie 可以在 Cookie 標頭中發(fā)送回的端口。
void	setSecure(boolean flag)	指示是否應僅使用安全協議（例如 HTTPS 或 SSL）發(fā)送 cookie。
void	setValue(String newValue)	創(chuàng)建 cookie 后為 cookie 分配一個新值。
void	setVersion(int v)	設置此 cookie 遵守的 cookie 協議的版本。
String	toString()	構造此 cookie 的 cookie 標頭字符串表示，其格式由相應的 cookie 規(guī)范定義，但沒有前導“Cookie:”標記。

從類 java.lang.Object 繼承的方法
finalize, getClass, notify, notifyAll, wait, wait, wait

構造函數詳細信息

HttpCookie

public HttpCookie(String name, String value)

構造一個具有指定名稱和值的 cookie。

該名稱必須符合 RFC 2965。這意味著它只能包含 ASCII 字母數字字符，并且不能包含逗號、分號或空格或以 $ 字符開頭。 創(chuàng)建后無法更改 cookie 的名稱。

該值可以是服務器選擇發(fā)送的任何值。 它的值可能只對服務器感興趣。 cookie 的值可以在創(chuàng)建后使用 setValue 方法進行更改。

默認情況下，cookie 是根據 RFC 2965 cookie 規(guī)范創(chuàng)建的。 可以使用 setVersion 方法更改版本。

參數：

參數名稱	參數描述
name	一個字符串，指定 cookie 的名稱
value	一個字符串，指定 cookie 的值

Throws:

Throw名稱	Throw描述
IllegalArgumentException	如果 cookie 名稱包含非法字符
NullPointerException	如果名稱為空

方法詳情

parse

public static ListHttpCookie parse(String header)

從 set-cookie 或 set-cookie2 標頭字符串構造 cookie。 RFC 2965 第 3.2.2 節(jié) set-cookie2 語法表示一個標題行可能包含多個 cookie 定義，因此這是一種靜態(tài)實用程序方法，而不是另一個構造函數。

參數：

參數名稱	參數描述
header	指定 set-cookie 標頭的字符串。 標頭應以“set-cookie”或“set-cookie2”標記開頭； 或者它根本不應該有前導標記。

返回:

從標題行字符串解析的 cookie 列表

Throws:

Throw名稱	Throw描述
IllegalArgumentException	如果標頭字符串違反 cookie 規(guī)范的語法或 cookie 名稱包含非法字符。
NullPointerException	如果標題字符串為空

hasExpired

public boolean hasExpired()

報告此 HTTP cookie 是否已過期。

返回:

true 表示此 HTTP cookie 已過期； 否則為false

setComment

public void setComment(String purpose)

指定描述 cookie 用途的注釋。 如果瀏覽器將 cookie 呈現給用戶，則該注釋很有用。 Netscape 版本 0 cookie 不支持注釋。

參數：

參數名稱	參數描述
purpose	一個字符串，指定要向用戶顯示的評論

getComment

public String getComment()

返回描述此 cookie 用途的注釋，如果 cookie 沒有注釋，則返回 null。

返回:

包含評論的字符串，如果沒有，則返回 null

setCommentURL

public void setCommentURL(String purpose)

指定描述 cookie 用途的評論 URL。 如果瀏覽器將 cookie 呈現給用戶，則評論 URL 很有用。 評論 URL 僅為 RFC 2965。

參數：

參數名稱	參數描述
purpose	一個字符串，指定要向用戶顯示的評論 URL

getCommentURL

public String getCommentURL()

返回描述此 cookie 用途的評論 URL，如果 cookie 沒有評論 URL，則返回 null。

返回:

包含評論 URL 的字符串，如果沒有則返回 null

setDiscard

public void setDiscard(boolean discard)

指定用戶代理是否應無條件丟棄 cookie。 這是 RFC 2965 唯一的屬性。

參數：

參數名稱	參數描述
discard	true 表示無條件丟棄cookie

getDiscard

public boolean getDiscard()

返回 cookie 的丟棄屬性

返回:

表示此 cookie 的丟棄屬性的布爾值

setPortlist

public void setPortlist(String ports)

指定 cookie 的端口列表，它限制 cookie 可以在 Cookie 標頭中發(fā)送回的端口。

參數：

參數名稱	參數描述
ports	一個字符串指定端口列表，它是逗號分隔的一系列數字

getPortlist

public String getPortlist()

返回 cookie 的端口列表屬性

返回:

字符串包含端口列表，如果沒有則為 null

setDomain

public void setDomain(String pattern)

指定應在其中顯示此 cookie 的域。

域名的格式由 RFC 2965 指定。域名以點 (.foo.com) 開頭，表示 cookie 對指定域名系統(tǒng) (DNS) 區(qū)域中的服務器可見（例如，www. foo.com，但不是 a.b.foo.com）。 默認情況下，cookie 僅返回給發(fā)送它們的服務器。

參數：

參數名稱	參數描述
pattern	一個字符串，其中包含此 cookie 可見的域名； 表格符合 RFC 2965

getDomain

public String getDomain()

返回為此 cookie 設置的域名。 域名的格式由 RFC 2965 設置。

返回:

包含域名的字符串

setMaxAge

public void setMaxAge(long expiry)

以秒為單位設置 cookie 的最長期限。

正值表示 cookie 將在經過這么多秒后過期。 請注意，該值是 cookie 過期的最大期限，而不是 cookie 的當前期限。

負值表示 cookie 不會永久存儲，并且會在 Web 瀏覽器退出時被刪除。 零值會導致 cookie 被刪除。

參數：

參數名稱	參數描述
expiry	一個整數，以秒為單位指定 cookie 的最大年齡； 如果為零，則應立即丟棄 cookie； 否則，未指定 cookie 的最大年齡。

getMaxAge

public long getMaxAge()

返回 cookie 的最長期限，以秒為單位。 默認情況下，-1 表示 cookie 將持續(xù)存在，直到瀏覽器關閉。

返回:

一個整數，以秒為單位指定 cookie 的最大年齡

setPath

public void setPath(String uri)

指定客戶端應將 cookie 返回到的 cookie 路徑。

該 cookie 對您指定的目錄中的所有頁面以及該目錄的子目錄中的所有頁面都是可見的。 cookie 的路徑必須包含設置 cookie 的 servlet，例如 /catalog，它使 cookie 對服務器上 /catalog 下的所有目錄可見。

參數：

參數名稱	參數描述
uri	指定路徑的字符串

getPath

public String getPath()

返回瀏覽器將此 cookie 返回到的服務器上的路徑。 cookie 對服務器上的所有子路徑可見。

返回:

一個字符串，指定包含 servlet 名稱的路徑，例如 /catalog

setSecure

public void setSecure(boolean flag)

指示是否應僅使用安全協議（例如 HTTPS 或 SSL）發(fā)送 cookie。

默認值為假。

參數：

參數名稱	參數描述
flag	如果為 true，則 cookie 只能通過 HTTPS 等安全協議發(fā)送。 如果為 false，則可以通過任何協議發(fā)送。

getSecure

public boolean getSecure()

如果發(fā)送此 cookie 應限制為安全協議，則返回 true；如果可以使用任何協議發(fā)送，則返回 false。

返回：

如果 cookie 可以通過任何標準協議發(fā)送，則為 false； 否則為true

getName

public String getName()

返回 cookie 的名稱。 創(chuàng)建后無法更改名稱。

返回:

指定 cookie 名稱的字符串

setValue

public void setValue(String newValue)

創(chuàng)建 cookie 后為 cookie 分配一個新值。 如果您使用二進制值，您可能需要使用 BASE64 編碼。

對于版本 0 cookie，值不應包含空格、方括號、圓括號、等號、逗號、雙引號、斜杠、問號、at 符號、冒號和分號。 空值在所有瀏覽器上的行為方式可能不同。

參數：

參數名稱	參數描述
newValue	指定新值的字符串

getValue

public String getValue()

返回 cookie 的值。

返回:

包含 cookie 的當前值的字符串

getVersion

public int getVersion()

返回此 cookie 遵守的協議版本。 版本 1 符合 RFC 2965/2109，版本 0 符合 Netscape 起草的原始 cookie 規(guī)范。 瀏覽器提供的 cookie 使用并識別瀏覽器的 cookie 版本。

返回:

如果 cookie 符合原始 Netscape 規(guī)范，則為 0； 1 如果 cookie 符合 RFC 2965/2109

setVersion

public void setVersion(int v)

設置此 cookie 遵守的 cookie 協議的版本。 版本 0 符合最初的 Netscape cookie 規(guī)范。 版本 1 符合 RFC 2965/2109。

參數：

參數名稱	參數描述
v	0 如果 cookie 應該符合原始的 Netscape 規(guī)范； 1 如果 cookie 應符合 RFC 2965/2109

Throws:

Throw名稱	Throw描述
IllegalArgumentException	如果 v 既不是 0 也不是 1

isHttpOnly

public boolean isHttpOnly()

如果此 cookie 包含 HttpOnly 屬性，則返回 true。 這意味著腳本引擎（如 javascript）不應訪問 cookie。

返回:

如果此 cookie 應被視為 HTTPOnly，則為 true

setHttpOnly

public void setHttpOnly(boolean httpOnly)

指示是否應將 cookie 視為僅 HTTP。 如果設置為 true，則意味著 cookie 不應被 javascript 等腳本引擎訪問。

參數：

參數名稱	參數描述
httpOnly	如果為 true，則使 cookie 僅 HTTP，即僅作為 HTTP 請求的一部分可見。

domainMatches

public static boolean domainMatches(String domain, String host)

檢查主機名是否在域中的實用方法。

這個概念在 cookie 規(guī)范中有所描述。 要理解這個概念，首先需要定義一些術語：

如果主機名包含點，則有效主機名 = 主機名；如果不包含點，則 = hostname.local

主機 A 的名稱域與主機 B 的匹配，如果：

• 他們的主機名字符串字符串比較相等； 或者
• A 是 HDN 字符串，格式為 NB，其中 N 是非空名稱字符串，B 的格式為 .B'，B' 是 HDN 字符串。 （因此，x.y.com 域匹配 .Y.com 但不匹配 Y.com。）

如果出現以下情況，主機不在域中（RFC 2965 sec. 3.3.2）：

• Domain 屬性的值不包含嵌入的點，并且該值不是 .local。
• 從請求主機派生的有效主機名與域屬性不匹配。
• 請求主機是 HDN（不是 IP 地址），格式為 HD，其中 D 是域屬性的值，H 是包含一個或多個點的字符串。

例子:

• 來自請求主機 y.x.foo.com 的 Domain=.foo.com 的 Set-Cookie2 將被拒絕，因為 H 是 y.x 并且包含一個點。
• 來自請求主機 x.foo.com 的 Set-Cookie2 用于 Domain=.foo.com 將被接受。
• 帶有 Domain=.com 或 Domain=.com. 的 Set-Cookie2 將始終被拒絕，因為沒有嵌入的點。
• 將接受來自 Domain=.local 的請求主機示例的 Set-Cookie2，因為請求主機的有效主機名是 example.local，并且 example.local 域匹配 .local。

參數:

參數名稱	參數描述
domain	用于檢查主機名的域名
host	有問題的主機名

返回:

如果它們域匹配，則為 true； 如果不是，則為false

toString

public String toString()

構造此 cookie 的 cookie 標頭字符串表示，其格式由相應的 cookie 規(guī)范定義，但沒有前導“Cookie:”標記。

覆蓋：

類 Object 中的 toString

返回:

cookie 的字符串形式。 字符串具有定義的格式

equals

public boolean equals(Object obj)

測試兩個 HTTP cookie 的相等性。

僅當兩個 cookie 來自同一個域（不區(qū)分大小寫）、具有相同名稱（不區(qū)分大小寫）和具有相同路徑（區(qū)分大小寫）時，結果才為真。

覆蓋：

類 Object 中的等于

參數：

參數名稱	參數描述
obj	要與之比較的參考對象。

返回:

如果兩個 HTTP cookie 相等，則為 true； 否則為假

hashCode

public int hashCode()

返回此 HTTP cookie 的哈希碼。 結果是此 cookie 的三個重要組成部分的哈希碼值的總和：名稱、域和路徑。 也就是說，哈希碼是表達式的值：

getName().toLowerCase().hashCode() + getDomain().toLowerCase().hashCode() + getPath().hashCode()

覆蓋：

類 Object 中的 hashCode

返回:

這個 HTTP cookie 的哈希碼

clone

public Object clone()

創(chuàng)建并返回此對象的副本。

覆蓋：

在類 Object 中克隆

返回:

此 HTTP cookie 的克隆

網頁名稱：創(chuàng)新互聯鴻蒙OS教程：鴻蒙OSHttpCookie
文章分享：http://uogjgqi.cn/article/cccjcoc.html