|
| |
|
| java.lang.Object
 HTTPClient.CookieModule
| CookieModule | | public class CookieModule implements HTTPClientModule,GlobalConstants(Code) | | This module handles Netscape cookies (also called Version 0 cookies)
and Version 1 cookies. Specifically is reads the Set-Cookie
and Set-Cookie2 response headers and sets the Cookie
and Cookie2 headers as neccessary.
The accepting and sending of cookies is controlled by a
CookiePolicyHandler. This allows you to fine tune your privacy
preferences. A cookie is only added to the cookie list if the handler
allows it, and a cookie from the cookie list is only sent if the handler
allows it.
A cookie jar can be used to store cookies between sessions. This file is
read when this class is loaded and is written when the application exits;
only cookies from the default context are saved. The name of the file is
controlled by the system property HTTPClient.cookies.jar and
defaults to a system dependent name. The reading and saving of cookies is
enabled by setting the system property HTTPClient.cookies.save
to true.
See Also: Netscape's cookie spec
See Also: HTTP State Management Mechanism spec
version:
0.3-2 18/06/1999
author:
Ronald Tschalär
since:
V0.3 |
| CookieModule | | CookieModule()(Code) | | |
| addCookie | | public static void addCookie(Cookie cookie)(Code) | | Add the specified cookie to the list of cookies in the default context.
If a compatible cookie (as defined by Cookie.equals())
already exists in the list then it is replaced with the new cookie.
Parameters:
cookie - the Cookie to add
since:
V0.3-1 |
| addCookie | | public static void addCookie(Cookie cookie, Object context)(Code) | | Add the specified cookie to the list of cookies for the specified
context. If a compatible cookie (as defined by
Cookie.equals()) already exists in the list then it is
replaced with the new cookie.
Parameters:
cookie - the cookie to add
Parameters:
context - the context Object.
since:
V0.3-1 |
| discardAllCookies | | public static void discardAllCookies()(Code) | | Discard all cookies for all contexts. Cookies stored in persistent
storage are not affected.
|
| discardAllCookies | | public static void discardAllCookies(Object context)(Code) | | Discard all cookies for the given context. Cookies stored in persistent
storage are not affected.
Parameters:
context - the context Object |
| listAllCookies | | public static Cookie[] listAllCookies()(Code) | | List all stored cookies for all contexts.
an array of all Cookies
since:
V0.3-1 |
| listAllCookies | | public static Cookie[] listAllCookies(Object context)(Code) | | List all stored cookies for a given context.
Parameters:
context - the context Object. an array of Cookies
since:
V0.3-1 |
| removeCookie | | public static void removeCookie(Cookie cookie)(Code) | | Remove the specified cookie from the list of cookies in the default
context. If the cookie is not found in the list then this method does
nothing.
Parameters:
cookie - the Cookie to remove
since:
V0.3-1 |
| removeCookie | | public static void removeCookie(Cookie cookie, Object context)(Code) | | Remove the specified cookie from the list of cookies for the specified
context. If the cookie is not found in the list then this method does
nothing.
Parameters:
cookie - the cookie to remove
Parameters:
context - the context Object
since:
V0.3-1 |
| responsePhase2Handler | | public int responsePhase2Handler(Response resp, Request req)(Code) | | Invoked by the HTTPClient.
|
| responsePhase3Handler | | public void responsePhase3Handler(Response resp, RoRequest req)(Code) | | Invoked by the HTTPClient.
|
| setCookiePolicyHandler | | public static synchronized CookiePolicyHandler setCookiePolicyHandler(CookiePolicyHandler handler)(Code) | | Sets a new cookie policy handler. This handler will be called for each
cookie that a server wishes to set and for each cookie that this
module wishes to send with a request. In either case the handler may
allow or reject the operation. If you wish to blindly accept and send
all cookies then just disable the handler with
CookieModule.setCookiePolicyHandler(null);.
At initialization time a default handler is installed. This
handler allows all cookies to be sent. For any cookie that a server
wishes to be set two lists are consulted. If the server matches any
host or domain in the reject list then the cookie is rejected; if
the server matches any host or domain in the accept list then the
cookie is accepted (in that order). If no host or domain match is
found in either of these two lists and user interaction is allowed
then a dialog box is poped up to ask the user whether to accept or
reject the cookie; if user interaction is not allowed the cookie is
accepted.
The accept and reject lists in the default handler are initialized
at startup from the two properties
HTTPClient.cookies.hosts.accept and
HTTPClient.cookies.hosts.reject. These properties must
contain a "|" separated list of host and domain names. All names
beginning with a "." are treated as domain names, all others as host
names. An empty string which will match all hosts. The two lists are
further expanded if the user chooses one of the "Accept All from Domain"
or "Reject All from Domain" buttons in the dialog box.
Note: the default handler does not implement the rules concerning
unverifiable transactions (section 4.3.5,
RFC-2109).
The reason for this is simple: the default handler knows nothing
about the application using this client, and it therefore does not
have enough information to determine when a request is verifiable
and when not. You are therefore encouraged to provide your own handler
which implements section 4.3.5 (use the
CookiePolicyHandler.sendCookie method for this).
Parameters:
the - new policy handler the previous policy handler |
|
|
|