Cookie (jooby 2.16.3 API)

java.lang.Object
- io.jooby.Cookie

```
public class Cookie
extends Object
```
Response cookie implementation. Response are send it back to client using Context.setResponseCookie(Cookie).

Since:

2.0.0

Author:

edgar

Field Summary

Fields
Modifier and Type Field and Description

static String HMAC_SHA256
Algorithm name.

Fields
Modifier and Type	Field and Description
`static String`	`HMAC_SHA256` Algorithm name.

Constructor Summary

Constructors
Constructor and Description

Cookie(String name)
Creates a response cookie without a value.

Cookie(String name, String value)
Creates a response cookie.

Constructors
Constructor and Description
`Cookie(String name)` Creates a response cookie without a value.
`Cookie(String name, String value)` Creates a response cookie.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Cookie`	`clone()` Copy all state from this cookie and creates a new cookie.
`static Optional<Cookie>`	`create(String namespace, com.typesafe.config.Config conf)` Attempt to create/parse a cookie from application configuration object.
`static Map<String,String>`	`decode(String value)` Decode a cookie value using, like: `k=v`, multiple `k=v` pair are separated by `&`.
`static String`	`encode(Map<String,String> attributes)` Encode a hash into cookie value, like: `k1=v1&...&kn=vn`.
`String`	`getDomain()` Cookie's domain.
`String`	`getDomain(String domain)` Get cookie's domain.
`long`	`getMaxAge()` Max age value: - `-1`: indicates a browser session.
`String`	`getName()` Cookie's name.
`String`	`getPath()` Cookie's path.
`String`	`getPath(String path)` Cookie's path.
`SameSite`	`getSameSite()` Returns the value for the 'SameSite' parameter.
`String`	`getValue()` Cookie's value.
`boolean`	`isHttpOnly()` Cookie's http-only flag.
`boolean`	`isSecure()` Secure cookie.
`Cookie`	`setDomain(String domain)` Set cookie's domain.
`Cookie`	`setHttpOnly(boolean httpOnly)` Set cookie's http-only.
`Cookie`	`setMaxAge(Duration maxAge)` Set max age value: - `-1`: indicates a browser session.
`Cookie`	`setMaxAge(long maxAge)` Set max age value: - `-1`: indicates a browser session.
`Cookie`	`setName(String name)` Set cookie's name.
`Cookie`	`setPath(String path)` Set cookie's path.
`Cookie`	`setSameSite(SameSite sameSite)` Sets the value for the 'SameSite' parameter.
`Cookie`	`setSecure(boolean secure)` Set cookie secure flag.
`Cookie`	`setValue(String value)` Set cookie's value.
`static String`	`sign(String value, String secret)` Sign a value using a secret key.
`String`	`toCookieString()` Generates a cookie string.
`String`	`toString()`
`static String`	`unsign(String value, String secret)` Un-sign a value, previously signed with `sign(String, String)`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - HMAC_SHA256
```
public static final String HMAC_SHA256
```
    Algorithm name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Cookie
```
public Cookie(@Nonnull
              String name,
              @Nullable
              String value)
```
    Creates a response cookie.
    
    Parameters:
    
    name - Cookie's name.
    
    value - Cookie's value or null.
  - Cookie
```
public Cookie(@Nonnull
              String name)
```
    Creates a response cookie without a value.
    
    Parameters:
    
    name - Cookie's name.
- Method Detail
  - clone
```
@Nonnull
public Cookie clone()
```
    Copy all state from this cookie and creates a new cookie.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    New cookie.
  - getName
```
@Nonnull
public String getName()
```
    Cookie's name.
    
    Returns:
    
    Cookie's name.
  - setName
```
@Nonnull
public Cookie setName(@Nonnull
                               String name)
