com.screenscraper.http

Class BasicCookieManager

java.lang.Object

com.screenscraper.http.BasicCookieManager

public class BasicCookieManager
extends java.lang.Object

Basic Cookie Manager

Since:

7.0.9a

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
BasicCookieManager() Creates the cookie manager

Method Summary

Modifier and Type	Method and Description
void	clearAllCookies() Clears all the cookies from the manager
java.util.Set<ScrapingCookie>	getAllCookies() Returns a set of all cookies currently in the manager (these may include expired cookies)
java.util.Set<ScrapingCookie>	getCookies(java.util.List<java.lang.String> domainPath, java.lang.String path, boolean includeUnspecifiedCookies, boolean includeSecure) Returns a set of cookies for the current domain.
java.util.Set<ScrapingCookie>	getCookies(java.lang.String domain, java.lang.String path, boolean includeUnspecifiedCookies, boolean includeSecure) Returns a set of cookies for the current domain.
boolean	isAutoTrimOldCookies() Returns the AutoTrimOldCookies for the object
void	setAutoTrimOldCookies(boolean autoTrimOldCookies) Sets the AutoTrimOldCookies for the object
void	trimOldCookies() Trims the data structure to remove old cookies
void	updateCookies(java.net.URL url, java.util.List<ScrapingCookie> cookies) Updates the cookie manager with cookies given

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicCookieManager

public BasicCookieManager()

Creates the cookie manager

Method Detail

isAutoTrimOldCookies

public boolean isAutoTrimOldCookies()

Returns the AutoTrimOldCookies for the object

Returns:

The AutoTrimOldCookies for the object

setAutoTrimOldCookies

public void setAutoTrimOldCookies(boolean autoTrimOldCookies)

Sets the AutoTrimOldCookies for the object

Parameters:

autoTrimOldCookies - The new value for AutoTrimOldCookies

updateCookies

public void updateCookies(@Nullable
                          java.net.URL url,
                          @NotNull
                          java.util.List<ScrapingCookie> cookies)

Updates the cookie manager with cookies given

Parameters:

url - The url for the request that got these cookies as a response

cookies - The cookies to add

getAllCookies

public java.util.Set<ScrapingCookie> getAllCookies()

Returns a set of all cookies currently in the manager (these may include expired cookies)

Returns:

A set of all cookies currently in the manager

trimOldCookies

public void trimOldCookies()

Trims the data structure to remove old cookies

clearAllCookies

public void clearAllCookies()

Clears all the cookies from the manager

getCookies

public java.util.Set<ScrapingCookie> getCookies(@NotNull
                                                java.lang.String domain,
                                                @NotNull
                                                java.lang.String path,
                                                boolean includeUnspecifiedCookies,
                                                boolean includeSecure)

Returns a set of cookies for the current domain.

Parameters:

domain - The domain for which to get cookies

path - The path for the cookies

includeUnspecifiedCookies - True if we want cookies that are to be sent with a request but don't indicate secure or not secure only

includeSecure - True if we want cookies that are to be sent with a secure request

Returns:

The set of cookies to include

getCookies

public java.util.Set<ScrapingCookie> getCookies(@NotNull
                                                java.util.List<java.lang.String> domainPath,
                                                @NotNull
                                                java.lang.String path,
                                                boolean includeUnspecifiedCookies,
                                                boolean includeSecure)

Returns a set of cookies for the current domain.

Parameters:

domainPath - The domain for which to get cookies (such as ["www", "google", "com"])

path - The path for the cookies, inside the domain

includeUnspecifiedCookies - True if we want cookies that are to be sent with a request but don't indicate secure or not secure only

includeSecure - True if we want cookies that are to be sent with a secure request

Returns:

The set of cookies to include