org.jahia.services.render.filter

Class RenderChain

java.lang.Object

org.jahia.services.render.filter.RenderChain

public class RenderChain
extends Object

Main pipeline that generates output for rendering. Date: Nov 24, 2009 Time: 12:33:52 PM

Constructor Summary

Constructors

Constructor and Description
RenderChain() Initializes an instance of this class.
RenderChain(Collection<RenderFilter> filters) Initializes an instance of this class.
RenderChain(Collection<RenderFilter> filters1, Collection<RenderFilter> filters2) Initializes an instance of this class.
RenderChain(RenderFilter... filters) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
void	addFilter(RenderFilter filter) Add one filter the chain.
void	addFilters(Collection<RenderFilter> filters) Add multiple filters to the chain.
String	doFilter(RenderContext renderContext, Resource resource) Continue the execution of the render chain.
void	doSortFilters()
List<RenderFilter>	getFilters() Returns an unmodifiable view of the list of filters, used by this chain.
Object	getPreviousValue(String key)
void	pushAttribute(javax.servlet.http.HttpServletRequest request, String key, Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderChain

public RenderChain()

Initializes an instance of this class.

RenderChain

public RenderChain(Collection<RenderFilter> filters)

Initializes an instance of this class.

Parameters:

filters - to be used

RenderChain

public RenderChain(Collection<RenderFilter> filters1,
                   Collection<RenderFilter> filters2)

Initializes an instance of this class.

Parameters:

filters1 - to be used

filters2 - to be used (additionally to filters1)

RenderChain

public RenderChain(RenderFilter... filters)

Initializes an instance of this class.

Parameters:

filters - a list of filters to be used in the chain

Method Detail

addFilter

public void addFilter(RenderFilter filter)

Add one filter the chain.

Parameters:

filter - The filter to add

addFilters

public void addFilters(Collection<RenderFilter> filters)

Add multiple filters to the chain.

Parameters:

filters - The filters to add

doFilter

public String doFilter(RenderContext renderContext,
                       Resource resource)
                throws RenderFilterException

Continue the execution of the render chain. Go to the next filter if one is available. If no other filter is available, throws an IOException

Parameters:

renderContext - The render context

resource - The current resource to display

Returns:

Output from the next filter

Throws:

RenderFilterException - in case of a rendering errors

doSortFilters

public void doSortFilters()

pushAttribute

public void pushAttribute(javax.servlet.http.HttpServletRequest request,
                          String key,
                          Object value)

getPreviousValue

public Object getPreviousValue(String key)

getFilters

public List<RenderFilter> getFilters()

Returns an unmodifiable view of the list of filters, used by this chain.

Returns:

an unmodifiable view of the list of filters, used by this chain