Package io.vertx.rxjava3.core.http
Class Cookie
- java.lang.Object
-
- io.vertx.rxjava3.core.http.Cookie
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<Cookie>
__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Cookie
cookie(String name, String value)
Create a new cookieString
encode()
Encode the cookie to a string.boolean
equals(Object o)
Cookie
getDelegate()
String
getDomain()
long
getMaxAge()
String
getName()
String
getPath()
CookieSameSite
getSameSite()
String
getValue()
int
hashCode()
boolean
isHttpOnly()
boolean
isSecure()
static Cookie
newInstance(Cookie arg)
Cookie
setDomain(String domain)
Sets the domain of this cookieCookie
setHttpOnly(boolean httpOnly)
Determines if this cookie is HTTP only.Cookie
setMaxAge(long maxAge)
Sets the maximum age of this cookie in seconds.Cookie
setPath(String path)
Sets the path of this cookie.Cookie
setSameSite(CookieSameSite policy)
Sets the same site of this cookie.Cookie
setSecure(boolean secure)
Sets the security getStatus of this cookieCookie
setValue(String value)
Sets the value of this cookieString
toString()
-
-
-
Method Detail
-
getDelegate
public Cookie getDelegate()
-
cookie
public static Cookie cookie(String name, String value)
Create a new cookie- Parameters:
name
- the name of the cookievalue
- the cookie value- Returns:
- the cookie
-
getName
public String getName()
- Returns:
- the name of this cookie
-
getValue
public String getValue()
- Returns:
- the value of this cookie
-
setValue
public Cookie setValue(String value)
Sets the value of this cookie- Parameters:
value
- The value to set- Returns:
- a reference to this, so the API can be used fluently
-
setDomain
public Cookie setDomain(String domain)
Sets the domain of this cookie- Parameters:
domain
- The domain to use- Returns:
- a reference to this, so the API can be used fluently
-
getDomain
public String getDomain()
- Returns:
- the domain for the cookie
-
setPath
public Cookie setPath(String path)
Sets the path of this cookie.- Parameters:
path
- The path to use for this cookie- Returns:
- a reference to this, so the API can be used fluently
-
getPath
public String getPath()
- Returns:
- the path for this cookie
-
setMaxAge
public Cookie setMaxAge(long maxAge)
Sets the maximum age of this cookie in seconds. If an age of0
is specified, this cookie will be automatically removed by browser because it will expire immediately. IfLong
is specified, this cookie will be removed when the browser is closed. If you don't set this the cookie will be a session cookie and be removed when the browser is closed.- Parameters:
maxAge
- The maximum age of this cookie in seconds- Returns:
-
getMaxAge
public long getMaxAge()
- Returns:
- the maxAge of this cookie
-
setSecure
public Cookie setSecure(boolean secure)
Sets the security getStatus of this cookie- Parameters:
secure
- True if this cookie is to be secure, otherwise false- Returns:
- a reference to this, so the API can be used fluently
-
isSecure
public boolean isSecure()
- Returns:
- the security status of this cookie
-
setHttpOnly
public Cookie setHttpOnly(boolean httpOnly)
Determines if this cookie is HTTP only. If set to true, this cookie cannot be accessed by a client side script. However, this works only if the browser supports it. For for information, please look here.- Parameters:
httpOnly
- True if the cookie is HTTP only, otherwise false.- Returns:
-
isHttpOnly
public boolean isHttpOnly()
- Returns:
- the http only status of this cookie
-
setSameSite
public Cookie setSameSite(CookieSameSite policy)
Sets the same site of this cookie.- Parameters:
policy
- The policy should be one ofCookieSameSite
.- Returns:
- a reference to this, so the API can be used fluently
-
getSameSite
public CookieSameSite getSameSite()
- Returns:
- the SameSite policy of this cookie
-
encode
public String encode()
Encode the cookie to a string. This is what is used in the Set-Cookie header- Returns:
- the encoded cookie
-
-