H.Cookie (OSGL HTTP 1.1.1 API)

java.lang.Object
- org.osgl.http.H.Cookie

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ServletCookie

Enclosing class:

H
```
public static class H.Cookie
extends Object
implements Serializable
```
The HTTP cookie

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class H.Cookie.F
The function object namespace

Nested Classes
Modifier and Type	Class and Description
`static class`	`H.Cookie.F` The function object namespace

Constructor Summary

Constructors
Constructor and Description
`Cookie(String name)`
`Cookie(String name, String value)`
`Cookie(String name, String value, int maxAge, boolean secure, String path, String domain, boolean httpOnly)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Collection<H.Cookie>`	`all()` Returns all cookies from current context
`String`	`comment()`
`H.Cookie`	`comment(String comment)`
`String`	`domain()` Returns the domain of the cookie
`H.Cookie`	`domain(String domain)` Set the domain of the cookie
`Date`	`expires()`
`H.Cookie`	`expires(Date expires)`
`static H.Cookie`	`get(String name)` Get a cookie from current context by name
`boolean`	`httpOnly()`
`H.Cookie`	`httpOnly(boolean httpOnly)`
`int`	`maxAge()` Returns the maximum age of cookie specified in seconds.
`H.Cookie`	`maxAge(int maxAge)` Set the max age of the cookie in seconds.
`String`	`name()` Returns the name of the cookie.
`String`	`path()` Returns the path on the server to which the browser returns this cookie.
`H.Cookie`	`path(String uri)` Specifies a path for the cookie to which the client should return the cookie.
`boolean`	`secure()` Returns `true` if the browser is sending cookies only over a secure protocol, or `false` if the browser can send cookies using any protocol.
`H.Cookie`	`secure(boolean secure)` Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
`static void`	`set(H.Cookie cookie)` Add a cookie to the current context
`String`	`value()` Returns the value of the cookie
`H.Cookie`	`value(String value)` Set a value to a cookie and the return `this` cookie
`int`	`version()` Returns the version of the protocol this cookie complies with.
`H.Cookie`	`version(int v)` Sets the version of the cookie protocol that this Cookie complies with.

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

- Constructor Detail
  - Cookie
```
public Cookie(String name)
```
  - Cookie
```
public Cookie(String name,
              String value)
```
  - Cookie
```
public Cookie(String name,
              String value,
              int maxAge,
              boolean secure,
              String path,
              String domain,
              boolean httpOnly)
```
- Method Detail
  - name
```
public String name()
```
    Returns the name of the cookie. Cookie name cannot be changed after created
    
    Returns:
    
    the name
  - value
```
public String value()
```
    Returns the value of the cookie
    
    Returns:
    
    the value
  - value
```
public H.Cookie value(String value)
```
    Set a value to a cookie and the return this cookie
    
    Parameters:
    
    value - the value to be set to the cookie
    
    Returns:
    
    this cookie
  - domain
```
public String domain()
```
    Returns the domain of the cookie
    
    Returns:
    
    domain
  - domain
```
public H.Cookie domain(String domain)
```
    Set the domain of the cookie
    
    Parameters:
    
    domain - the domain string
    
    Returns:
    
    this cookie
  - path
```
public String path()
```
    Returns the path on the server to which the browser returns this cookie. The cookie is visible to all subpaths on the server.
    
    Returns:
    
    the path
    
    See Also:
    
    path(String)
  - path
```
public H.Cookie path(String uri)
```
    Specifies a path for the cookie to which the client should return the cookie.
    The cookie is visible to all the pages in the directory you specify, and all the pages in that directory's subdirectories.
    Consult RFC 2109 (available on the Internet) for more information on setting path names for cookies.
    
    Parameters:
    
    uri - a String specifying a path
    
    Returns:
    
    this cookie after path is set
    
    See Also:
    
    path
  - maxAge
```
public int maxAge()
```
    Returns the maximum age of cookie specified in seconds. If maxAge is set to -1 then the cookie will persist until browser shutdown
    
    Returns:
    
    the max age of the cookie
  - maxAge
```
public H.Cookie maxAge(int maxAge)
```
    Set the max age of the cookie in seconds.
    A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age.
    A negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits. A zero value causes the cookie to be deleted.
    
    Parameters:
    
    maxAge - the max age to be set
    
    Returns:
    
    this instance
    
    See Also:
    
    maxAge()
  - expires
```
public Date expires()
```
  - expires
```
public H.Cookie expires(Date expires)
```
  - secure
```
public boolean secure()
```
    Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.
    
    Returns:
    
    if the cookie is secure
    
    See Also:
    
    secure(boolean)
  - secure
```
public H.Cookie secure(boolean secure)
```
    Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
    The default value is false.
    
    Parameters:
    
    secure - the cookie secure requirement
    
    Returns:
    
    this cookie instance
  - version
```
public int version()
```
    Returns the version of the protocol this cookie complies with. Version 1 complies with RFC 2109, and version 0 complies with the original cookie specification drafted by Netscape. Cookies provided by a browser use and identify the browser's cookie version.
    
    Returns:
    
    0 if the cookie complies with the original Netscape specification; 1 if the cookie complies with RFC 2109
    
    See Also:
    
    version(int)
  - version
```
public H.Cookie version(int v)
```
    Sets the version of the cookie protocol that this Cookie complies with.
    Version 0 complies with the original Netscape cookie specification. Version 1 complies with RFC 2109.
    Since RFC 2109 is still somewhat new, consider version 1 as experimental; do not use it yet on production sites.
    
    Parameters:
    
    v - 0 if the cookie should comply with the original Netscape specification; 1 if the cookie should comply with RFC 2109
    
    Returns:
    
    this cookie instance
    
    See Also:
    
    version()
  - httpOnly
```
public boolean httpOnly()
```
  - httpOnly
```
public H.Cookie httpOnly(boolean httpOnly)
```
  - comment
```
public String comment()
```
  - comment
```
public H.Cookie comment(String comment)
```
  - set
```
public static void set(H.Cookie cookie)
```
    Add a cookie to the current context
    
    Parameters:
    
    cookie - the cookie
  - get
```
public static H.Cookie get(String name)
```
    Get a cookie from current context by name
    
    Parameters:
    
    name - the cookie name
    
    Returns:
    
    a cookie with the name specified
  - all
```
public static Collection<H.Cookie> all()
```
    Returns all cookies from current context
    
    Returns:
    
    all cookies

Class H.Cookie

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cookie

Cookie

Cookie

Method Detail

name

value

value

domain

domain

path

path

maxAge

maxAge

expires

expires

secure

secure

version

version

httpOnly

httpOnly

comment

comment

set

get

all