org.jahia.services.render.filter

Interface RenderFilter

All Superinterfaces:

Comparable<RenderFilter>, RenderServiceAware

All Known Implementing Classes:

AbstractFilter, 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 interface RenderFilter
extends RenderServiceAware, Comparable<RenderFilter>

Interface that defines a filter usable in the RenderChain. Each filter can either call the next filter and transform the output, or generate its own output. It can execute operations before/after calling the next filter. Date: Nov 24, 2009 Time: 12:08:45 PM

Method Summary

Modifier and Type	Method and Description
boolean	areConditionsMatched(RenderContext renderContext, Resource resource)
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)
float	getPriority() Get the priority number of the filter.
String	prepare(RenderContext renderContext, Resource resource, RenderChain chain)

Methods inherited from interface org.jahia.services.render.filter.RenderServiceAware

setRenderService

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getPriority

float getPriority()

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

areConditionsMatched

boolean areConditionsMatched(RenderContext renderContext,
                             Resource resource)

execute

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

Throws:

Exception

prepare

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

Throws:

Exception

getContentForError

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

finalize

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