```
    Set cookie's name.
    
    Parameters:
    
    name - Cookie's name.
    
    Returns:
    
    This cookie.
  - getValue
```
@Nullable
public String getValue()
```
    Cookie's value.
    
    Returns:
    
    Cookie's value.
  - setValue
```
@Nonnull
public Cookie setValue(@Nonnull
                                String value)
```
    Set cookie's value.
    
    Parameters:
    
    value - Cookie's value.
    
    Returns:
    
    This cookie.
  - getDomain
```
@Nullable
public String getDomain()
```
    Cookie's domain.
    
    Returns:
    
    Cookie's domain.
  - getDomain
```
@Nonnull
public String getDomain(@Nonnull
                                 String domain)
```
    Get cookie's domain.
    
    Parameters:
    
    domain - Defaults cookie's domain.
    
    Returns:
    
    Cookie's domain..
  - setDomain
```
@Nonnull
public Cookie setDomain(@Nonnull
                                 String domain)
```
    Set cookie's domain.
    
    Parameters:
    
    domain - Cookie's domain.
    
    Returns:
    
    This cookie.
  - getPath
```
@Nullable
public String getPath()
```
    Cookie's path.
    
    Returns:
    
    Cookie's path.
  - getPath
```
@Nonnull
public String getPath(@Nonnull
                               String path)
```
    Cookie's path.
    
    Parameters:
    
    path - Defaults path.
    
    Returns:
    
    Cookie's path.
  - setPath
```
@Nonnull
public Cookie setPath(@Nonnull
                               String path)
```
    Set cookie's path.
    
    Parameters:
    
    path - Cookie's path.
    
    Returns:
    
    This cookie.
  - isHttpOnly
```
public boolean isHttpOnly()
```
    Cookie's http-only flag.
    
    Returns:
    
    Htto-only flag.
  - setHttpOnly
```
public Cookie setHttpOnly(boolean httpOnly)
```
    Set cookie's http-only.
    
    Parameters:
    
    httpOnly - Cookie's http-only.
    
    Returns:
    
    This cookie.
  - isSecure
```
public boolean isSecure()
```
    Secure cookie.
    
    Returns:
    
    Secure cookie flag.
  - setSecure
```
@Nonnull
public Cookie setSecure(boolean secure)
```
    Set cookie secure flag.
    
    Parameters:
    
    secure - Cookie's secure.
    
    Returns:
    
    This cookie.
    
    Throws:
    
    IllegalArgumentException - if false is specified and the 'SameSite' attribute value requires a secure cookie.
  - getMaxAge
```
public long getMaxAge()
```
    Max age value: - -1: indicates a browser session. It is deleted when user closed the browser. - 0: indicates a cookie has expired and browser must delete the cookie. - positive value: indicates the number of seconds from current date, where browser must expires the cookie.
    
    Returns:
    
    Max age, in seconds.
  - setMaxAge
```
@Nonnull
public Cookie setMaxAge(@Nonnull
                                 Duration maxAge)
```
    Set max age value: - -1: indicates a browser session. It is deleted when user closed the browser. - 0: indicates a cookie has expired and browser must delete the cookie. - positive value: indicates the number of seconds from current date, where browser must expires the cookie.
    
    Parameters:
    
    maxAge - Cookie max age.
    
    Returns:
    
    This options.
  - setMaxAge
```
@Nonnull
public Cookie setMaxAge(long maxAge)
```
    Set max age value: - -1: indicates a browser session. It is deleted when user closed the browser. - 0: indicates a cookie has expired and browser must delete the cookie. - positive value: indicates the number of seconds from current date, where browser must expires the cookie.
    
    Parameters:
    
    maxAge - Cookie max age, in seconds.
    
    Returns:
    
    This options.
  - getSameSite
```
@Nullable
public SameSite getSameSite()
```
    Returns the value for the 'SameSite' parameter.
    - SameSite.LAX - Cookies are allowed to be sent with top-level navigations and will be sent along with GET request initiated by third party website. This is the default value in modern browsers.
    - SameSite.STRICT - Cookies will only be sent in a first-party context and not be sent along with requests initiated by third party websites.
    - SameSite.NONE - Cookies will be sent in all contexts, i.e sending cross-origin is allowed. Requires the Secure attribute in latest browser versions.
    - null - Not specified.
    Returns:
    
    the value for 'SameSite' parameter.
    
    See Also:
    
    setSecure(boolean), https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
  - setSameSite
```
public Cookie setSameSite(@Nullable
                          SameSite sameSite)
