鸿蒙OS CookieStore

CookieStore

public interface CookieStore

CookieStore 对象表示 cookie 的存储。 可以存储和检索cookies。

CookieManager 将调用 CookieStore.add 为每个传入的 HTTP 响应保存 cookie，并调用 CookieStore.get 为每个传出的 HTTP 请求检索 cookie。 CookieStore 负责删除已过期的 HttpCookie 实例。

方法总结

修饰符和类型	方法	描述
void	add(URI uri, HttpCookie cookie)	将一个 HTTP cookie 添加到存储中。
ListHttpCookie	get(URI uri)	检索与给定 URI 关联的 cookie，或者其域与给定 URI 匹配的 cookie。
ListHttpCookie	getCookies()	在 cookie 存储中获取所有未过期的 cookie。
ListURI	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 关联，则 cookie 的域和路径属性将指示它来自何处。 如果它与 URI 相关联并且未指定其域和路径属性，则给定的 URI 将指示此 cookie 的来源。

如果与给定 URI 对应的 cookie 已经存在，则将其替换为新的。

参数：

参数名称	参数描述
uri	与此 cookie 关联的 uri。 如果为 null，则此 cookie 不会与 URI 关联
cookie	要存储的 cookie

Throws:

Throw名称	Throw描述
NullPointerException	如果 cookie 为空

get

ListHttpCookie get(URI uri)

检索与给定 URI 关联的 cookie，或者其域与给定 URI 匹配的 cookie。 仅返回未过期的 cookie。 每个传出的 HTTP 请求都会调用它。

参数：

参数名称	参数描述
uri	与要返回的 cookie 关联的 uri

返回:

一个不可变的 HttpCookie 列表，如果没有 cookie 匹配给定的 URI，则返回空列表

Throws:

Throw名称	Throw描述
NullPointerException	如果 uri 为空

getCookies

ListHttpCookie getCookies()

在 cookie 存储中获取所有未过期的 cookie。

返回:

一个不可变的 http cookie 列表； 如果存储中没有 http cookie，则返回空列表

getURIs

ListURI 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

Throws:

Throw名称	Throw描述
NullPointerException	如果 cookie 为空

removeAll

boolean removeAll()

删除此 cookie 存储中的所有 cookie。

返回:

如果此存储因调用而更改，则为 true