org.apache.shindig.gadgets.rewrite

Class DomWalker.Rewriter

java.lang.Object

org.apache.shindig.gadgets.rewrite.DomWalker.Rewriter

All Implemented Interfaces:

GadgetRewriter, ResponseRewriter

Direct Known Subclasses:

AbsolutePathReferenceRewriter, ContentTypeCharsetRemoverRewriter, ImageAttributeRewriter, ImageResizeRewriter, OsTemplateXmlLoaderRewriter, ProxyingContentRewriter, SanitizingGadgetRewriter, ScriptConcatContentRewriter, StyleAdjacencyContentRewriter, StyleConcatContentRewriter, StyleTagExtractorContentRewriter, StyleTagProxyEmbeddedUrlsRewriter

Enclosing class:

DomWalker

public static class DomWalker.Rewriter
extends Object
implements GadgetRewriter, ResponseRewriter

Rewriter that traverses the DOM, passing each node to its list of Visitor instances in order. Each visitor may bypass, modify, or reserve the node. Reserved nodes will be revisited after the entire DOM tree is walked. The DOM tree is walked in depth-first order.

Constructor Summary

Constructors

Constructor and Description
DomWalker.Rewriter()
DomWalker.Rewriter(DomWalker.Visitor... visitors)
DomWalker.Rewriter(List<DomWalker.Visitor> visitors)

Method Summary

Methods

Modifier and Type	Method and Description
protected List<DomWalker.Visitor>	makeVisitors(Gadget context, Uri gadgetUri)
void	rewrite(Gadget gadget, MutableContent content) Performs the DomWalker rewrite operation described in class javadoc.
void	rewrite(HttpRequest request, HttpResponseBuilder builder, Gadget gadget) Rewrites the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

DomWalker.Rewriter

public DomWalker.Rewriter(List<DomWalker.Visitor> visitors)

DomWalker.Rewriter

public DomWalker.Rewriter(DomWalker.Visitor... visitors)

DomWalker.Rewriter

public DomWalker.Rewriter()

Method Detail

makeVisitors

protected List<DomWalker.Visitor> makeVisitors(Gadget context,
                                   Uri gadgetUri)

rewrite

public void rewrite(Gadget gadget,
           MutableContent content)
             throws RewritingException

Performs the DomWalker rewrite operation described in class javadoc.

Specified by:

rewrite in interface GadgetRewriter

Parameters:

gadget - Gadget to rewrite.

content - the content of the gadget to be manipulated.

Throws:

RewritingException

rewrite

public void rewrite(HttpRequest request,
           HttpResponseBuilder builder,
           Gadget gadget)
             throws RewritingException

Description copied from interface: ResponseRewriter

Rewrites the response.

Specified by:

rewrite in interface ResponseRewriter

Parameters:

request - The request that was made.

builder - The response generated as a result of the request.

gadget - The gadget that made the request. This parameter may be null.

Throws:

RewritingException - Thrown if something went wrong when rewriting the response.