Vert.x 4.5.13 · io.vertx.core.http.impl.CookieImpl · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private boolean	changed
private final boolean	fromUserAgent
private final Cookie	nettyCookie
private CookieSameSite	sameSite

Access	Constructor and Description
public	CookieImpl(String name, String value)
pack-priv	CookieImpl(Cookie the underlying cookie object nettyCookie) Internal constructor, only used by the CookieJar.

Method Summary

Modifier and Type	Method and Description
public String	encode() Implements io.vertx.core.http.Cookie.encode. Encode the cookie to a string.
public String	getDomain() Implements io.vertx.core.http.Cookie.getDomain.
public long	getMaxAge() Implements io.vertx.core.http.Cookie.getMaxAge.
public String	getName() Implements io.vertx.core.http.Cookie.getName.
public String	getPath() Implements io.vertx.core.http.Cookie.getPath.
public CookieSameSite	getSameSite() Implements io.vertx.core.http.Cookie.getSameSite.
public String	getValue() Implements io.vertx.core.http.Cookie.getValue.
public boolean	isChanged() Implements io.vertx.core.http.impl.ServerCookie.isChanged. Has the cookie been changed?
public boolean	isFromUserAgent() Implements io.vertx.core.http.impl.ServerCookie.isFromUserAgent. Has this Cookie been sent from the User Agent (the browser)?
public boolean	isHttpOnly() Implements io.vertx.core.http.Cookie.isHttpOnly.
public boolean	isSecure() Implements io.vertx.core.http.Cookie.isSecure.
public void	setChanged(boolean true if changed changed) Implements io.vertx.core.http.impl.ServerCookie.setChanged. Set the cookie as being changed.
public Cookie	setDomain(final String domain)
public Cookie	setHttpOnly(final boolean True if the cookie is HTTP only, otherwise false. httpOnly) Implements io.vertx.core.http.Cookie.setHttpOnly. Determines if this cookie is HTTP only.
public Cookie	setMaxAge(final long The maximum age of this cookie in seconds maxAge) Implements io.vertx.core.http.Cookie.setMaxAge. Sets the maximum age of this cookie in seconds.
public Cookie	setPath(final String path)
public Cookie	setSameSite(final CookieSameSite The policy should be one of `CookieSameSite`. sameSite) Implements io.vertx.core.http.Cookie.setSameSite. Sets the same site of this cookie.
public Cookie	setSecure(final boolean True if this cookie is to be secure, otherwise false secure) Implements io.vertx.core.http.Cookie.setSecure. Sets the security getStatus of this cookie
public Cookie	setValue(final String The value to set value) Implements io.vertx.core.http.Cookie.setValue. Sets the value of this cookie

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

changed	back to summary
private boolean changed

fromUserAgent	back to summary
private final boolean fromUserAgent

sameSite	back to summary
private CookieSameSite sameSite

Method Detail

encode	back to summary
public String encode() Implements io.vertx.core.http.Cookie.encode. Doc from io.vertx.core.http.Cookie.encode. Encode the cookie to a string. This is what is used in the Set-Cookie header Returns:String the encoded cookie Annotations @Override

encode

back to summary

public String encode()

Implements io.vertx.core.http.Cookie.encode.

Doc from io.vertx.core.http.Cookie.encode.

Encode the cookie to a string. This is what is used in the Set-Cookie header

Returns:String

the encoded cookie

Annotations

@Override

getDomain	back to summary
public String getDomain() Implements io.vertx.core.http.Cookie.getDomain. Returns:String Doc from io.vertx.core.http.Cookie.getDomain. the domain for the cookie Annotations @Override

getDomain

back to summary

public String getDomain()

Implements io.vertx.core.http.Cookie.getDomain.

Returns:String

Doc from io.vertx.core.http.Cookie.getDomain.

the domain for the cookie

Annotations

@Override

getMaxAge	back to summary
public long getMaxAge() Implements io.vertx.core.http.Cookie.getMaxAge. Returns:long Doc from io.vertx.core.http.Cookie.getMaxAge. the maxAge of this cookie Annotations @Override

getMaxAge

back to summary

public long getMaxAge()

Implements io.vertx.core.http.Cookie.getMaxAge.