```
    Sets the value for the 'SameSite' parameter.
    - SameSite.LAX - Cookies are allowed to be sent with top-level navigations and will be sent along with GET request initiated by third party website. This is the default value in modern browsers.
    - SameSite.STRICT - Cookies will only be sent in a first-party context and not be sent along with requests initiated by third party websites.
    - SameSite.NONE - Cookies will be sent in all contexts, i.e sending cross-origin is allowed. Requires the Secure attribute in latest browser versions.
    - null - Not specified.
    Parameters:
    
    sameSite - the value for the 'SameSite' parameter.
    
    Returns:
    
    this instance.
    
    Throws:
    
    IllegalArgumentException - if a value requiring a secure cookie is specified and this cookie is not flagged as secure.
    
    See Also:
    
    setSecure(boolean), https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toCookieString
```
@Nonnull
public String toCookieString()
```
    Generates a cookie string. This is the value we sent to the client as Set-Cookie header.
    
    Returns:
    
    Cookie string.
  - sign
```
@Nonnull
public static String sign(@Nonnull
                                   String value,
                                   @Nonnull
                                   String secret)
```
    Sign a value using a secret key. A value and secret key are required. Sign is done with HMAC_SHA256. Signed value looks like:
```
   [signed value] '|' [raw value]
 
```
    Parameters:
    
    value - A value to sign.
    
    secret - A secret key.
    
    Returns:
    
    A signed value.
  - unsign
```
@Nullable
public static String unsign(@Nonnull
                                      String value,
                                      @Nonnull
                                      String secret)
```
    Un-sign a value, previously signed with sign(String, String). Produces a nonnull value or null for invalid.
    
    Parameters:
    
    value - A signed value.
    
    secret - A secret key.
    
    Returns:
    
    A new signed value or null.
  - encode
```
@Nonnull
public static String encode(@Nullable
                                     Map<String,String> attributes)
```
    Encode a hash into cookie value, like: k1=v1&...&kn=vn. Also, key and value are encoded using URLEncoder.
    
    Parameters:
    
    attributes - Map to encode.
    
    Returns:
    
    URL encoded from map attributes.
  - decode
```
@Nonnull
public static Map<String,String> decode(@Nullable
                                                 String value)
```
    Decode a cookie value using, like: k=v, multiple k=v pair are separated by &. Also, k and v are decoded using URLDecoder.
    
    Parameters:
    
    value - URL encoded value.
    
    Returns:
    
    Decoded as map.
  - create
```
@Nonnull
public static Optional<Cookie> create(@Nonnull
                                               String namespace,
                                               @Nonnull
                                               com.typesafe.config.Config conf)
```
    Attempt to create/parse a cookie from application configuration object. The namespace given must be present and must defined a name property. The namespace might optionally defined: value, path, domain, secure, httpOnly and maxAge.
    
    Parameters:
    
    namespace - Cookie namespace/prefix.
    
    conf - Configuration object.
    
    Returns:
    
    Parsed cookie or empty.

Class Cookie

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HMAC_SHA256

Constructor Detail

Cookie

Cookie

Method Detail

clone

getName

setName

getValue

setValue

getDomain

getDomain

setDomain

getPath

getPath

setPath

isHttpOnly

setHttpOnly

isSecure

setSecure

getMaxAge

setMaxAge

setMaxAge

getSameSite

setSameSite

toString

toCookieString

sign

unsign

encode

decode

create