org.archive.wayback.liveweb

Class RemoteLiveWebCache

java.lang.Object

org.archive.wayback.liveweb.RemoteLiveWebCache

All Implemented Interfaces:

LiveWebCache

Direct Known Subclasses:

LiveRobotsNoCache

public class RemoteLiveWebCache
extends Object
implements LiveWebCache

Author:

brad

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	http
protected String	requestPrefix

Constructor Summary

Constructors

Constructor and Description
RemoteLiveWebCache()

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.
int	getConnectionTimeoutMS()
org.apache.commons.httpclient.HttpClient	getHttpClient()
int	getMaxHostConnections()
int	getMaxTotalConnections()
String	getRequestPrefix()
int	getSocketTimeoutMS()
void	setConnectionTimeoutMS(int connectionTimeoutMS)
void	setMaxHostConnections(int maxHostConnections)
void	setMaxTotalConnections(int maxTotalConnections)
void	setProxyHostPort(String hostPort)
void	setRequestPrefix(String requestPrefix)
void	setSocketTimeoutMS(int socketTimeoutMS)
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

http

protected org.apache.commons.httpclient.HttpClient http

requestPrefix

protected String requestPrefix

Constructor Detail

RemoteLiveWebCache

public RemoteLiveWebCache()

Method Detail

getCachedResource

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

Description copied from interface: LiveWebCache

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

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

shutdown

public void shutdown()

Description copied from interface: LiveWebCache

closes all resources

Specified by:

shutdown in interface LiveWebCache

setProxyHostPort

public void setProxyHostPort(String hostPort)

Parameters:

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

setMaxTotalConnections

public void setMaxTotalConnections(int maxTotalConnections)

Parameters:

maxTotalConnections - the HttpConnectionManagerParams config

getMaxTotalConnections

public int getMaxTotalConnections()

Returns:

the HttpConnectionManagerParams maxTotalConnections config

setMaxHostConnections

public void setMaxHostConnections(int maxHostConnections)

Parameters:

maxHostConnections - the HttpConnectionManagerParams config

getMaxHostConnections

public int getMaxHostConnections()

Returns:

the HttpConnectionManagerParams maxHostConnections config

getConnectionTimeoutMS

public int getConnectionTimeoutMS()

Returns:

the connectionTimeoutMS

setConnectionTimeoutMS

public void setConnectionTimeoutMS(int connectionTimeoutMS)

Parameters:

connectionTimeoutMS - the connectionTimeoutMS to set

getSocketTimeoutMS

public int getSocketTimeoutMS()

Returns:

the socketTimeoutMS

setSocketTimeoutMS

public void setSocketTimeoutMS(int socketTimeoutMS)

Parameters:

socketTimeoutMS - the socketTimeoutMS to set

getRequestPrefix

public String getRequestPrefix()

setRequestPrefix

public void setRequestPrefix(String requestPrefix)

getHttpClient

public org.apache.commons.httpclient.HttpClient getHttpClient()