org.archive.wayback.replay

Class TextDocument

java.lang.Object

org.archive.wayback.replay.TextDocument

public class TextDocument
extends Object

Class which wraps functionality for converting a Resource(InputStream + HTTP headers) into a StringBuilder, performing several common URL resolution methods against that StringBuilder, inserting arbitrary Strings into the page, and then converting the page back to a byte array.

Version:

$Date$, $Revision$

Author:

brad

Field Summary

Fields

Modifier and Type	Field and Description
StringBuilder	sb the internal StringBuilder

Constructor Summary

Constructors

Constructor and Description
TextDocument(Resource resource, CaptureSearchResult result, ResultURIConverter uriConverter)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBase()
byte[]	getBytes()
String	getCharSet()
String	getJSIncludeString(String jsUrl)
String	includeJspString(String jspPath, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, WaybackRequest wbRequest, CaptureSearchResults results, CaptureSearchResult result, Resource resource)
void	insertAtEndOfBody(CharSequence toInsert)
void	insertAtEndOfDocument(CharSequence charSequence)
void	insertAtStartOfBody(CharSequence toInsert)
void	insertAtStartOfDocument(CharSequence toInsert) insert toInsert at the beginning of this text.
void	insertAtStartOfHead(CharSequence toInsert)
void	readFully() Read bytes from input stream, using best-guess for character encoding
void	readFully(String charSet)
void	resolveAllPageUrls() Update all URLs inside the page, so they resolve correctly to absolute URLs within the Wayback service.
void	resolveASXRefUrls()
void	resolveCSSUrls()
void	resolvePageUrls() Update URLs inside the page, so those URLs which must be correct at page load time resolve correctly to absolute URLs.
void	setCharSet(String charSet)
void	setResultBytes(byte[] resultBytes)
void	stripHTML()
void	writeToOutputStream(OutputStream os) Write the contents of the page to the client.

Methods inherited from class java.lang.Object

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

Field Detail

sb

public StringBuilder sb

the internal StringBuilder

Constructor Detail

TextDocument

public TextDocument(Resource resource,
            CaptureSearchResult result,
            ResultURIConverter uriConverter)

Parameters:

resource -

result -

uriConverter -

Method Detail

addBase

public void addBase()

resolvePageUrls

public void resolvePageUrls()

Update URLs inside the page, so those URLs which must be correct at page load time resolve correctly to absolute URLs. This means ensuring there is a BASE HREF tag, adding one if missing, and then resolving: FRAME-SRC, META-URL, LINK-HREF, SCRIPT-SRC tag-attribute pairs against either the existing BASE-HREF, or the page's absolute URL if it was missing.

resolveAllPageUrls

public void resolveAllPageUrls()

Update all URLs inside the page, so they resolve correctly to absolute URLs within the Wayback service.

resolveCSSUrls

public void resolveCSSUrls()

resolveASXRefUrls

public void resolveASXRefUrls()

stripHTML

public void stripHTML()

readFully

public void readFully(String charSet)
               throws IOException

Parameters:

charSet -

Throws:

IOException

readFully

public void readFully()
               throws IOException

Read bytes from input stream, using best-guess for character encoding

Throws:

IOException

getBytes

public byte[] getBytes()
                throws UnsupportedEncodingException

Returns:

raw bytes contained in internal StringBuilder

Throws:

UnsupportedEncodingException

setResultBytes

public void setResultBytes(byte[] resultBytes)

writeToOutputStream

public void writeToOutputStream(OutputStream os)
                         throws IOException

Write the contents of the page to the client.

Parameters:

os -

Throws:

IOException

insertAtStartOfDocument

public final void insertAtStartOfDocument(CharSequence toInsert)

insert toInsert at the beginning of this text.

Parameters:

toInsert -

insertAtEndOfDocument

public void insertAtEndOfDocument(CharSequence charSequence)

Parameters:

charSequence -

insertAtStartOfHead

public void insertAtStartOfHead(CharSequence toInsert)

Parameters:

toInsert -

insertAtEndOfBody

public void insertAtEndOfBody(CharSequence toInsert)

Parameters:

toInsert -

insertAtStartOfBody

public void insertAtStartOfBody(CharSequence toInsert)

Parameters:

toInsert -

includeJspString

public String includeJspString(String jspPath,
                      javax.servlet.http.HttpServletRequest httpRequest,
                      javax.servlet.http.HttpServletResponse httpResponse,
                      WaybackRequest wbRequest,
                      CaptureSearchResults results,
                      CaptureSearchResult result,
                      Resource resource)
                        throws javax.servlet.ServletException,
                               IOException

Parameters:

jspPath -

httpRequest -

httpResponse -

wbRequest -

results -

result -

resource -

Returns:

Throws:

IOException

javax.servlet.ServletException

getJSIncludeString

public String getJSIncludeString(String jsUrl)

Parameters:

jsUrl - The javascript URL to be wrapped

Returns:

A <script> tag containing the provided javascript URL.

getCharSet

public String getCharSet()

Returns:

the charSet

setCharSet

public void setCharSet(String charSet)

Parameters:

charSet - the charSet to set