org.archive.modules.fetcher

Class AbstractCookieStorage

java.lang.Object

org.archive.modules.fetcher.AbstractCookieStorage

All Implemented Interfaces:

Closeable, AutoCloseable, CookieStorage, org.springframework.context.Lifecycle

Direct Known Subclasses:

BdbCookieStorage, SimpleCookieStorage

public abstract class AbstractCookieStorage
extends Object
implements CookieStorage, org.springframework.context.Lifecycle, Closeable

Author:

pjack

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigFile	cookiesLoadFile
protected ConfigPath	cookiesSaveFile
protected boolean	isRunning

Constructor Summary

Constructors

Constructor and Description
AbstractCookieStorage()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
ConfigFile	getCookiesLoadFile()
abstract SortedMap<String,Cookie>	getCookiesMap()
ConfigPath	getCookiesSaveFile()
protected abstract void	innerSaveCookiesMap(Map<String,Cookie> map)
boolean	isRunning()
protected static void	loadCookies(ConfigFile file, SortedMap<String,Cookie> cookies)
static void	loadCookies(Reader reader, SortedMap<String,Cookie> cookies) Load cookies.
static void	loadCookies(String cookiesFile, SortedMap<String,Cookie> result)
protected abstract SortedMap<String,Cookie>	prepareMap()
static void	saveCookies(String saveCookiesFile, Map<String,Cookie> cookies)
void	saveCookiesMap(Map<String,Cookie> map)
void	setCookiesLoadFile(ConfigFile cookiesLoadFile)
void	setCookiesSaveFile(ConfigPath cookiesSaveFile)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

cookiesLoadFile

protected ConfigFile cookiesLoadFile

cookiesSaveFile

protected ConfigPath cookiesSaveFile

isRunning

protected boolean isRunning

Constructor Detail

AbstractCookieStorage

public AbstractCookieStorage()

Method Detail

getCookiesLoadFile

public ConfigFile getCookiesLoadFile()

setCookiesLoadFile

public void setCookiesLoadFile(ConfigFile cookiesLoadFile)

getCookiesSaveFile

public ConfigPath getCookiesSaveFile()

setCookiesSaveFile

public void setCookiesSaveFile(ConfigPath cookiesSaveFile)

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

prepareMap

protected abstract SortedMap<String,Cookie> prepareMap()

loadCookies

public static void loadCookies(Reader reader,
               SortedMap<String,Cookie> cookies)

Load cookies. The input is text in the Netscape's 'cookies.txt' file format. Example entry of cookies.txt file:

www.archive.org FALSE / FALSE 1311699995 details-visit texts-cralond

Each line has 7 tab-separated fields:

1. DOMAIN: The domain that created and have access to the cookie value.
2. FLAG: A TRUE or FALSE value indicating if hosts within the given domain can access the cookie value.
3. PATH: The path within the domain that the cookie value is valid for.
4. SECURE: A TRUE or FALSE value indicating if to use a secure connection to access the cookie value.
5. EXPIRATION: The expiration time of the cookie value, or -1 for no expiration
6. NAME: The name of the cookie value
7. VALUE: The cookie value

Parameters:

reader - input

cookiesFile - file in the Netscape's 'cookies.txt' format.

loadCookies

protected static void loadCookies(ConfigFile file,
               SortedMap<String,Cookie> cookies)

loadCookies

public static void loadCookies(String cookiesFile,
               SortedMap<String,Cookie> result)

saveCookies

public static void saveCookies(String saveCookiesFile,
               Map<String,Cookie> cookies)

getCookiesMap

public abstract SortedMap<String,Cookie> getCookiesMap()

Specified by:

getCookiesMap in interface CookieStorage

saveCookiesMap

public void saveCookiesMap(Map<String,Cookie> map)

Specified by:

saveCookiesMap in interface CookieStorage

innerSaveCookiesMap

protected abstract void innerSaveCookiesMap(Map<String,Cookie> map)

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException