org.archive.wayback.replay
Class TextReplayRenderer

java.lang.Object
  org.archive.wayback.replay.TextReplayRenderer

All Implemented Interfaces:

ReplayRenderer

Direct Known Subclasses:

ArchivalUrlASXReplayRenderer, ArchivalUrlCSSReplayRenderer, ArchivalUrlJSReplayRenderer, ClientSideHTMLReplayRenderer, DomainPrefixTextReplayRenderer, MementoHTMLReplayRenderer, ProxyHTMLMarkupReplayRenderer, ServerSideHTMLReplayRenderer

public abstract class TextReplayRenderer
extends Object
implements ReplayRenderer

Version:

$Date: 2010-09-29 05:28:38 +0700 (Wed, 29 Sep 2010) $, $Revision: 3262 $

Author:

brad

Field Summary

static String

GUESSED_CHARSET_HEADER

Constructor Summary

TextReplayRenderer(HttpHeaderProcessor httpHeaderProcessor)

Method Summary

CharsetDetector	getCharsetDetector()
String	getGuessedCharsetHeader()
List<String>	getJspInserts()
void	renderResource(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, WaybackRequest wbRequest, CaptureSearchResult result, Resource resource, ResultURIConverter uriConverter, CaptureSearchResults results) return a resource to the user.
void	setCharsetDetector(CharsetDetector charsetDetector)
void	setGuessedCharsetHeader(String guessedCharsetHeader)
void	setJspInserts(List<String> jspInserts)
protected abstract void	updatePage(TextDocument page, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, WaybackRequest wbRequest, CaptureSearchResult result, Resource resource, ResultURIConverter uriConverter, CaptureSearchResults results)

Methods inherited from class java.lang.Object

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

Field Detail

GUESSED_CHARSET_HEADER

public static String GUESSED_CHARSET_HEADER

Constructor Detail

TextReplayRenderer

public TextReplayRenderer(HttpHeaderProcessor httpHeaderProcessor)

Method Detail

updatePage

protected abstract void updatePage(TextDocument page,
                                   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

Throws:

javax.servlet.ServletException

IOException

renderResource

public 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,
                           BadContentException

Description copied from interface: ReplayRenderer

return a resource to the user.

Specified by:

renderResource in interface ReplayRenderer

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

BadContentException

getJspInserts

public List<String> getJspInserts()

Returns:

the jspInserts

setJspInserts

public void setJspInserts(List<String> jspInserts)

Parameters:

jspInserts - the jspInserts to set

getCharsetDetector

public CharsetDetector getCharsetDetector()

Returns:

the charsetDetector

setCharsetDetector

public void setCharsetDetector(CharsetDetector charsetDetector)

Parameters:

charsetDetector - the charsetDetector to set

getGuessedCharsetHeader

public String getGuessedCharsetHeader()

Returns:

the String HTTP Header used to indicate what Wayback determined was the pages original charset

setGuessedCharsetHeader

public void setGuessedCharsetHeader(String guessedCharsetHeader)

Parameters:

guessedCharsetHeader - the String HTTP Header value used to indicate to clients what Wayback determined was the pages original charset. If set to null, the header will be omitted.