org.archive.wayback.replay

Class TextReplayRenderer

java.lang.Object

org.archive.wayback.replay.TextReplayRenderer

All Implemented Interfaces:

ReplayRenderer

Direct Known Subclasses:

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

public abstract class TextReplayRenderer
extends Object
implements ReplayRenderer

ReplayRenderer for rewriting textual resource with TextDocument.

Resource is first decoded (if Transfer-Encoding is applied), and fully loaded into TextDocument object. Then updatePage(org.archive.wayback.replay.TextDocument, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.archive.wayback.core.WaybackRequest, org.archive.wayback.core.CaptureSearchResult, org.archive.wayback.core.Resource, org.archive.wayback.ResultURIConverter, org.archive.wayback.core.CaptureSearchResults) method is called for actual rewrite. Then updated content is sent to the response.

Customization Properties:

• jspInserts: a list of Servlets for annotation inserts. It is updatePage's responsibility to perform actual insertion.
• charsetDetector: CharsetDetector for detecting resource's charset. Default is StandardCharsetDetector.
• httpHeaderProcessor (constructor arg): HttpHeaderProcessor for rewriting resource's HTTP headers.
• guessedCharsetHeader: name of response HTTP header for sending out resource's charset detected by charsetDetector. Default is GUESSED_CHARSET_HEADER.
• pageURIConverterFactory: You can use different URI conversion just for TextDocument and {#updatePage} by setting this property to non-null ContextResultURIConverterFactory. It does not affect URI conversion for HTTP headers.

Author:

brad

Field Summary

Fields

Modifier and Type	Field and Description
static String	GUESSED_CHARSET_HEADER
static String	ORIG_ENCODING

Constructor Summary

Constructors

Constructor and Description
TextReplayRenderer(HttpHeaderProcessor httpHeaderProcessor)

Method Summary

Methods

Modifier and Type	Method and Description
protected CharSequence	buildInsertText(TextDocument page, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, WaybackRequest wbRequest, CaptureSearchResults results, CaptureSearchResult result, Resource resource) return text to insert.
static Resource	decodeResource(Resource resource)
static Resource	decodeResource(Resource headersResource, Resource payloadResource) return gzip-decoding wrapper Resource if Resource has Content-Encoding: gzip.
CharsetDetector	getCharsetDetector()
String	getGuessedCharsetHeader()
List<String>	getJspInserts()
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.
void	setCharsetDetector(CharsetDetector charsetDetector)
void	setGuessedCharsetHeader(String guessedCharsetHeader)
void	setJspInserts(List<String> jspInserts)
void	setPageURIConverterFactory(ContextResultURIConverterFactory pageConverterFactory) set ContextResultURIConverterFactory that creates replacement ResultURIConverter for this TextReplayRenderer.
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

ORIG_ENCODING

public static String ORIG_ENCODING

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

Generate response that replays capture archive resource.

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

renderResource

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

Description copied from interface: ReplayRenderer

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

Specified by:

renderResource in interface ReplayRenderer

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

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.

decodeResource

public static Resource decodeResource(Resource resource)
                               throws IOException

Throws:

IOException

decodeResource

public static Resource decodeResource(Resource headersResource,
                      Resource payloadResource)
                               throws IOException

return gzip-decoding wrapper Resource if Resource has Content-Encoding: gzip. return payloadResource otherwise.

if headerResource's content is gzip-compressed (i.e. Content-Encoding is "gzip"), return a wrapping Resource that returns decoded content.

As a side-effect, Content-Encoding and Transfer-Encoding headers are removed from headersResource (this happens only when headerResoruce is gzip-compressed.). It is assumed that headerResource and payloadResource are captures of identical response content.

TODO: XArchiveHttpHeaderProcessor also does HTTP header removal. Check for refactoring case.

Parameters:

headersResource - Resource to read HTTP headers from.

payloadResource - Resource to read content from (same as headerResource for regular captures, different Resource if headersResource is a revisit record.)

Returns:

The decoded Resource.

Throws:

IOException

setPageURIConverterFactory

public void setPageURIConverterFactory(ContextResultURIConverterFactory pageConverterFactory)

set ContextResultURIConverterFactory that creates replacement ResultURIConverter for this TextReplayRenderer. If set to non-null, its getContextConverter method will be called with replayURIPrefix. If the method returns non-null, it will be passed to updatePage(org.archive.wayback.replay.TextDocument, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.archive.wayback.core.WaybackRequest, org.archive.wayback.core.CaptureSearchResult, org.archive.wayback.core.Resource, org.archive.wayback.ResultURIConverter, org.archive.wayback.core.CaptureSearchResults) instead of the original.

Parameters:

pageConverterFactory - ContextResultURIConverterFactory

buildInsertText

protected CharSequence buildInsertText(TextDocument page,
                           javax.servlet.http.HttpServletRequest httpRequest,
                           javax.servlet.http.HttpServletResponse httpResponse,
                           WaybackRequest wbRequest,
                           CaptureSearchResults results,
                           CaptureSearchResult result,
                           Resource resource)
                                throws IOException,
                                       javax.servlet.ServletException

return text to insert.

jspInserts are executed in sequence, concatenating their output.

Parameters:

page - for calling includeJspString method

httpRequest - incoming request

httpResponse - outgoing response

wbRequest - wayback request info

results - captures

result - capture being replayed

resource - resource being replayed

Returns:

concatenated output of jspInserts (empty if no jspInserts is configured.)

Throws:

IOException - error from TextDocument.includeJspString(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.archive.wayback.core.WaybackRequest, org.archive.wayback.core.CaptureSearchResults, org.archive.wayback.core.CaptureSearchResult, org.archive.wayback.core.Resource)

javax.servlet.ServletException - error from TextDocument.includeJspString(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.archive.wayback.core.WaybackRequest, org.archive.wayback.core.CaptureSearchResults, org.archive.wayback.core.CaptureSearchResult, org.archive.wayback.core.Resource)