org.apache.commons.httpclient.cookie
public class RFC2965Spec extends CookieSpecBase implements CookieVersionSupport
RFC 2965 specific cookie management functions.
Since: 3.1
Field Summary | |
---|---|
static String | SET_COOKIE2_KEY
Cookie Response Header name for cookies processed
by this spec. |
Constructor Summary | |
---|---|
RFC2965Spec()
Default constructor
|
Method Summary | |
---|---|
boolean | domainMatch(String host, String domain)
Performs domain-match as defined by the RFC2965.
|
protected CookieAttributeHandler | findAttribHandler(String name)
Finds an attribute handler CookieAttributeHandler for the
given attribute. |
String | formatCookie(Cookie cookie)
Return a string suitable for sending in a "Cookie" header as
defined in RFC 2965 |
String | formatCookies(Cookie[] cookies)
Create a RFC 2965 compliant "Cookie" header value containing all
Cookies suitable for
sending in a "Cookie" header |
protected CookieAttributeHandler | getAttribHandler(String name)
Gets attribute handler CookieAttributeHandler for the
given attribute.
|
protected Iterator | getAttribHandlerIterator() |
int | getVersion() |
Header | getVersionHeader() |
boolean | match(String host, int port, String path, boolean secure, Cookie cookie)
Return true if the cookie should be submitted with a request
with given attributes, false otherwise. |
Cookie[] | parse(String host, int port, String path, boolean secure, Header header)
Parses the Set-Cookie2 value into an array of Cookies.
|
Cookie[] | parse(String host, int port, String path, boolean secure, String header) |
void | parseAttribute(NameValuePair attribute, Cookie cookie)
Parse RFC 2965 specific cookie attribute and update the corresponsing
Cookie properties.
|
protected void | registerAttribHandler(String name, CookieAttributeHandler handler) |
void | validate(String host, int port, String path, boolean secure, Cookie cookie)
Performs RFC 2965 compliant Cookie validation
|
Host A's name domain-matches host B's if
Parameters: host host name where cookie is received from or being sent to. domain The cookie domain attribute.
Returns: true if the specified host matches the given domain.
Parameters: name attribute name. e.g. Domain, Path, etc.
Returns: an attribute handler or null
Parameters: cookie a Cookie to be formatted as string
Returns: a string suitable for sending in a "Cookie" header.
Parameters: cookies an array of Cookies to be formatted
Returns: a string suitable for sending in a Cookie header.
Parameters: name attribute name. e.g. Domain, Path, etc.
Throws: IllegalStateException if handler not found for the specified attribute.
Parameters: host the host to which the request is being submitted port the port to which the request is being submitted (ignored) path the path to which the request is being submitted secure true if the request is using a secure connection
Returns: true if the cookie matches the criterium
The syntax for the Set-Cookie2 response header is:
set-cookie = "Set-Cookie2:" cookies cookies = 1#cookie cookie = NAME "=" VALUE * (";" cookie-av) NAME = attr VALUE = value cookie-av = "Comment" "=" value | "CommentURL" "=" <"> http_URL <"> | "Discard" | "Domain" "=" value | "Max-Age" "=" value | "Path" "=" value | "Port" [ "=" <"> portlist <"> ] | "Secure" | "Version" "=" 1*DIGIT portlist = 1#portnum portnum = 1*DIGIT
Parameters: host the host from which the Set-Cookie2 value was received port the port from which the Set-Cookie2 value was received path the path from which the Set-Cookie2 value was received secure true when the Set-Cookie2 value was received over secure conection header the Set-Cookie2 Header received from the server
Returns: an array of Cookies parsed from the Set-Cookie2 value
Throws: MalformedCookieException if an exception occurs during parsing
See Also: RFC2965Spec
Parameters: attribute NameValuePair cookie attribute from the Set-Cookie2 header. cookie Cookie to be updated
Throws: MalformedCookieException if an exception occurs during parsing
Parameters: host the host from which the Cookie was received port the port from which the Cookie was received path the path from which the Cookie was received secure true when the Cookie was received using a secure connection cookie The cookie to validate
Throws: MalformedCookieException if an exception occurs during validation