Menu
▾
▴
[Archive-access-cvs] SF.net SVN: archive-access:[2918] trunk/archive-access/projects/wayback/ wayback-core/src/main/java/org/archive/wayback/archivalurl
|
From: <bra...@us...> - 2009-11-08 01:59:41
|
Revision: 2918
http://archive-access.svn.sourceforge.net/archive-access/?rev=2918&view=rev
Author: bradtofel
Date: 2009-11-08 01:59:29 +0000 (Sun, 08 Nov 2009)
Log Message:
-----------
JAVADOC: updated javadoc for public methods
Modified Paths:
--------------
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlASXReplayRenderer.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlCSSReplayRenderer.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlContextResultURIConverterFactory.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlJSReplayRenderer.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlRequestParser.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlSAXRewriteReplayRenderer.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlSpecialContextResultURIConverter.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ClientSideHTMLReplayRenderer.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ServerSideHTMLReplayRenderer.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathDatePrefixQueryRequestParser.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathDateRangeQueryRequestParser.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathPrefixDatePrefixQueryRequestParser.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathPrefixDateRangeQueryRequestParser.java
trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/ReplayRequestParser.java
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlASXReplayRenderer.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlASXReplayRenderer.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlASXReplayRenderer.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -39,10 +39,14 @@
import org.archive.wayback.replay.TextReplayRenderer;
import org.archive.wayback.replay.HttpHeaderProcessor;
+/**
+ * @author brad
+ *
+ */
public class ArchivalUrlASXReplayRenderer extends TextReplayRenderer {
/**
- * @param httpHeaderProcessor
+ * @param httpHeaderProcessor which should process HTTP headers
*/
public ArchivalUrlASXReplayRenderer(HttpHeaderProcessor httpHeaderProcessor) {
super(httpHeaderProcessor);
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlCSSReplayRenderer.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlCSSReplayRenderer.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlCSSReplayRenderer.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -41,10 +41,16 @@
import org.archive.wayback.replay.TextReplayRenderer;
import org.archive.wayback.replay.HttpHeaderProcessor;
+/**
+ * ReplayRenderer which attempts to rewrite URLs found within a text/css
+ * document to load from this context.
+ * @author brad
+ *
+ */
public class ArchivalUrlCSSReplayRenderer extends TextReplayRenderer {
/**
- * @param httpHeaderProcessor
+ * @param httpHeaderProcessor which should process HTTP headers
*/
public ArchivalUrlCSSReplayRenderer(HttpHeaderProcessor httpHeaderProcessor) {
super(httpHeaderProcessor);
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlContextResultURIConverterFactory.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlContextResultURIConverterFactory.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlContextResultURIConverterFactory.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -29,12 +29,17 @@
import org.archive.wayback.replay.html.ContextResultURIConverterFactory;
/**
+ * Factory which creates a context specific ArchivalUrlResultURIConverter,
+ * given a base ArchivalUrlResultURIConverter and the flags to add.
* @author brad
*
*/
public class ArchivalUrlContextResultURIConverterFactory
implements ContextResultURIConverterFactory {
private ArchivalUrlResultURIConverter converter = null;
+ /**
+ * @param converter base ArchivalURLURLConverter to wrap
+ */
public ArchivalUrlContextResultURIConverterFactory(
ArchivalUrlResultURIConverter converter) {
this.converter = converter;
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlJSReplayRenderer.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlJSReplayRenderer.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlJSReplayRenderer.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -45,15 +45,17 @@
import org.archive.wayback.util.Timestamp;
/**
+ * ReplayRenderer which attempts to rewrite absolute URLs within a
+ * text/javascript document to make them load correctly from an ArchivalURL
+ * AccessPoint.
*
- *
* @author brad
* @version $Date$, $Revision$
*/
public class ArchivalUrlJSReplayRenderer extends TextReplayRenderer {
/**
- * @param httpHeaderProcessor
+ * @param httpHeaderProcessor which should process HTTP headers
*/
public ArchivalUrlJSReplayRenderer(
HttpHeaderProcessor httpHeaderProcessor) {
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlRequestParser.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlRequestParser.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlRequestParser.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -42,10 +42,26 @@
* @version $Date$, $Revision$
*/
public class ArchivalUrlRequestParser extends CompositeRequestParser {
+ /**
+ * delimiter character for datespec flags
+ */
public final static String FLAG_DELIM = "_";
+ /**
+ * text/javascript context
+ */
public final static String JS_CONTEXT = "js";
+ /**
+ * text/css context
+ */
public final static String CSS_CONTEXT = "cs";
+ /**
+ * image/* context
+ */
public final static String IMG_CONTEXT = "im";
+ /**
+ * Charset detection strategy context - should be followed by an integer
+ * indicating which strategy to use
+ */
public final static String CHARSET_MODE = "cm";
protected RequestParser[] getRequestParsers() {
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlSAXRewriteReplayRenderer.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlSAXRewriteReplayRenderer.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlSAXRewriteReplayRenderer.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -54,12 +54,22 @@
import org.htmlparser.lexer.Page;
import org.htmlparser.util.ParserException;
+/**
+ * ReplayRenderer which attempts to rewrite text/html documents so URLs
+ * references within the document load from the correct ArchivalURL AccessPoint.
+ *
+ * @author brad
+ *
+ */
public class ArchivalUrlSAXRewriteReplayRenderer implements ReplayRenderer {
private ReplayParseEventDelegator delegator = null;
private HttpHeaderProcessor httpHeaderProcessor;
private CharsetDetector charsetDetector = new StandardCharsetDetector();
private final static String OUTPUT_CHARSET = "utf-8";
+ /**
+ * @param httpHeaderProcessor which should process HTTP headers
+ */
public ArchivalUrlSAXRewriteReplayRenderer(HttpHeaderProcessor httpHeaderProcessor) {
this.httpHeaderProcessor = httpHeaderProcessor;
}
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlSpecialContextResultURIConverter.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlSpecialContextResultURIConverter.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ArchivalUrlSpecialContextResultURIConverter.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -27,8 +27,9 @@
import org.archive.wayback.ResultURIConverter;
/**
+ * wrapper around an ArchivalUrlResultURIConverter, adding flags after the
+ * datespec for a specific context ("js_" for javascript, "cs_" for CSS, etc)
*
- *
* @author brad
* @version $Date$, $Revision$
*/
@@ -40,6 +41,11 @@
private String replayURIPrefix = null;
private String context;
+ /**
+ * @param converter ArchivalUrlResultURIConverter to wrap
+ * @param context flags indicating the context of URLs created by this
+ * object
+ */
public ArchivalUrlSpecialContextResultURIConverter(
ArchivalUrlResultURIConverter converter, String context) {
replayURIPrefix = converter.getReplayURIPrefix();
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ClientSideHTMLReplayRenderer.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ClientSideHTMLReplayRenderer.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ClientSideHTMLReplayRenderer.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -42,14 +42,16 @@
import org.archive.wayback.replay.HttpHeaderProcessor;
/**
+ * Classic ReplayRenderer which uses a combination of server-side modification
+ * and embedded javascript to rewrite URLs within an HTML page to make embedded
+ * URLs point back to a specific ArchivalURL AccessPoint.
*
- *
* @author brad
* @version $Date$, $Revision$
*/
public class ClientSideHTMLReplayRenderer extends TextReplayRenderer {
/**
- * @param httpHeaderProcessor
+ * @param httpHeaderProcessor which should process HTTP headers
*/
public ClientSideHTMLReplayRenderer(HttpHeaderProcessor httpHeaderProcessor) {
super(httpHeaderProcessor);
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ServerSideHTMLReplayRenderer.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ServerSideHTMLReplayRenderer.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/ServerSideHTMLReplayRenderer.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -42,14 +42,15 @@
import org.archive.wayback.replay.HttpHeaderProcessor;
/**
+ * ArchivalUrl ReplayRenderer which uses a series of RegEx's to rewrite embedded
+ * URLs to point back into a specific ArchivalUrl AccessPoint.
*
- *
* @author brad
* @version $Date$, $Revision$
*/
public class ServerSideHTMLReplayRenderer extends TextReplayRenderer {
/**
- * @param httpHeaderProcessor
+ * @param httpHeaderProcessor which should process HTTP headers
*/
public ServerSideHTMLReplayRenderer(HttpHeaderProcessor httpHeaderProcessor) {
super(httpHeaderProcessor);
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathDatePrefixQueryRequestParser.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathDatePrefixQueryRequestParser.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathDatePrefixQueryRequestParser.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -41,7 +41,7 @@
*/
public class PathDatePrefixQueryRequestParser extends PathRequestParser {
/**
- * @param wrapped
+ * @param wrapped BaseRequestParser which provides general configuration
*/
public PathDatePrefixQueryRequestParser(BaseRequestParser wrapped) {
super(wrapped);
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathDateRangeQueryRequestParser.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathDateRangeQueryRequestParser.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathDateRangeQueryRequestParser.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -42,7 +42,7 @@
public class PathDateRangeQueryRequestParser extends PathRequestParser {
/**
- * @param wrapped
+ * @param wrapped BaseRequestParser which provides general configuration
*/
public PathDateRangeQueryRequestParser(BaseRequestParser wrapped) {
super(wrapped);
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathPrefixDatePrefixQueryRequestParser.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathPrefixDatePrefixQueryRequestParser.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathPrefixDatePrefixQueryRequestParser.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -41,7 +41,7 @@
*/
public class PathPrefixDatePrefixQueryRequestParser extends PathRequestParser {
/**
- * @param wrapped
+ * @param wrapped BaseRequestParser which provides general configuration
*/
public PathPrefixDatePrefixQueryRequestParser(BaseRequestParser wrapped) {
super(wrapped);
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathPrefixDateRangeQueryRequestParser.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathPrefixDateRangeQueryRequestParser.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/PathPrefixDateRangeQueryRequestParser.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -41,7 +41,7 @@
*/
public class PathPrefixDateRangeQueryRequestParser extends PathRequestParser {
/**
- * @param wrapped
+ * @param wrapped BaseRequestParser which provides general configuration
*/
public PathPrefixDateRangeQueryRequestParser(BaseRequestParser wrapped) {
super(wrapped);
Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/ReplayRequestParser.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/ReplayRequestParser.java 2009-11-08 01:33:37 UTC (rev 2917)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/archivalurl/requestparser/ReplayRequestParser.java 2009-11-08 01:59:29 UTC (rev 2918)
@@ -49,7 +49,7 @@
.compile("^(\\d{1,14})(([a-z]{2}[0-9]*_)*)/(.*)$");
/**
- * @param wrapped
+ * @param wrapped BaseRequestParser which provides general configuration
*/
public ReplayRequestParser(BaseRequestParser wrapped) {
super(wrapped);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
