org.dromara.hutool.http.client.engine.okhttp

Class OkCookie

java.lang.Object

org.dromara.hutool.core.lang.wrapper.SimpleWrapper<okhttp3.Cookie>

org.dromara.hutool.http.client.engine.okhttp.OkCookie

All Implemented Interfaces:

Wrapper<okhttp3.Cookie>, CookieSpi

public class OkCookie
extends SimpleWrapper<okhttp3.Cookie>
implements CookieSpi

OkHttp Cookie实现

Since:

6.0.0

Author:

looly

Field Summary

Fields inherited from class org.dromara.hutool.core.lang.wrapper.SimpleWrapper

raw

Constructor Summary

Constructors

Constructor and Description
OkCookie(okhttp3.Cookie raw) 构造

Method Summary

Modifier and Type	Method and Description
String	getAttribute(String name) 自定义属性，用于扩展
String	getDomain() 限制 Cookie 主机作用域，一般包含子域名 Cookie 作用域，默认为空，表示所有域名下生效
String	getName() 获取Cookie名称
String	getPath() 限制 Cookie URL路径作用域，该 URL 路径必须存在于请求的 URL 中，子路径也会匹配 Cookie 作用域，默认为空，表示所有路径下生效
String	getValue() 获取Cookie值
boolean	isExpired(Instant now) Cookie是否过期
boolean	isHostOnly() 限制 Cookie 主机作用域，一般包含子域名 Cookie 作用域，默认为空，表示所有域名下生效
boolean	isHttpOnly() 限制 Cookie 的作用域 标记为 HttpOnly 的 Cookie 只能在 HTTP 协议中访问，不能通过脚本语言（如 JavaScript）访问
boolean	isPersistent() 是否持久化，即Cookie是否在Session关闭前一直有效
boolean	isSecure() 限制访问 Cookie 标记为 Secure 的 Cookie 只应通过被 HTTPS 协议加密过的请求发送给服务端
String	toString()

Methods inherited from class org.dromara.hutool.core.lang.wrapper.SimpleWrapper

getRaw

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dromara.hutool.http.client.cookie.CookieSpi

isExpired

Constructor Detail

OkCookie

public OkCookie(okhttp3.Cookie raw)

构造

Parameters:

raw - 原始对象

Method Detail

getName

public String getName()

Description copied from interface: CookieSpi

获取Cookie名称

Specified by:

getName in interface CookieSpi

Returns:

Cookie名称

getValue

public String getValue()

Description copied from interface: CookieSpi

获取Cookie值

Specified by:

getValue in interface CookieSpi

Returns:

Cookie值

isSecure

public boolean isSecure()

Description copied from interface: CookieSpi

限制访问 Cookie
标记为 Secure 的 Cookie 只应通过被 HTTPS 协议加密过的请求发送给服务端

Specified by:

isSecure in interface CookieSpi

Returns:

是否限制访问 Cookie

isHttpOnly

public boolean isHttpOnly()

Description copied from interface: CookieSpi

限制 Cookie 的作用域
标记为 HttpOnly 的 Cookie 只能在 HTTP 协议中访问，不能通过脚本语言（如 JavaScript）访问

Specified by:

isHttpOnly in interface CookieSpi

Returns:

是否限制 Cookie 的作用域

isHostOnly

public boolean isHostOnly()

Description copied from interface: CookieSpi

限制 Cookie 主机作用域，一般包含子域名
Cookie 作用域，默认为空，表示所有域名下生效

Specified by:

isHostOnly in interface CookieSpi

Returns:

Cookie 作用域

getDomain

public String getDomain()

Description copied from interface: CookieSpi

限制 Cookie 主机作用域，一般包含子域名
Cookie 作用域，默认为空，表示所有域名下生效

Specified by:

getDomain in interface CookieSpi

Returns:

Cookie 作用域

getPath

public String getPath()

Description copied from interface: CookieSpi

限制 Cookie URL路径作用域，该 URL 路径必须存在于请求的 URL 中，子路径也会匹配
Cookie 作用域，默认为空，表示所有路径下生效

Specified by:

getPath in interface CookieSpi

Returns:

Cookie 作用域

isExpired

public boolean isExpired(Instant now)

Description copied from interface: CookieSpi

Cookie是否过期

Specified by:

isExpired in interface CookieSpi

Parameters:

now - 当前时间，用于判断是否过期

Returns:

是否过期

getAttribute

public String getAttribute(String name)

Description copied from interface: CookieSpi

自定义属性，用于扩展

Specified by:

getAttribute in interface CookieSpi

Parameters:

name - 属性名

Returns:

属性值

isPersistent

public boolean isPersistent()

Description copied from interface: CookieSpi

是否持久化，即Cookie是否在Session关闭前一直有效

Specified by:

isPersistent in interface CookieSpi

Returns:

是否持久化

toString

public String toString()

Overrides:

toString in class Object