org.jahia.services.render.filter

Class AbstractFilter

java.lang.Object

org.jahia.services.render.filter.ConditionalExecution

org.jahia.services.render.filter.AbstractFilter

All Implemented Interfaces:

Comparable<RenderFilter>, RenderFilter, RenderServiceAware

Direct Known Subclasses:

AggregateCacheFilter, AggregateFilter, AreaResourceFilter, BaseAttributesFilter, CacheFilter, ChannelPreviewFilter, ChannelResolutionFilter, EditModeFilter, EmailObfuscatorFilter, ExternalizeHtmlFilter, ForceUILocaleFilter, FormTokenFilter, HistoryTrackerFilter, MarkedForDeletionFilter, MetricsLoggingFilter, NodeAttributesFilter, PlutoProcessActionFilter, ReferencesToDependenciesFilter, RegexpFilter, SourceFormatterFilter, StaticAssetsFilter, TemplateAttributesFilter, TemplateModuleInterceptorFilter, TemplateNodeFilter, TemplatePermissionCheckFilter, TemplateScriptFilter, URLFilter, URLSystemAttributesAppenderFilter, VisibilityFilter, WrapperFilter

public abstract class AbstractFilter
extends ConditionalExecution
implements RenderFilter

Base filter implementation that is also supports conditional execution, i.e. the filter logic is executed only if all the specified conditions are matched.

Author:

Thomas Draier, Sergiy Shyrkov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFilter.AjaxRequestCondition
static class	AbstractFilter.AnyOfCondition Evaluates to true if any of the underlying conditions evaluates to true.
static class	AbstractFilter.ConfigurationCondition
static class	AbstractFilter.EditModeCondition Evaluates to true if the current mode equals to the specified one
static interface	AbstractFilter.ExecutionCondition
static class	AbstractFilter.MainResourceCondition Evaluates to true if the current resource is the main resource
static class	AbstractFilter.ModeCondition Evaluates to true if the current mode equals to the specified one
static class	AbstractFilter.ModuleCondition Evaluates to true if the current resource's template type matches the provided one.
static class	AbstractFilter.NodeTypeCondition Evaluates to true if the current resource's node has the specified node type.
static class	AbstractFilter.NotCondition Inverts the result of the underlying condition.
static class	AbstractFilter.PatternCondition Evaluates to true if the current resource's template type matches the provided one.
static class	AbstractFilter.RequestAttributeCondition Filter execution condition that evaluates to true if the specified request attribute matches the specified value.
static class	AbstractFilter.RequestCondition Filter execution condition that evaluates to true if the specified request item matches the specified value.
static class	AbstractFilter.RequestHeaderCondition Filter execution condition that evaluates to true if the specified request header matches the specified value.
static class	AbstractFilter.RequestParameterCondition Filter execution condition that evaluates to true if the specified request parameter matches the specified value.
static class	AbstractFilter.SiteTemplateSetCondition Evaluates to true if the current site's template set matches the specified one
static class	AbstractFilter.TemplateCondition Evaluates to true if the current resource's template matches the provided one.
static class	AbstractFilter.TemplateTypeCondition Evaluates to true if the current resource's template type matches the provided one.
static class	AbstractFilter.WebflowRequestCondition Checks that the current request is processing a Webflow action.

Field Summary

Fields

Modifier and Type	Field and Description
protected RenderService	service

Constructor Summary

Constructors

Constructor and Description
AbstractFilter() Initializes an instance of this class.
AbstractFilter(AbstractFilter.ExecutionCondition... conditions) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	areConditionsMatched(RenderContext renderContext, Resource resource)
int	compareTo(RenderFilter filter)
boolean	equals(Object obj)
String	execute(String previousOut, RenderContext renderContext, Resource resource, RenderChain chain)
void	finalize(RenderContext renderContext, Resource resource, RenderChain renderChain)
String	getContentForError(RenderContext renderContext, Resource resource, RenderChain renderChain, Exception e)
String	getDescription() Returns a human-readable description of this filter.
float	getPriority() Get the priority number of the filter.
int	hashCode()
boolean	isDisabled()
String	prepare(RenderContext renderContext, Resource resource, RenderChain chain)
void	setDescription(String description) Sets a human-readable description of this filter.
void	setDisabled(boolean disabled)
void	setPriority(float priority)
void	setRenderService(RenderService service) Injects an instance of the RenderService into the current bean.
String	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

service

protected RenderService service

Constructor Detail

AbstractFilter

public AbstractFilter()

Initializes an instance of this class.

AbstractFilter

public AbstractFilter(AbstractFilter.ExecutionCondition... conditions)

Initializes an instance of this class.

Parameters:

conditions - the execution conditions to be matched.

Method Detail

areConditionsMatched

public boolean areConditionsMatched(RenderContext renderContext,
                                    Resource resource)

Specified by:

areConditionsMatched in interface RenderFilter

Overrides:

areConditionsMatched in class ConditionalExecution

compareTo

public int compareTo(RenderFilter filter)

Specified by:

compareTo in interface Comparable<RenderFilter>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

execute

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

Specified by:

execute in interface RenderFilter

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

getDescription

public String getDescription()

Returns a human-readable description of this filter.

Returns:

a human-readable description of this filter

getPriority

public float getPriority()

Get the priority number of the filter. Filter will be executed in order of priority, lower first.

Specified by:

getPriority in interface RenderFilter

isDisabled

public boolean isDisabled()

getContentForError

public String getContentForError(RenderContext renderContext,
                                 Resource resource,
                                 RenderChain renderChain,
                                 Exception e)

Specified by:

getContentForError in interface RenderFilter

prepare

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

Specified by:

prepare in interface RenderFilter

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

setDescription

public void setDescription(String description)

Sets a human-readable description of this filter.

Parameters:

description - a human-readable description of this filter

setDisabled

public void setDisabled(boolean disabled)

setPriority

public void setPriority(float priority)

setRenderService

public final void setRenderService(RenderService service)

Description copied from interface: RenderServiceAware

Injects an instance of the RenderService into the current bean.

Specified by:

setRenderService in interface RenderServiceAware

Parameters:

service - an instance of the RenderService

toString

public String toString()

Overrides:

toString in class Object