me.noroutine.dust4j

Class DustCompilingFilter

java.lang.Object

me.noroutine.dust4j.DustCompilingFilter

All Implemented Interfaces:

javax.servlet.Filter

public class DustCompilingFilter
extends java.lang.Object
implements javax.servlet.Filter

Main workhorse of dust4j, the filter that intercepts the JSP/Servlet output stream and feeds the content of it to instance of DustCompiler This allows to use JSP or any other framework to create dynamic templates. Supports simple session-based cache and eTag support to control client-side caching of compiled templates

Setup

To setup filter in your application, add the definitions to yout web.xml:

 <filter>
     <filter-name>dustCompilingFilter</filter-name>
     <filter-class>me.noroutine.dust4j.DustCompilingFilter</filter-class>
 </filter>

 <filter-mapping>
     <filter-name>dustCompilingFilter</filter-name>
     <url-pattern>/*</url-pattern>
 </filter-mapping>
 

Note that you should use /* as url-pattern, due to the fact that *.dust.js doesn't work as one would expect. So filter will apply for any URL, but it will only compile those that match the templateNameRegex, which is by default any URL that ends with .dust.js

Configuration

This filter supports the following parameters:

init-param name	Type	Default	Description
cache	boolean	true	Enable/disable internal cache
eTag	boolean	false	Enable/disable ETag support
compilerFactory	string	me.noroutine.dust4j.DefaultDustCompilerFactory	Canonical name of factory for obtaining DustCompiler instance. Should implement DustCompilerFactory interface
templateNameRegex	regular expression	/(.*).dust.js$	Regex to apply to relative part of requests to generate template names. Should contain one and only matching group that will be used to infer template name

Using with Spring (and possibly others?)

Filter has a set of setters to use it as a component in DI framework like Spring. Spring provides a proxy servlet filter that can delegate filter processing to Spring-managed bean. To configure this, define your filter like this:

 <filter>
     <filter-name>dustCompilingFilter</filter-name>
     <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
 </filter>

 <filter-mapping>
     <filter-name>dustCompilingFilter</filter-name>
     <url-pattern>/*</url-pattern>
 </filter-mapping>
 

And define a bean with id dustCompilingFilterin your applicationContext.xml (NOT dispatcher servlet context)

 <bean name="dustCompilingFilter" class="me.noroutine.dust4j.DustCompilingFilter">
    <property name="compilerFactory">
        <bean class="me.noroutine.dust4j.DefaultDustCompilerFactory" />
    </property>
    <property name="cacheEnabled" value="true" />
    <property name="ETagEnabled" value="true" />
 </bean>
 

Since:

dust4j 0.1

Author:

Oleksii Khilkevych

Constructor Summary

Constructors

Constructor and Description
DustCompilingFilter()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp, javax.servlet.FilterChain chain)
static java.lang.String	getURL(javax.servlet.http.HttpServletRequest req)
void	init(javax.servlet.FilterConfig filterConfig)
void	setCacheEnabled(boolean cacheEnabled)
void	setCompilerFactory(DustCompilerFactory compilerFactory)
void	setETagEnabled(boolean eTagEnabled)
void	setTemplateNameRegex(java.lang.String templateNameRegex)

Methods inherited from class java.lang.Object

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

Constructor Detail

DustCompilingFilter

public DustCompilingFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest req,
            javax.servlet.ServletResponse resp,
            javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

java.io.IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

setCacheEnabled

public void setCacheEnabled(boolean cacheEnabled)

setETagEnabled

public void setETagEnabled(boolean eTagEnabled)

setCompilerFactory

public void setCompilerFactory(DustCompilerFactory compilerFactory)

setTemplateNameRegex

public void setTemplateNameRegex(java.lang.String templateNameRegex)

getURL

public static java.lang.String getURL(javax.servlet.http.HttpServletRequest req)