[Archive-access-cvs] SF.net SVN: archive-access:[3291] trunk/archive-access/projects/wayback/ wayback-core/src/main/java/org/archive/wayback/replay/swf

[<bra...@us...>]

Revision: 3291
          http://archive-access.svn.sourceforge.net/archive-access/?rev=3291&view=rev
Author:   bradtofel
Date:     2010-10-21 17:42:32 +0000 (Thu, 21 Oct 2010)

Log Message:
-----------
WHITESPACE/JAVADOC

Modified Paths:
--------------
    trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/swf/RobustMovieDecoder.java
    trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/swf/SWFReplayRenderer.java

Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/swf/RobustMovieDecoder.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/swf/RobustMovieDecoder.java	2010-10-21 17:34:40 UTC (rev 3290)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/swf/RobustMovieDecoder.java	2010-10-21 17:42:32 UTC (rev 3291)
@@ -45,10 +45,23 @@
     /** Allow arbitrary trailing values in decoded tags - attempt anything. */
     public static final int DECODE_RULE_LAX = 2;
     
+    /**
+     * @param decodeRule the robustness level to use for re-aligning the
+     * decoder. MovieDecoder just chokes if a given tag has trailing data - does
+     * not need as many bytes as it declares it has. This decorator will attempt
+     * to realign by either:
+     * 1) LAX - chewing up *any* bytes to realign
+     * 2) NULLS - chewing up only trailing NULL bytes trailing the tag
+     * 3) STRICT - throw exception if an realignment is required. 
+     */
     public void setDecodeRule(int decodeRule) {
     	this.decodeRule = decodeRule;
     }
     
+    /**
+     * @param delegate the underlying/wrapped MovieDecoder which does the heavy
+     * lifting to parse out tags.
+     */
     public void setDelegate(SWFFactory<MovieTag> delegate) {
 		this.delegate = delegate;
 	}

Modified: trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/swf/SWFReplayRenderer.java
===================================================================
--- trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/swf/SWFReplayRenderer.java	2010-10-21 17:34:40 UTC (rev 3290)
+++ trunk/archive-access/projects/wayback/wayback-core/src/main/java/org/archive/wayback/replay/swf/SWFReplayRenderer.java	2010-10-21 17:42:32 UTC (rev 3291)
@@ -21,7 +21,6 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
-import java.io.OutputStream;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.util.ArrayList;
@@ -59,11 +58,17 @@
 import com.flagstone.transform.coder.DecoderRegistry;
 
 /**
+ * ReplayRenderer which passes embedded URLs inside flash (SWF) format content
+ * through a ResultURIConverter, allowing them to be rewritten. 
+ * 
  * @author brad
  *
  */
 public class SWFReplayRenderer implements ReplayRenderer {
 	private HttpHeaderProcessor httpHeaderProcessor;
+	/**
+	 * @param httpHeaderProcessor to use for rewriting original HTTP headers
+	 */
 	public SWFReplayRenderer(HttpHeaderProcessor httpHeaderProcessor) {
 		this.httpHeaderProcessor = httpHeaderProcessor;
 	}
@@ -128,7 +133,7 @@
 		baos.writeTo(httpResponse.getOutputStream());
 		
 	}
-	public Movie getRobustMovie(int decodeRule) {
+	private Movie getRobustMovie(int decodeRule) {
 		Movie movie = new Movie();
 
 		DecoderRegistry registry = DecoderRegistry.getDefault();
@@ -141,7 +146,7 @@
 		return movie;
 	}
 
-	public MovieTag rewriteTag(SWFUrlRewriter rw, MovieTag tag) {
+	private MovieTag rewriteTag(SWFUrlRewriter rw, MovieTag tag) {
 		if(tag instanceof DoAction) {
 			DoAction doAction = (DoAction) tag;
 			doAction.setActions(rewriteActions(rw, doAction.getActions()));
@@ -153,7 +158,8 @@
 		return tag;
 	}
 	
-	public List<EventHandler> rewriteEventHandlers(SWFUrlRewriter rw, List<EventHandler> handlers) {
+	private List<EventHandler> rewriteEventHandlers(SWFUrlRewriter rw,
+			List<EventHandler> handlers) {
 		ArrayList<EventHandler> newActions = new ArrayList<EventHandler>();
 		for(EventHandler handler : handlers) {
 			handler.setActions(rewriteActions(rw, handler.getActions()));
@@ -162,7 +168,7 @@
 		return newActions;
 	}
 	
-	public List<Action> rewriteActions(SWFUrlRewriter rw, List<Action> actions) {
+	private List<Action> rewriteActions(SWFUrlRewriter rw, List<Action> actions) {
 		ArrayList<Action> newActions = new ArrayList<Action>();
 		for(Action action : actions) {
 			if(action instanceof Table) {
@@ -175,12 +181,14 @@
 
 				Push push = (Push) action;
 				
-				newActions.add(new Push(rewriteObjectValues(rw, push.getValues())));
+				newActions.add(new Push(rewriteObjectValues(rw, 
+						push.getValues())));
 
 			} else if(action instanceof GetUrl) {
 
 				GetUrl getUrl = (GetUrl) action;
-				newActions.add(new GetUrl(rewriteString(rw, getUrl.getUrl()),getUrl.getTarget()));
+				newActions.add(new GetUrl(rewriteString(rw, getUrl.getUrl()),
+						getUrl.getTarget()));
 				
 			} else {
 				newActions.add(action);
@@ -189,7 +197,9 @@
 		return newActions;
 	}
 	
-	public List<Object> rewriteObjectValues(SWFUrlRewriter rw, List<Object> values) {
+	private List<Object> rewriteObjectValues(SWFUrlRewriter rw,
+			List<Object> values) {
+
 		ArrayList<Object> nvals = new ArrayList<Object>();
 		for(int i = 0; i < values.size(); i++) {
 			Object orig = values.get(i);
@@ -201,20 +211,25 @@
 		}
 		return nvals;
 	}
-	public List<String> rewriteStringValues(SWFUrlRewriter rw, List<String> values) {
+
+	private List<String> rewriteStringValues(SWFUrlRewriter rw,
+			List<String> values) {
+
 		ArrayList<String> nvals = new ArrayList<String>();
 		for(int i = 0; i < values.size(); i++) {
 			nvals.add(rewriteString(rw, values.get(i)));
 		}
 		return nvals;
 	}
-	public String rewriteString(SWFUrlRewriter rw, String original) {
+
+	private String rewriteString(SWFUrlRewriter rw, String original) {
 		if(original.startsWith("http://")) {
 //			System.err.format("Rewrite(%s)\n",original);
 			return rw.rewrite(original);
 		}
 		return original;
 	}
+
 	private class SWFUrlRewriter {
 		UURI baseUrl = null;
 		ResultURIConverter converter;
@@ -224,7 +239,8 @@
 			this.datespec = datespec;
 			this.converter = converter;
 			try {
-				this.baseUrl = UURIFactory.getInstance(baseUrl.toExternalForm());
+				this.baseUrl = 
+					UURIFactory.getInstance(baseUrl.toExternalForm());
 			} catch (URIException e) {
 				e.printStackTrace();
 			}


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.