Cookie (comsat-actors-api 0.1.0 API)

java.lang.Object
- co.paralleluniverse.comsat.webactors.Cookie

```
public class Cookie
extends Object
```
A HTTP cookie

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Cookie.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Cookie.Builder`

Method Summary

Methods
Modifier and Type	Method and Description
`static Cookie.Builder`	`cookie(String name, String value)` Constructs a cookie with the specified name and value.
`String`	`getComment()` The comment describing the purpose of this cookie, or `null` if the cookie has no comment.
`String`	`getDomain()` The domain name of this Cookie.
`int`	`getMaxAge()` The maximum age in seconds of this Cookie.
`String`	`getName()` The name of the cookie.
`String`	`getPath()` Returns the path on the server to which the browser returns this cookie.
`String`	`getValue()` The value of this Cookie.
`int`	`getVersion()` The version of the protocol this cookie complies with.
`boolean`	`isHttpOnly()` Whether this Cookie has been marked as HttpOnly.
`boolean`	`isSecure()` Returns `true` if the browser is sending cookies only over a secure protocol, or `false` if the browser can send cookies using any protocol.
`String`	`toString()`

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

- Method Detail
  - cookie
```
public static Cookie.Builder cookie(String name,
                    String value)
```
    Constructs a cookie with the specified name and value.
    The name must conform to RFC 2109. However, vendors may provide a configuration option that allows cookie names conforming to the original Netscape Cookie Specification to be accepted.
    The name of a cookie cannot be changed once the cookie has been created.
    The value can be anything the server chooses to send. Its value is probably of interest only to the server.
    By default, cookies are created according to the Netscape cookie specification. The version can be changed with the setVersion method.
    
    Parameters:
    name - the name of the cookie
    value - the value of the cookie
    
    Returns:
    a new Cookie.Builder
  - getName
```
public String getName()
```
    The name of the cookie.
    
    See Also:
    cookie(String, String)
  - getValue
```
public String getValue()
```
    The value of this Cookie.
    
    See Also:
    cookie(String, String)
  - getPath
```
public String getPath()
```
    Returns the path on the server to which the browser returns this cookie. The cookie is visible to all subpaths on the server.
    
    Returns:
    a String specifying a path that contains a servlet name, for example, /catalog
    See Also:
    Cookie.Builder.setPath(java.lang.String)
  - getDomain
```
public String getDomain()
```
    The domain name of this Cookie.
    Domain names are formatted according to RFC 2109.
    
    See Also:
    Cookie.Builder.setDomain(java.lang.String)
  - getMaxAge
```
public int getMaxAge()
```
    The maximum age in seconds of this Cookie.
    By default, -1 is returned, which indicates that the cookie will persist until browser shutdown.
    
    Returns:
    an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie persists until browser shutdown
    See Also:
    Cookie.Builder.setMaxAge(int)
  - getComment
```
public String getComment()
```
    The comment describing the purpose of this cookie, or null if the cookie has no comment.
    
    See Also:
    Cookie.Builder.setComment(java.lang.String)
  - getVersion
```
public int getVersion()
```
    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:
    Cookie.Builder.setVersion(int)
  - isHttpOnly
```
public boolean isHttpOnly()
```
    Whether this Cookie has been marked as HttpOnly.
    
    Returns:
    true if this Cookie has been marked as HttpOnly, false otherwise
  - isSecure
```
public boolean isSecure()
```
    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:
    true if the browser uses a secure protocol, false otherwise
    See Also:
    Cookie.Builder.setSecure(boolean)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Cookie

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

cookie

getName

getValue

getPath

getDomain

getMaxAge

getComment

getVersion

isHttpOnly

isSecure

toString