Cookie (micronaut 1.0.5 API)

All Superinterfaces:

Comparable<Cookie>, Serializable

All Known Implementing Classes:

NettyCookie, SimpleCookie
```
public interface Cookie
extends Comparable<Cookie>, Serializable
```
An interface representing a Cookie. See https://tools.ietf.org/html/rfc6265.

Since:

1.0

Author:

Graeme Rocher

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Cookie`	`domain(String domain)` Sets the domain of the cookie.
`String`	`getDomain()` Gets the domain name of this Cookie.
`long`	`getMaxAge()`
`String`	`getName()`
`String`	`getPath()` The path of the cookie.
`String`	`getValue()`
`Cookie`	`httpOnly(boolean httpOnly)` Sets whether the cookie is HTTP-Only.
`boolean`	`isHttpOnly()` Checks to see if this `Cookie` can only be accessed via HTTP.
`boolean`	`isSecure()`
`Cookie`	`maxAge(long maxAge)` Sets the max age of the cookie in seconds.
`default Cookie`	`maxAge(TemporalAmount maxAge)` Sets the max age of the cookie in seconds.
`static Cookie`	`of(String name, String value)` Construct a new Cookie for the given name and value.
`Cookie`	`path(String path)` Sets the path of the cookie.
`Cookie`	`secure(boolean secure)` Sets whether the cookie is secure.
`Cookie`	`value(String value)` Sets the value.

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - getName
```
String getName()
```
    Returns:
    
    The name of the cookie
  - getValue
```
String getValue()
```
    Returns:
    
    The value of the cookie
  - getDomain
```
String getDomain()
```
    Gets the domain name of this Cookie.
    Domain names are formatted according to RFC 2109.
    
    Returns:
    
    the domain name of this Cookie
  - getPath
```
String getPath()
```
    The path of the cookie. The cookie is visible to all paths below the request path on the server.
    
    Returns:
    
    The cookie path
  - isHttpOnly
```
boolean isHttpOnly()
```
    Checks to see if this Cookie can only be accessed via HTTP. If this returns true, the Cookie cannot be accessed through client side script - But only if the browser supports it.
    See here for reference
    
    Returns:
    
    True if this Cookie is HTTP-only or false if it isn't
  - isSecure
```
boolean isSecure()
```
    Returns:
    
    True if the cookie is secure
  - getMaxAge
```
long getMaxAge()
```
    Returns:
    
    The maximum age of the cookie in seconds
  - maxAge
```
Cookie maxAge(long maxAge)
```
    Sets the max age of the cookie in seconds.
    
    Parameters:
    
    maxAge - The max age
    
    Returns:
    
    This cookie
  - value
```
Cookie value(String value)
```
    Sets the value.
    
    Parameters:
    
    value - The value of the cookie
    
    Returns:
    
    This cookie
  - domain
```
Cookie domain(String domain)
```
    Sets the domain of the cookie.
    
    Parameters:
    
    domain - The domain of the cookie
    
    Returns:
    
    This cookie
  - path
```
Cookie path(String path)
```
    Sets the path of the cookie.
    
    Parameters:
    
    path - The path of the cookie
    
    Returns:
    
    This cookie
  - secure
```
Cookie secure(boolean secure)
```
    Sets whether the cookie is secure.
    
    Parameters:
    
    secure - Is the cookie secure
    
    Returns:
    
    This cookie
  - httpOnly
```
Cookie httpOnly(boolean httpOnly)
```
    Sets whether the cookie is HTTP-Only.
    
    Parameters:
    
    httpOnly - Is the cookie HTTP-Only
    
    Returns:
    
    This cookie
  - maxAge
```
default Cookie maxAge(TemporalAmount maxAge)
```
    Sets the max age of the cookie in seconds.
    
    Parameters:
    
    maxAge - The max age
    
    Returns:
    
    This cookie
  - of
```
static Cookie of(String name,
                 String value)
```
    Construct a new Cookie for the given name and value.
    
    Parameters:
    
    name - The name
    
    value - The value
    
    Returns:
    
    The Cookie

Interface Cookie

Method Summary

Methods inherited from interface java.lang.Comparable

Method Detail

getName

getValue

getDomain

getPath

isHttpOnly

isSecure

getMaxAge

maxAge

value

domain

path

secure

httpOnly

maxAge

of