org.archive.wayback.liveweb

Class StdRemoteLiveWebCache

java.lang.Object

org.archive.wayback.liveweb.StdRemoteLiveWebCache

All Implemented Interfaces:

LiveWebCache

public class StdRemoteLiveWebCache
extends Object
implements LiveWebCache

This class fetches resource from live web. It works with standard proxy server e.g. Squid.

Author:

Mohamed Elsayed

See Also:

LiveWebCache, ArcRemoteLiveWebCache

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.httpclient.MultiThreadedHttpConnectionManager	connectionManager
protected org.apache.commons.httpclient.HostConfiguration	hostConfiguration
protected org.apache.commons.httpclient.HttpClient	httpClient
protected String	requestPrefix

Constructor Summary

Constructors

Constructor and Description
StdRemoteLiveWebCache() StdRemoteLiveWebCache constructor initializes and configures connection objects.

Method Summary

Modifier and Type	Method and Description
Resource	getCachedResource(URL url, long maxCacheMS, boolean bUseOlder) Gets resource object from the live web.
void	setProxyHostPort(String hostPort) Sets proxy and port (proxy:port).
void	shutdown() closes all resources

Methods inherited from class java.lang.Object

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

Field Detail

connectionManager

protected org.apache.commons.httpclient.MultiThreadedHttpConnectionManager connectionManager

hostConfiguration

protected org.apache.commons.httpclient.HostConfiguration hostConfiguration

httpClient

protected org.apache.commons.httpclient.HttpClient httpClient

requestPrefix

protected String requestPrefix

Constructor Detail

StdRemoteLiveWebCache

public StdRemoteLiveWebCache()

StdRemoteLiveWebCache constructor initializes and configures connection objects.

Method Detail

getCachedResource

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

Gets resource object from the live web. Configure timeout to 10 seconds.

Specified by:

getCachedResource in interface LiveWebCache

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

See Also:

LiveWebCache.getCachedResource(java.net.URL, long, boolean)

setProxyHostPort

public void setProxyHostPort(String hostPort)

Sets proxy and port (proxy:port).

Parameters:

hostPort - to proxy requests through - ex. "localhost:3128"

shutdown

public void shutdown()

Description copied from interface: LiveWebCache

closes all resources

Specified by:

shutdown in interface LiveWebCache

See Also:

LiveWebCache.shutdown()