Cookie (fred API)

java.lang.Object
- freenet.clients.http.Cookie

Direct Known Subclasses:: ReceivedCookie

public class Cookie
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`discard`
`protected java.net.URI`	`domain`
`protected java.util.Date`	`expirationDate`
`static java.util.HashSet<java.lang.Character>`	`httpSeparatorCharacters` Taken from this discussion: CTL = (octets 0 - 31) and DEL (127)> CHAR = token = 1* separators = "(" \| ")" \| "<" \| ">" \| "@" \| "," \| ";" \| ":" \| "\" \| <"> \| "/" \| "[" \| "]" \| "?" \| "=" \| "{" \| "}" \| SP \| HT so, anything from 32-126 that isn't in that list of seperators is valid.
`protected java.lang.String`	`name`
`protected java.net.URI`	`path`
`protected java.lang.String`	`value`
`protected int`	`version`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Cookie()`
	`Cookie(java.net.URI myPath, java.lang.String myName, java.lang.String myValue, java.util.Date myExpirationDate)` Constructor for creating cookies which are to be used in `ToadletContext.setCookie`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.String`	`encodeToHeaderValue()` Encodes the content of this cookie to the HTTP header value representation as of RFC2965.
`boolean`	`equals(java.lang.Object obj)` Returns true if two Cookies have equal domain, path and name.
`java.net.URI`	`getDomain()`
`java.lang.String`	`getName()`
`java.net.URI`	`getPath()`
`java.lang.String`	`getValue()`
`int`	`hashCode()`
`static java.net.URI`	`validateDomain(java.lang.String domainString)`
`static java.net.URI`	`validateDomain(java.net.URI domain)`
`static java.util.Date`	`validateExpirationDate(java.util.Date expirationDate)`
`static java.lang.String`	`validateName(java.lang.String name)` Validates the name of a cookie against a mixture of RFC2965, RFC2616 (from IETF.org) and personal choice :\| The personal choice is mostly that it uses isISOControl for determining control characters instead of the list in the RFC - therefore, more characters are considered as control characters.
`static java.net.URI`	`validatePath(java.lang.String stringPath)`
`static java.net.URI`	`validatePath(java.net.URI path)`
`static java.lang.String`	`validateValue(java.lang.String value)` Validates the value of a cookie against a mixture of RFC2965, RFC2616 (from IETF.org) and personal choice :\| The personal choice is mostly that it uses isISOControl for determining control characters instead of the list in the RFC - therefore, more characters are considered as control characters.

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

- Field Detail
  - httpSeparatorCharacters
```
public static final java.util.HashSet<java.lang.Character> httpSeparatorCharacters
```
    Taken from this discussion: CTL = (octets 0 - 31) and DEL (127)> CHAR = token = 1* separators = "(" | ")" | "<" | ">" | "@" | "," | ";" | ":" | "\" | <"> | "/" | "[" | "]" | "?" | "=" | "{" | "}" | SP | HT so, anything from 32-126 that isn't in that list of seperators is valid. TheSeeker: where did you copy that from? http://www.ietf.org/rfc/rfc2616.txt
  - version
```
protected int version
```
  - domain
```
protected java.net.URI domain
```
  - path
```
protected java.net.URI path
```
  - name
```
protected java.lang.String name
```
  - value
```
protected java.lang.String value
```
  - expirationDate
```
protected java.util.Date expirationDate
```
  - discard
```
protected boolean discard
```
- Constructor Detail
  - Cookie
```
public Cookie(java.net.URI myPath,
              java.lang.String myName,
              java.lang.String myValue,
              java.util.Date myExpirationDate)
```
    Constructor for creating cookies which are to be used in ToadletContext.setCookie.
    
    Parameters:
    
    myPath - The path of the cookie. Must be absolute.
    
    myName - The name of the cookie. Must be latin letters and numbers only and is converted to lowercase.
    
    myValue - The value of the cookie. Must not contain any linebreaks. May be null, null means empty value.
    
    Throws:
    
    java.net.URISyntaxException
  - Cookie
```
protected Cookie()
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns true if two Cookies have equal domain, path and name. Does not check the value!
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - validateDomain
```
public static java.net.URI validateDomain(java.lang.String domainString)
                                   throws java.net.URISyntaxException
```
    Throws:
    
    java.net.URISyntaxException
  - validateDomain
```
public static java.net.URI validateDomain(java.net.URI domain)
```
  - validatePath
```
public static java.net.URI validatePath(java.lang.String stringPath)
                                 throws java.net.URISyntaxException
```
    Throws:
    
    java.net.URISyntaxException
  - validatePath
```
public static java.net.URI validatePath(java.net.URI path)
```
  - validateName
```
public static java.lang.String validateName(java.lang.String name)
```
    Validates the name of a cookie against a mixture of RFC2965, RFC2616 (from IETF.org) and personal choice :| The personal choice is mostly that it uses isISOControl for determining control characters instead of the list in the RFC - therefore, more characters are considered as control characters. So effectively this function is more restrictive than the RFCs. TODO: Read the RFCs in depth and make this function fully compatible.
  - validateValue
```
public static java.lang.String validateValue(java.lang.String value)
```
    Validates the value of a cookie against a mixture of RFC2965, RFC2616 (from IETF.org) and personal choice :| The personal choice is mostly that it uses isISOControl for determining control characters instead of the list in the RFC - therefore, more characters are considered as control characters. So effectively this function is more restrictive than the RFCs. TODO: Read the RFCs in depth and make this function fully compatible.
  - validateExpirationDate
```
public static java.util.Date validateExpirationDate(java.util.Date expirationDate)
```
  - getDomain
```
public java.net.URI getDomain()
```
  - getPath
```
public java.net.URI getPath()
```
  - getName
```
public java.lang.String getName()
```
  - getValue
```
public java.lang.String getValue()
```
  - encodeToHeaderValue
```
protected java.lang.String encodeToHeaderValue()
```
    Encodes the content of this cookie to the HTTP header value representation as of RFC2965. Does not quote any of the values as Firefox 4 does not support quotation and the latest IETF draft for cookies does not contain quotation: http://tools.ietf.org/html/draft-ietf-httpstate-cookie-23 The key "set-cookie2:" is not prefixed to the returned String!

Class Cookie

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

httpSeparatorCharacters

version

domain

path

name

value

expirationDate

discard

Constructor Detail

Cookie

Cookie

Method Detail

equals

hashCode

validateDomain

validateDomain

validatePath

validatePath

validateName

validateValue

validateExpirationDate

getDomain

getPath

getName

getValue

encodeToHeaderValue