Cookie (api 2.1.12 API)

java.lang.Object
- com.yanzhenjie.andserver.http.cookie.Cookie

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Cookie
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
Created by Zhenjie Yan on 2018

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Cookie(java.lang.String name, java.lang.String value)
Constructs a cookie with the specified name and value.

Constructors
Constructor and Description
`Cookie(java.lang.String name, java.lang.String value)` Constructs a cookie with the specified name and value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`
`java.lang.String`	`getComment()` Returns the comment describing the purpose of this cookie, or `null` if the cookie has no comment.
`java.lang.String`	`getDomain()` Gets the domain name of this Cookie.
`int`	`getMaxAge()` Gets the maximum age in seconds of this Cookie.
`java.lang.String`	`getName()` Returns the name of the cookie.
`java.lang.String`	`getPath()` Returns the path on the server to which the browser returns this cookie.
`boolean`	`getSecure()` Returns `true` if the browser is sending cookies only over a secure protocol, or `false` if the browser can send cookies using any protocol.
`java.lang.String`	`getValue()` Gets the current value of this Cookie.
`int`	`getVersion()` Returns the version of the protocol this cookie complies with.
`boolean`	`isHttpOnly()` Checks whether this Cookie has been marked as HttpOnly.
`void`	`setComment(java.lang.String purpose)` Specifies a comment that describes a cookie's purpose.
`void`	`setDomain(java.lang.String domain)` Specifies the domain within which this cookie should be presented.
`void`	`setHttpOnly(boolean isHttpOnly)` Marks or unmarks this Cookie as HttpOnly.
`void`	`setMaxAge(int expiry)` Sets the maximum age in seconds for this Cookie.
`void`	`setPath(java.lang.String path)` Specifies a path for the cookie to which the client should return the cookie.
`void`	`setSecure(boolean flag)` Indicates to the browser whether the cookie should only be sent using a secure protocol, e.g.
`void`	`setValue(java.lang.String newValue)` Assigns a new value to this Cookie.
`void`	`setVersion(int v)` Sets the version of the cookie protocol that this Cookie complies with.

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

- Constructor Detail
  - Cookie
```
public Cookie(java.lang.String name,
              java.lang.String value)
```
    Constructs a cookie with the specified name and value.
    The name must conform to RFC 2109.
    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. The cookie's value can be changed after creation with the setValue(String) method.
    The version can be changed with the setVersion(int) method.
    
    Parameters:
    
    name - the name of the cookie.
    
    value - the value of the cookie.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the cookie name is null or empty or contains any illegal characters (e.g. a comma, space, or semicolon) or matches a token reserved for use by the cookie protocol.
    
    See Also:
    
    setValue(String), setVersion(int)
- Method Detail
  - setComment
```
public void setComment(java.lang.String purpose)
```
    Specifies a comment that describes a cookie's purpose. The comment is useful if the browser presents the cookie to the user.
    
    Parameters:
    
    purpose - a String specifying the comment to display to the user.
    
    See Also:
    
    getComment()
  - getComment
```
public java.lang.String getComment()
```
    Returns the comment describing the purpose of this cookie, or null if the cookie has no comment.
    
    Returns:
    
    the comment of the cookie, or null if unspecified.
    
    See Also:
    
    setComment(String)
  - setDomain
```
public void setDomain(java.lang.String domain)
```
    Specifies the domain within which this cookie should be presented.
    The form of the domain name is specified by RFC 2109. StandardCookieProcessor domain name begins with a dot (.foo.com) and means that the cookie is visible to servers in a specified Domain Name System (DNS) zone (e.g. www.foo.com, but not a.b.foo.com). By default, cookies are only returned to the server that sent them.
    
    Parameters:
    
    domain - the domain name within which this cookie is visible; form is according to RFC 2109.
    
    See Also:
    
    getDomain()
  - getDomain
```
public java.lang.String getDomain()
```
    Gets the domain name of this Cookie.
    Domain names are formatted according to RFC 2109.
    
    Returns:
    
    the domain name of this Cookie.
    
    See Also:
    
    setDomain(String)
  - setMaxAge
```
public void setMaxAge(int expiry)
```
    Sets the maximum age in seconds for this Cookie.
    StandardCookieProcessor 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.
    StandardCookieProcessor negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits. StandardCookieProcessor zero value causes the cookie to be deleted.
    
    Parameters:
    
    expiry - an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie.
    
    See Also:
    
    getMaxAge()
  - getMaxAge
```
public int getMaxAge()
```
    Gets the maximum age in seconds of this Cookie.
    By default, -1 is returned, which indicates that the cookie will persist until browser shutdown.
    
    See Also:
    
    setMaxAge(int)
  - setPath
```
public void setPath(java.lang.String path)
```
    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:
    
    path - a String specifying a path.
    
    See Also:
    
    getPath()
  - getPath
```
public java.lang.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.
    
    See Also:
    
    setPath(String)
  - setSecure
```
public void setSecure(boolean flag)
```
    Indicates to the browser whether the cookie should only be sent using a secure protocol, e.g. HTTPS or SSL.
    The default value is false.
    
    Parameters:
    
    flag - if true, sends the cookie from the browser to the server only when using a secure protocol; if false, sent on any protocol.
    
    See Also:
    
    getSecure()
  - getSecure
```
public boolean getSecure()
```
    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:
    
    setSecure(boolean)
  - getName
```
public java.lang.String getName()
```
    Returns the name of the cookie. The name cannot be changed after creation.
    
    Returns:
    
    the name of the cookie.
  - setValue
```
public void setValue(java.lang.String newValue)
```
    Assigns a new value to this Cookie.
    If you use a binary value, you may want to use BASE64 encoding.
    With Version 0 cookies, values should not contain white space, brackets, parentheses, equals signs, commas, double quotes, slashes, question marks, at signs, colons, and semicolons. Empty values may not behave the same way on all browsers.
    
    Parameters:
    
    newValue - the new value of the cookie.
    
    See Also:
    
    getValue()
  - getValue
```
public java.lang.String getValue()
```
    Gets the current value of this Cookie.
    
    Returns:
    
    the current value of this Cookie.
    
    See Also:
    
    setValue(String)
  - getVersion
```
public int getVersion()
```
    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.
    
    See Also:
    
    setVersion(int)
  - setVersion
```
public void setVersion(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.
    
    See Also:
    
    getVersion()
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - setHttpOnly
```
public void setHttpOnly(boolean isHttpOnly)
```
    Marks or unmarks this Cookie as HttpOnly.
    If isHttpOnly is set to true, this cookie is marked as HttpOnly, by adding the HttpOnly attribute to it.
    HttpOnly cookies are not supposed to be exposed to client-side scripting code, and may therefore help mitigate certain kinds of cross-site scripting attacks.
    
    Parameters:
    
    isHttpOnly - true if this cookie is to be marked as HttpOnly, false otherwise.
  - isHttpOnly
```
public boolean isHttpOnly()
```
    Checks whether this Cookie has been marked as HttpOnly.
    
    Returns:
    
    true if this Cookie has been marked as HttpOnly, false otherwise.

Class Cookie

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cookie

Method Detail

setComment

getComment

setDomain

getDomain

setMaxAge

getMaxAge

setPath

getPath

setSecure

getSecure

getName

setValue

getValue

getVersion

setVersion

clone

setHttpOnly

isHttpOnly