com.screenscraper.http

Class AsyncNingCookieManager

java.lang.Object

com.screenscraper.http.AsyncNingCookieManager

public class AsyncNingCookieManager
extends java.lang.Object

Cookie Manager for use with the AsyncNingHttpClient

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
AsyncNingCookieManager() Creates the cookie manager

Method Summary

Modifier and Type	Method and Description
void	addCookiesToRequest(com.ning.http.client.RequestBuilderBase<?> base) Deprecated.
void	addCookiesToRequest(java.lang.String url, com.ning.http.client.RequestBuilderBase<?> base) Adds the cookies to the request
void	clearAllCookies() Clears all the cookies from the manager
java.util.Set<com.ning.http.client.cookie.Cookie>	getAllCookies() Returns a set of all cookies currently in the manager (these may include expired cookies)
java.util.Set<com.ning.http.client.cookie.Cookie>	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<com.ning.http.client.cookie.Cookie>	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(com.ning.http.client.Response response) Updates the cookie manager with cookies from the response
void	updateCookies(com.ning.http.client.uri.Uri uri, java.util.List<com.ning.http.client.cookie.Cookie> 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

AsyncNingCookieManager

public AsyncNingCookieManager()

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

addCookiesToRequest

@Deprecated
public void addCookiesToRequest(@NotNull
                                             com.ning.http.client.RequestBuilderBase<?> base)

Deprecated.

Adds the cookies to the request

Parameters:

base - The base request

addCookiesToRequest

public void addCookiesToRequest(@NotNull
                                java.lang.String url,
                                @NotNull
                                com.ning.http.client.RequestBuilderBase<?> base)

Adds the cookies to the request

Parameters:

url - The url to add cookies for (previously tried deriving this from the request base, but that caused some issues

base - The base request

updateCookies

public void updateCookies(@NotNull
                          com.ning.http.client.Response response)

Updates the cookie manager with cookies from the response

Parameters:

response - The response received from the server

updateCookies

public void updateCookies(@Nullable
                          com.ning.http.client.uri.Uri uri,
                          @NotNull
                          java.util.List<com.ning.http.client.cookie.Cookie> cookies)

Updates the cookie manager with cookies given

Parameters:

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

cookies - The cookies to add

getAllCookies

public java.util.Set<com.ning.http.client.cookie.Cookie> 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<com.ning.http.client.cookie.Cookie> 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<com.ning.http.client.cookie.Cookie> 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