org.esigate.esi

Class EsiRenderer

java.lang.Object

org.esigate.esi.EsiRenderer

All Implemented Interfaces:

Appendable, Renderer

public class EsiRenderer
extends Object
implements Renderer, Appendable

Retrieves a resource from the provider application and parses it to find ESI tags to be replaced by contents from other applications. For more information about ESI language specification, see Edge Side Include

Author:

Francois-Xavier Bonnet

Constructor Summary

Constructors

Constructor and Description
EsiRenderer() Constructor used to render a complete page.
EsiRenderer(String page, String name) Constructor used to render a fragment Retrieves a fragment inside a page.

Method Summary

Modifier and Type	Method and Description
Appendable	append(char c)
Appendable	append(CharSequence csq)
Appendable	append(CharSequence csq, int start, int end)
Map<String,CharSequence>	getFragmentsToReplace()
String	getName()
boolean	isWrite()
void	render(DriverRequest originalRequest, String content, Writer outWriter) Renders provided source and writes results to the output.
void	setFound(boolean found)
void	setFragmentsToReplace(Map<String,CharSequence> fragmentsToReplace)
void	setWrite(boolean write)

Methods inherited from class java.lang.Object

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

Constructor Detail

EsiRenderer

public EsiRenderer()

Constructor used to render a complete page.

EsiRenderer

public EsiRenderer(String page,
                   String name)

Constructor used to render a fragment Retrieves a fragment inside a page.
Extracts html between <esi:fragment name="myFragment"> and </esi:fragment>

Parameters:

page -

name -

Method Detail

getName

public String getName()

setWrite

public void setWrite(boolean write)

getFragmentsToReplace

public Map<String,CharSequence> getFragmentsToReplace()

setFragmentsToReplace

public void setFragmentsToReplace(Map<String,CharSequence> fragmentsToReplace)

render

public void render(DriverRequest originalRequest,
                   String content,
                   Writer outWriter)
            throws IOException,
                   HttpErrorPage

Description copied from interface: Renderer

Renders provided source and writes results to the output.

Specified by:

render in interface Renderer

Parameters:

originalRequest - request received by esigate.

content - source to be rendered

outWriter - output destination. This writer is not thread-safe, use proper synchronization if writing output from multiple threads.

Throws:

IOException

HttpErrorPage

append

public Appendable append(CharSequence csq)
                  throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

append

public Appendable append(char c)
                  throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

append

public Appendable append(CharSequence csq,
                         int start,
                         int end)
                  throws IOException

Specified by:

append in interface Appendable

Throws:

IOException

isWrite

public boolean isWrite()

setFound

public void setFound(boolean found)