Returns:long

Doc from io.vertx.core.http.Cookie.getMaxAge.

the maxAge of this cookie

Annotations

@Override

getName	back to summary
public String getName() Implements io.vertx.core.http.Cookie.getName. Returns:String Doc from io.vertx.core.http.Cookie.getName. the name of this cookie Annotations @Override

getName

back to summary

public String getName()

Implements io.vertx.core.http.Cookie.getName.

Returns:String

Doc from io.vertx.core.http.Cookie.getName.

the name of this cookie

Annotations

@Override

getPath	back to summary
public String getPath() Implements io.vertx.core.http.Cookie.getPath. Returns:String Doc from io.vertx.core.http.Cookie.getPath. the path for this cookie Annotations @Override

getPath

back to summary

public String getPath()

Implements io.vertx.core.http.Cookie.getPath.

Returns:String

Doc from io.vertx.core.http.Cookie.getPath.

the path for this cookie

Annotations

@Override

getSameSite	back to summary
public CookieSameSite getSameSite() Implements io.vertx.core.http.Cookie.getSameSite. Returns:CookieSameSite Doc from io.vertx.core.http.Cookie.getSameSite. the SameSite policy of this cookie Annotations @Override

getSameSite

back to summary

public CookieSameSite getSameSite()

Implements io.vertx.core.http.Cookie.getSameSite.

Returns:CookieSameSite

Doc from io.vertx.core.http.Cookie.getSameSite.

the SameSite policy of this cookie

Annotations

@Override

getValue	back to summary
public String getValue() Implements io.vertx.core.http.Cookie.getValue. Returns:String Doc from io.vertx.core.http.Cookie.getValue. the value of this cookie Annotations @Override

getValue

back to summary

public String getValue()

Implements io.vertx.core.http.Cookie.getValue.

Returns:String

Doc from io.vertx.core.http.Cookie.getValue.

the value of this cookie

Annotations

@Override

isChanged	back to summary
public boolean isChanged() Implements io.vertx.core.http.impl.ServerCookie.isChanged. Doc from io.vertx.core.http.impl.ServerCookie.isChanged. Has the cookie been changed? Changed cookie jar will be saved out in the response and sent to the browser. Returns:boolean true if changed

isChanged

back to summary

public boolean isChanged()

Implements io.vertx.core.http.impl.ServerCookie.isChanged.

Doc from io.vertx.core.http.impl.ServerCookie.isChanged.

Has the cookie been changed? Changed cookie jar will be saved out in the response and sent to the browser.

Returns:boolean: true if changed

isFromUserAgent	back to summary
public boolean isFromUserAgent() Implements io.vertx.core.http.impl.ServerCookie.isFromUserAgent. Doc from io.vertx.core.http.impl.ServerCookie.isFromUserAgent. Has this Cookie been sent from the User Agent (the browser)? or was created during the executing on the request. Returns:boolean true if the cookie comes from the User Agent.

isFromUserAgent

back to summary

public boolean isFromUserAgent()

Implements io.vertx.core.http.impl.ServerCookie.isFromUserAgent.

Doc from io.vertx.core.http.impl.ServerCookie.isFromUserAgent.

Has this Cookie been sent from the User Agent (the browser)? or was created during the executing on the request.

Returns:boolean: true if the cookie comes from the User Agent.

isHttpOnly	back to summary
public boolean isHttpOnly() Implements io.vertx.core.http.Cookie.isHttpOnly. Returns:boolean Doc from io.vertx.core.http.Cookie.isHttpOnly. the http only status of this cookie Annotations @Override

isHttpOnly

back to summary

public boolean isHttpOnly()

Implements io.vertx.core.http.Cookie.isHttpOnly.

Returns:boolean

Doc from io.vertx.core.http.Cookie.isHttpOnly.

the http only status of this cookie

Annotations

@Override

isSecure	back to summary
public boolean isSecure() Implements io.vertx.core.http.Cookie.isSecure. Returns:boolean Doc from io.vertx.core.http.Cookie.isSecure. the security status of this cookie Annotations @Override

isSecure

back to summary

public boolean isSecure()

Implements io.vertx.core.http.Cookie.isSecure.

