org.archive.wayback.resourceindex
Class RemoteResourceIndex

java.lang.Object
  org.archive.wayback.resourceindex.RemoteResourceIndex

All Implemented Interfaces:

ResourceIndex

public class RemoteResourceIndex
extends java.lang.Object
implements ResourceIndex

ResourceIndex implementation that relays a query to a remote index implementation over HTTP. The XMLQueryUI is assumed to be active on the remote server, and the query is sent over as-is, formulated as an OpenSearch query. Results are also returned as-is -- this class attempts to be as transparent as possible.

Version:

$Date: 2009-07-17 16:53:43 -0700 (Fri, 17 Jul 2009) $, $Revision: 2768 $

Author:

brad

Constructor Summary

RemoteResourceIndex()

Method Summary

protected void	checkDocumentForExceptions(org.w3c.dom.Document document)
protected SearchResults	documentToSearchResults(org.w3c.dom.Document document, ObjectFilter<CaptureSearchResult> filter)
UrlCanonicalizer	getCanonicalizer()
int	getConnectTimeout()
protected org.w3c.dom.Document	getFileDocument(java.io.File f)
protected org.w3c.dom.Document	getHttpDocument(java.lang.String url)
protected java.lang.String	getNodeContent(org.w3c.dom.Element e, java.lang.String key)
int	getReadTimeout()
protected org.w3c.dom.NodeList	getRequestFilters(org.w3c.dom.Document d)
protected java.lang.String	getRequestUrl(WaybackRequest wbRequest)
protected ObjectFilter<CaptureSearchResult>	getSearchResultFilters(WaybackRequest wbRequest)
protected org.w3c.dom.NodeList	getSearchResults(org.w3c.dom.Document d)
java.lang.String	getSearchUrlBase()
void	init()
SearchResults	query(WaybackRequest wbRequest) Transform a WMRequest into a ResourceResults.
void	setCanonicalizer(UrlCanonicalizer canonicalizer)
void	setConnectTimeout(int connectTimeout)
void	setReadTimeout(int readTimeout)
void	setSearchUrlBase(java.lang.String searchUrlBase)
void	shutdown()
protected SearchResults	urlToSearchResults(java.lang.String requestUrl, ObjectFilter<CaptureSearchResult> filter)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteResourceIndex

public RemoteResourceIndex()

Method Detail

init

public void init()
          throws ConfigurationException

Throws:

ConfigurationException

query

public SearchResults query(WaybackRequest wbRequest)
                    throws ResourceIndexNotAvailableException,
                           ResourceNotInArchiveException,
                           BadQueryException,
                           AccessControlException

Description copied from interface: ResourceIndex

Transform a WMRequest into a ResourceResults.

Specified by:

query in interface ResourceIndex

Returns:

ResourceResults containing ResourceResult objects matching the WMRequest

Throws:

ResourceIndexNotAvailableException

ResourceNotInArchiveException

BadQueryException

AccessControlException

urlToSearchResults

protected SearchResults urlToSearchResults(java.lang.String requestUrl,
                                           ObjectFilter<CaptureSearchResult> filter)
                                    throws ResourceIndexNotAvailableException,
                                           ResourceNotInArchiveException,
                                           BadQueryException,
                                           AccessControlException

Throws:

ResourceIndexNotAvailableException

ResourceNotInArchiveException

BadQueryException

AccessControlException

checkDocumentForExceptions

protected void checkDocumentForExceptions(org.w3c.dom.Document document)
                                   throws ResourceIndexNotAvailableException,
                                          ResourceNotInArchiveException,
                                          BadQueryException,
                                          AccessControlException

Throws:

ResourceIndexNotAvailableException

ResourceNotInArchiveException

BadQueryException

AccessControlException

getSearchResultFilters

protected ObjectFilter<CaptureSearchResult> getSearchResultFilters(WaybackRequest wbRequest)

documentToSearchResults

protected SearchResults documentToSearchResults(org.w3c.dom.Document document,
                                                ObjectFilter<CaptureSearchResult> filter)
                                         throws ResourceNotInArchiveException

Throws:

ResourceNotInArchiveException

getRequestFilters

protected org.w3c.dom.NodeList getRequestFilters(org.w3c.dom.Document d)

getSearchResults

protected org.w3c.dom.NodeList getSearchResults(org.w3c.dom.Document d)

getRequestUrl

protected java.lang.String getRequestUrl(WaybackRequest wbRequest)
                                  throws BadQueryException

Throws:

BadQueryException

getNodeContent

protected java.lang.String getNodeContent(org.w3c.dom.Element e,
                                          java.lang.String key)

getHttpDocument

protected org.w3c.dom.Document getHttpDocument(java.lang.String url)
                                        throws java.io.IOException,
                                               org.xml.sax.SAXException

Throws:

java.io.IOException

org.xml.sax.SAXException

getFileDocument

protected org.w3c.dom.Document getFileDocument(java.io.File f)
                                        throws java.io.IOException,
                                               org.xml.sax.SAXException

Throws:

java.io.IOException

org.xml.sax.SAXException

getSearchUrlBase

public java.lang.String getSearchUrlBase()

Returns:

the searchUrlBase

setSearchUrlBase

public void setSearchUrlBase(java.lang.String searchUrlBase)

Parameters:

searchUrlBase - the searchUrlBase to set

shutdown

public void shutdown()
              throws java.io.IOException

Specified by:

shutdown in interface ResourceIndex

Throws:

java.io.IOException

getCanonicalizer

public UrlCanonicalizer getCanonicalizer()

setCanonicalizer

public void setCanonicalizer(UrlCanonicalizer canonicalizer)

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

getReadTimeout

public int getReadTimeout()

setReadTimeout

public void setReadTimeout(int readTimeout)