org.jahia.services.render.filter

Class AggregateFilter

java.lang.Object

org.jahia.services.render.filter.ConditionalExecution

org.jahia.services.render.filter.AbstractFilter

org.jahia.services.render.filter.AggregateFilter

All Implemented Interfaces:

Comparable<RenderFilter>, RenderFilter, RenderServiceAware

public class AggregateFilter
extends AbstractFilter

Aggregate render filter, in charge of aggregating fragment by resolving sub fragments; The flow of aggregation is done in multiple set 1 - The prepare will generate a fragment A by returning null and letting the next filters do the rendering 2 - Next filters can start new render chains, it's the case of the ModuleTag for example, so we will pass again in the prepare() for each render chains start by next filters, but this render chain are identify as sub fragment of fragment A. (identification is explain after) 3 - When a sub fragment B is identify, the chain is stop and a placeholder is return: Next filters are not execute. 4 - The render of fragment A is finished when we arrive in the execute() function for fragment A. 5 - At this state HTML of the fragment A is ready, and contain the fragment B placeholder: 6 - The Aggregation of the sub fragments for fragment A can start. 7 - We iterate on each sub fragments available in fragment A and start a new render chain for each 8 - A new render chain will be start for fragment B 9 - During aggregation we already have fragment B key because it's contain by the jahia_esi:include tag from fragment A. So we pass it to the new render chain using moduleParams so we don't have to calculate it again. This how we can identify a new render chain coming from aggregation and we are not in case (2) Created by jkevan on 12/04/2017.

Nested Class Summary

Nested classes/interfaces inherited from class org.jahia.services.render.filter.AbstractFilter

AbstractFilter.AjaxRequestCondition, AbstractFilter.AnyOfCondition, AbstractFilter.ConfigurationCondition, AbstractFilter.EditModeCondition, AbstractFilter.ExecutionCondition, AbstractFilter.MainResourceCondition, AbstractFilter.ModeCondition, AbstractFilter.ModuleCondition, AbstractFilter.NodeTypeCondition, AbstractFilter.NotCondition, AbstractFilter.PatternCondition, AbstractFilter.RequestAttributeCondition, AbstractFilter.RequestCondition, AbstractFilter.RequestHeaderCondition, AbstractFilter.RequestParameterCondition, AbstractFilter.SiteTemplateSetCondition, AbstractFilter.TemplateCondition, AbstractFilter.TemplateTypeCondition, AbstractFilter.WebflowRequestCondition

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGGREGATING
static String	AGGREGATING_KEY
static String	RENDERING_FINAL_KEY
static String	RENDERING_KEY
static String	RESOURCES_STACK
static String	SKIP_AGGREGATION

Fields inherited from class org.jahia.services.render.filter.AbstractFilter

service

Constructor Summary

Constructors

Constructor and Description
AggregateFilter()

Method Summary

Modifier and Type	Method and Description
protected String	aggregateContent(String content, RenderContext renderContext) Aggregate the content that are inside the fragment to get a full HTML content with all sub modules embedded.
String	execute(String previousOut, RenderContext renderContext, Resource resource, RenderChain chain)
void	finalize(RenderContext renderContext, Resource resource, RenderChain renderChain)
protected String	generateContent(RenderContext renderContext, String key) Generates content for a sub fragment.
String	prepare(RenderContext renderContext, Resource resource, RenderChain chain)
void	setKeyGenerator(CacheKeyGenerator keyGenerator)
static boolean	skipAggregation(javax.servlet.ServletRequest request) Utility method to check if the aggregation is skipped.

Methods inherited from class org.jahia.services.render.filter.AbstractFilter

areConditionsMatched, compareTo, equals, getContentForError, getDescription, getPriority, hashCode, isDisabled, setDescription, setDisabled, setPriority, setRenderService, toString

Methods inherited from class org.jahia.services.render.filter.ConditionalExecution

addCondition, addCondition, getConditionsSummary, setApplyOnConfigurations, setApplyOnEditMode, setApplyOnMainResource, setApplyOnModes, setApplyOnModules, setApplyOnNodeTypes, setApplyOnSiteTemplateSets, setApplyOnTemplates, setApplyOnTemplateTypes, setConditions, setSkipOnAjaxRequest, setSkipOnConfiguration, setSkipOnConfigurations, setSkipOnEditMode, setSkipOnMainResource, setSkipOnModes, setSkipOnModules, setSkipOnNodeTypes, setSkipOnTemplates, setSkipOnTemplateTypes, setSkipOnWebflowRequest

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RENDERING_KEY

public static final String RENDERING_KEY

See Also:

Constant Field Values

RENDERING_FINAL_KEY

public static final String RENDERING_FINAL_KEY

See Also:

Constant Field Values

AGGREGATING_KEY

public static final String AGGREGATING_KEY

See Also:

Constant Field Values

AGGREGATING

public static final String AGGREGATING

See Also:

Constant Field Values

RESOURCES_STACK

public static final String RESOURCES_STACK

See Also:

Constant Field Values

SKIP_AGGREGATION

public static final String SKIP_AGGREGATION

See Also:

Constant Field Values

Constructor Detail

AggregateFilter

public AggregateFilter()

Method Detail

prepare

public String prepare(RenderContext renderContext,
                      Resource resource,
                      RenderChain chain)
               throws Exception

Specified by:

prepare in interface RenderFilter

Overrides:

prepare in class AbstractFilter

Parameters:

renderContext - The render context

resource - The resource to render

chain - The render chain

Returns:

Content to stop the chain, or null to continue

Throws:

Exception

execute

public String execute(String previousOut,
                      RenderContext renderContext,
                      Resource resource,
                      RenderChain chain)
               throws Exception

Specified by:

execute in interface RenderFilter

Overrides:

execute in class AbstractFilter

Parameters:

previousOut - Result from the previous filter

renderContext - The render context

resource - The resource to render

chain - The render chain

Returns:

Filtered content

Throws:

Exception

finalize

public void finalize(RenderContext renderContext,
                     Resource resource,
                     RenderChain renderChain)

Specified by:

finalize in interface RenderFilter

Overrides:

finalize in class AbstractFilter

aggregateContent

protected String aggregateContent(String content,
                                  RenderContext renderContext)
                           throws RenderException

Aggregate the content that are inside the fragment to get a full HTML content with all sub modules embedded.

Parameters:

content - The fragment

renderContext - The render context

Throws:

RenderException

generateContent

protected String generateContent(RenderContext renderContext,
                                 String key)
                          throws RenderException

Generates content for a sub fragment.

Parameters:

renderContext - The render context

key - The key of the fragment to generate

Throws:

RenderException

setKeyGenerator

public void setKeyGenerator(CacheKeyGenerator keyGenerator)

skipAggregation

public static boolean skipAggregation(javax.servlet.ServletRequest request)

Utility method to check if the aggregation is skipped.

Parameters:

request - is the current request

Returns: