vertx / io.vertx.reactivex.ext.web / Cookie

Cookie

open class Cookie

Represents an HTTP Cookie.

All cookies must have a name and a value and can optionally have other fields set such as path, domain, etc.

(Derived from io.netty.handler.codec.http.Cookie)

NOTE: This class has been automatically generated from the io.vertx.ext.web.Cookie non RX-ified interface using Vert.x codegen.

Constructors

<init>

Cookie(delegate: Cookie)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<Cookie>

Functions

cookie

open static fun cookie(name: String, value: String): Cookie

Create a new cookie

encode

open fun encode(): String

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

equals

open fun equals(other: Any?): Boolean

getDelegate

open fun getDelegate(): Cookie

getDomain

open fun getDomain(): String

getName

open fun getName(): String

getPath

open fun getPath(): String

getValue

open fun getValue(): String

hashCode

open fun hashCode(): Int

isChanged

open fun isChanged(): Boolean

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

isFromUserAgent

open fun isFromUserAgent(): Boolean

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

newInstance

open static fun newInstance(arg: Cookie): Cookie

setChanged

open fun setChanged(changed: Boolean): Unit

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

setDomain

open fun setDomain(domain: String): Cookie

Sets the domain of this cookie

setHttpOnly

open fun setHttpOnly(httpOnly: Boolean): Cookie

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.

setMaxAge

open fun setMaxAge(maxAge: Long): Cookie

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 java.lang.Long 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.

setPath

open fun setPath(path: String): Cookie

Sets the path of this cookie.

setSecure

open fun setSecure(secure: Boolean): Cookie

Sets the security getStatus of this cookie

setValue

open fun setValue(value: String): Cookie

Sets the value of this cookie

toString

open fun toString(): String