com.dkfqs.tools.http

Class HTTPCookieHandler

java.lang.Object

com.dkfqs.tools.http.HTTPCookieHandler

public class HTTPCookieHandler
extends java.lang.Object

A HTTP cookie handler for a HTTPClient instance. All methods are thread-save.

See Also:

HTTPClient.getCookieHandler()

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<java.net.HttpCookie>	domainPathNameComparator Used to sort a list of cookies first by domain, second by path and third by name (all case insensitive).

Method Summary

Modifier and Type	Method and Description
boolean	addOrReplaceCookie(java.net.HttpCookie httpCookie) Add or replace a cookie.
void	dumpToStdout() For debug purpose only, dump all cookies to stdout.
java.util.ArrayList<java.net.HttpCookie>	getAllCookies() Get all cookies.
java.util.ArrayList<java.net.HttpCookie>	getAllPermanentCookies() Get all permanent cookies (all cookies which are not session cookies).
java.net.HttpCookie	getCookie(java.lang.String cookieName, java.lang.String domain, java.lang.String path) Get a cookie selected by name, domain and path.
java.net.HttpCookie	getCookieByName(java.lang.String cookieName) Get the first matching cookie selected by name.
java.util.ArrayList<java.net.HttpCookie>	getCookiesByName(java.lang.String cookieName) Get all cookies which match to a specific cookie name.
boolean	isThirdPartyCookiesEnabled() Get if third party cookies are enabled.
void	removeAllCookies() Remove all cookies.
int	removeAllExpiredCookies() Remove all expired cookies.
int	removeAllSessionCookies() Remove all session cookies.
boolean	removeCookie(java.net.HttpCookie httpCookie) Remove a cookie.
int	removeCookiesByName(java.lang.String cookieName) Remove all cookies which match to a specific cookie name.
void	setThirdPartyCookiesEnabled(boolean thirdPartyCookiesEnabled) Enable or disable third party cookies.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

domainPathNameComparator

public static java.util.Comparator<java.net.HttpCookie> domainPathNameComparator

Used to sort a list of cookies first by domain, second by path and third by name (all case insensitive).

Method Detail

isThirdPartyCookiesEnabled

public boolean isThirdPartyCookiesEnabled()

Get if third party cookies are enabled.

Returns:

true if third party cookies are enabled

setThirdPartyCookiesEnabled

public void setThirdPartyCookiesEnabled(boolean thirdPartyCookiesEnabled)

Enable or disable third party cookies.

Parameters:

thirdPartyCookiesEnabled - true = enable third party cookies, false = disable third party cookies

addOrReplaceCookie

public boolean addOrReplaceCookie(java.net.HttpCookie httpCookie)
                           throws java.lang.IllegalArgumentException

Add or replace a cookie.

Parameters:

httpCookie - the cookie to add or to replace

Returns:

true if a new cookie is added to the cookie handler, or false if the data of an already existing cookie are replaced

Throws:

java.lang.IllegalArgumentException - if the cookie has no domain or path attribute, or if the cookie is already expired

removeCookie

public boolean removeCookie(java.net.HttpCookie httpCookie)

Remove a cookie.

Parameters:

httpCookie - the cookie to remove

Returns:

true if the cookie is removed, or false if no such cookie exists in the cookie handler

removeCookiesByName

public int removeCookiesByName(java.lang.String cookieName)

Remove all cookies which match to a specific cookie name.

Parameters:

cookieName - the name of the cookie(s)

Returns:

the number of removed cookies

removeAllExpiredCookies

public int removeAllExpiredCookies()

Remove all expired cookies.

Returns:

the number of removed cookies.

removeAllSessionCookies

public int removeAllSessionCookies()

Remove all session cookies.

Returns:

the number of removed cookies.

removeAllCookies

public void removeAllCookies()

Remove all cookies.

getAllCookies

public java.util.ArrayList<java.net.HttpCookie> getAllCookies()

Get all cookies.

Returns:

an array list of all cookies.

getAllPermanentCookies

public java.util.ArrayList<java.net.HttpCookie> getAllPermanentCookies()

Get all permanent cookies (all cookies which are not session cookies).

Returns:

an array list of all permanent cookies.

getCookiesByName

public java.util.ArrayList<java.net.HttpCookie> getCookiesByName(java.lang.String cookieName)

Get all cookies which match to a specific cookie name.

Parameters:

cookieName - the name of the cookie(s)

Returns:

an array list of all cookies which match to the specific cookie name

getCookieByName

public java.net.HttpCookie getCookieByName(java.lang.String cookieName)

Get the first matching cookie selected by name.

Parameters:

cookieName - the name of the cookie

Returns:

the first matching cookie selected by name, or null if no cookie which such a name exists

getCookie

public java.net.HttpCookie getCookie(java.lang.String cookieName,
                                     java.lang.String domain,
                                     java.lang.String path)

Get a cookie selected by name, domain and path.

Parameters:

cookieName - the name of the cookie

domain - the domain of the cookie

path - the path of the cookie

Returns:

the selected cookie, or null if no such cookie exists

dumpToStdout

public void dumpToStdout()

For debug purpose only, dump all cookies to stdout.