org.archive.wayback

Interface ReplayRenderer

All Known Implementing Classes:

ArchivalUrlASXReplayRenderer, ArchivalUrlCSSReplayRenderer, ArchivalUrlDateRedirectReplayRenderer, ArchivalUrlJSReplayRenderer, ArchivalURLJSStringTransformerReplayRenderer, ArchivalUrlSAXRewriteReplayRenderer, ClientSideHTMLReplayRenderer, DateRedirectReplayRenderer, DomainPrefixTextReplayRenderer, JSPReplayRenderer, ProxyHTMLMarkupReplayRenderer, ReplayRendererDecorator, ServerSideHTMLReplayRenderer, SWFReplayRenderer, TextReplayRenderer, TransparentReplayRenderer

public interface ReplayRenderer

ReplayRenderer generates response that replays archived content. It may apply some transformations (often called rewrite) to the content so that:

• replay page has navigation user interface etc.
• clicking hyperlinks makes another replay requests rather than jumping to the live web.

Author:

brad

See Also:

QueryRenderer

Method Summary

Methods

Modifier and Type	Method and Description
void	renderResource(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, WaybackRequest wbRequest, CaptureSearchResult result, Resource httpHeadersResource, Resource payloadResource, ResultURIConverter uriConverter, CaptureSearchResults results) Generate response that replays capture archive httpHeadersResource, reading archived content (HTTP entity) from payloadResource.
void	renderResource(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, WaybackRequest wbRequest, CaptureSearchResult result, Resource resource, ResultURIConverter uriConverter, CaptureSearchResults results) Generate response that replays capture archive resource.

Method Detail

renderResource

void renderResource(javax.servlet.http.HttpServletRequest httpRequest,
                  javax.servlet.http.HttpServletResponse httpResponse,
                  WaybackRequest wbRequest,
                  CaptureSearchResult result,
                  Resource resource,
                  ResultURIConverter uriConverter,
                  CaptureSearchResults results)
                    throws javax.servlet.ServletException,
                           IOException,
                           WaybackException

Generate response that replays capture archive resource.

Parameters:

httpRequest - the HttpServletRequest

httpResponse - the HttpServletResponse

wbRequest - the WaybackRequest that returned the results

result - actual CaptureSearchResult that maps to resource to replay

resource - resource to replay

uriConverter - the URI converter to use to translate matching results into replayable URLs

results - all CaptureSearchResults that were returned from the ResourceIndex, probably including other capture dates of the same URL.

Throws:

javax.servlet.ServletException - per usual

IOException - per usual

WaybackException - if Wayback data specific, anticipated exceptions occur

renderResource

void renderResource(javax.servlet.http.HttpServletRequest httpRequest,
                  javax.servlet.http.HttpServletResponse httpResponse,
                  WaybackRequest wbRequest,
                  CaptureSearchResult result,
                  Resource httpHeadersResource,
                  Resource payloadResource,
                  ResultURIConverter uriConverter,
                  CaptureSearchResults results)
                    throws javax.servlet.ServletException,
                           IOException,
                           WaybackException

Generate response that replays capture archive httpHeadersResource, reading archived content (HTTP entity) from payloadResource.

Parameters:

httpRequest - the HttpServletRequest

httpResponse - the HttpServletResponse

wbRequest - the WaybackRequest that returned the results

result - CaptureSearchResult that maps to resource to replay

httpHeadersResource - resource with HTTP headers to replay (typically a revisit record.)

payloadResource - resource with payload to replay

uriConverter - the URI converter to use to translate matching results into replayable URLs

results - all CaptureSearchResults that were returned from the ResourceIndex, probably including other capture dates of the same URL.

Throws:

javax.servlet.ServletException - per usual

IOException - per usual

WaybackException - if Wayback data specific, anticipated exceptions occur