org.archive.wayback.liveweb

Interface LiveWebCache

All Known Implementing Classes:

LiveRobotsNoCache, RedisRefresher, RemoteLiveWebCache, SimpleRedisRobotsCache

public interface LiveWebCache

Interface to retrieve Resource objects from the live web.

Version:

$Date$, $Revision$

Author:

brad

Method Summary

Methods

Modifier and Type	Method and Description
Resource	getCachedResource(URL url, long maxCacheMS, boolean bUseOlder) Fetch a Resource from the live web, or from a cache of the live web.
void	shutdown() closes all resources

Method Detail

getCachedResource

Resource getCachedResource(URL url,
                         long maxCacheMS,
                         boolean bUseOlder)
                           throws LiveDocumentNotAvailableException,
                                  LiveWebCacheUnavailableException,
                                  LiveWebTimeoutException,
                                  IOException

Fetch a Resource from the live web, or from a cache of the live web.

Parameters:

url - to fetch from the live web.

maxCacheMS - maximum age of resource to return - optionally honored

bUseOlder - if true, return documents older than maxCacheMS if a more recent copy is not available.

Returns:

Resource for url

Throws:

LiveDocumentNotAvailableException - if the resource cannot be retrieved from the live web, but all proxying and caching mechanisms functioned properly

LiveWebCacheUnavailableException - if there was a problem either accessing the live web, in proxying to the live web, or in maintaining the cache for the live web

LiveWebTimeoutException - if there is no response from the live web cache before a timeout occurred.

IOException - for the usual reasons

shutdown

void shutdown()

closes all resources