org.esigate.extension.parallelesi

Class EsiRenderer

java.lang.Object

org.esigate.extension.parallelesi.EsiRenderer

All Implemented Interfaces:

FutureAppendable, Renderer

public class EsiRenderer
extends Object
implements Renderer, FutureAppendable

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

This class is based on EsiRenderer

Author:

Nicolas Richeton

See Also:

EsiRenderer

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_EXECUTOR Key for the executor for future tasks.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FutureAppendable	enqueueAppend(Future<CharSequence> csq) Queue the Future<CharSequence> for append in this FutureAppendable.
Map<String,CharSequence>	getFragmentsToReplace()
String	getName()
boolean	hasPending() Check if some append operations are still waiting for FutureAppendable.performAppends() to be called.
boolean	isWrite()
FutureAppendable	performAppends() Wait for all computation to complete and perform the pending append operations.
FutureAppendable	performAppends(int timeout, TimeUnit unit) Wait for all computation to complete and perform the pending append operations.
void	render(DriverRequest originalRequest, String content, Writer out) 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

Field Detail

DATA_EXECUTOR

public static final String DATA_EXECUTOR

Key for the executor for future tasks. This is used with parser#setData().

See Also:

Constant Field Values

Constructor Detail

EsiRenderer

public EsiRenderer(Executor executor)

Constructor used to render a complete page.

Parameters:

executor - Executor to use for background operations or null if single-thread operations.

EsiRenderer

public EsiRenderer(String page,
                   String name,
                   Executor executor)

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 -

executor - Executor to use for background operations or null if single-thread operations.

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 out)
            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

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

Throws:

IOException

HttpErrorPage

enqueueAppend

public FutureAppendable enqueueAppend(Future<CharSequence> csq)

Description copied from interface: FutureAppendable

Queue the Future<CharSequence> for append in this FutureAppendable.

Caller may start computing the content of the Future parameter before or after calling this method (using other Thread) or simply wait for Future#get() to be called (deferred computation).

Specified by:

enqueueAppend in interface FutureAppendable

Parameters:

csq - The Future character sequence to append. If csq is null, then the four characters "null" are appended to this FutureAppendable.

Returns:

A reference to this FutureAppendable

isWrite

public boolean isWrite()

setFound

public void setFound(boolean found)

performAppends

public FutureAppendable performAppends()
                                throws IOException,
                                       HttpErrorPage

Description copied from interface: FutureAppendable

Wait for all computation to complete and perform the pending append operations.

Specified by:

performAppends in interface FutureAppendable

Returns:

A reference to this FutureAppendable

Throws:

IOException

HttpErrorPage

hasPending

public boolean hasPending()

Description copied from interface: FutureAppendable

Check if some append operations are still waiting for FutureAppendable.performAppends() to be called.

Specified by:

hasPending in interface FutureAppendable

Returns:

true if append operations are pending.

performAppends

public FutureAppendable performAppends(int timeout,
                                       TimeUnit unit)
                                throws IOException,
                                       HttpErrorPage,
                                       TimeoutException

Description copied from interface: FutureAppendable

Wait for all computation to complete and perform the pending append operations.

Specified by:

performAppends in interface FutureAppendable

Returns:

FutureAppendable

Throws:

IOException

HttpErrorPage

TimeoutException