Returns:boolean

Doc from io.vertx.core.http.Cookie.isSecure.

the security status of this cookie

Annotations

@Override

setChanged	back to summary
public void setChanged(boolean changed) Implements io.vertx.core.http.impl.ServerCookie.setChanged. Doc from io.vertx.core.http.impl.ServerCookie.setChanged. Set the cookie as being changed. Changed will be true for a cookie just created, false by default if just read from the request Parameters changed:boolean true if changed

setChanged

back to summary

public void setChanged(boolean changed)

Implements io.vertx.core.http.impl.ServerCookie.setChanged.

Doc from io.vertx.core.http.impl.ServerCookie.setChanged.

Set the cookie as being changed. Changed will be true for a cookie just created, false by default if just read from the request

Parameters

changed:boolean: true if changed

setDomain	back to summary
public Cookie setDomain(final String domain) Annotations @Override

setHttpOnly	back to summary
public Cookie setHttpOnly(final boolean httpOnly) Implements io.vertx.core.http.Cookie.setHttpOnly. Doc from io.vertx.core.http.Cookie.setHttpOnly. 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:boolean True if the cookie is HTTP only, otherwise false. Annotations @Override

setHttpOnly

back to summary

public Cookie setHttpOnly(final boolean httpOnly)

Implements io.vertx.core.http.Cookie.setHttpOnly.

Doc from io.vertx.core.http.Cookie.setHttpOnly.

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:boolean: True if the cookie is HTTP only, otherwise false.

Annotations

@Override

setMaxAge back to summary

setMaxAge	back to summary
public Cookie setMaxAge(final long maxAge) Implements io.vertx.core.http.Cookie.setMaxAge. Doc from io.vertx.core.http.Cookie.setMaxAge. Sets the maximum age of this cookie in seconds. If an age of `0` is specified, this cookie will be automatically removed by browser because it will expire immediately. If `Long#MIN_VALUE` 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:long The maximum age of this cookie in seconds Annotations @Override

public Cookie setMaxAge(final long maxAge)

Implements io.vertx.core.http.Cookie.setMaxAge.

Doc from io.vertx.core.http.Cookie.setMaxAge.

Sets the maximum age of this cookie in seconds. If an age of 0 is specified, this cookie will be automatically removed by browser because it will expire immediately. If Long#MIN_VALUE 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:long: The maximum age of this cookie in seconds

Annotations

@Override

setPath	back to summary
public Cookie setPath(final String path) Annotations @Override

setSameSite back to summary

public Cookie setSameSite(final CookieSameSite sameSite)

Implements io.vertx.core.http.Cookie.setSameSite.

Doc from io.vertx.core.http.Cookie.setSameSite.

Sets the same site of this cookie.

Parameters

sameSite:CookieSameSite: The policy should be one of CookieSameSite.

Returns:Cookie

a reference to this, so the API can be used fluently

Annotations

@Override

setSecure	back to summary
public Cookie setSecure(final boolean secure) Implements io.vertx.core.http.Cookie.setSecure. Doc from io.vertx.core.http.Cookie.setSecure. Sets the security getStatus of this cookie Parameters secure:boolean True if this cookie is to be secure, otherwise false Returns:Cookie a reference to this, so the API can be used fluently Annotations @Override

setSecure

back to summary

public Cookie setSecure(final boolean secure)

Implements io.vertx.core.http.Cookie.setSecure.

Doc from io.vertx.core.http.Cookie.setSecure.

Sets the security getStatus of this cookie

Parameters

secure:boolean: True if this cookie is to be secure, otherwise false

Returns:Cookie

a reference to this, so the API can be used fluently

Annotations

@Override

setValue	back to summary
public Cookie setValue(final String value) Implements io.vertx.core.http.Cookie.setValue. Doc from io.vertx.core.http.Cookie.setValue. Sets the value of this cookie Parameters value:String The value to set Returns:Cookie a reference to this, so the API can be used fluently Annotations @Override

setValue

back to summary

public Cookie setValue(final String value)

Implements io.vertx.core.http.Cookie.setValue.

Doc from io.vertx.core.http.Cookie.setValue.

Sets the value of this cookie

Parameters