org.apache.tiles.web
Class TilesDecorationFilter

Package class diagram package TilesDecorationFilter
java.lang.Object
  extended by org.apache.tiles.web.TilesDecorationFilter
All Implemented Interfaces:
javax.servlet.Filter

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

Decoration Filter. Intercepts all requests and decorates them with the configured definition.

For example, given the following config:

<filter> <filter-name>Tiles Decoration Filter</filter-name> <filter-class>org.apache.tiles.web.TilesDecorationFilter</filter-class> <init-param> <param-name>definition</param-name> <param-value>test.definition</param-value> </init-param> <init-param> <param-name>attribute-name</param-name> <param-value>body</param-value> </init-param> </filter> <p/> <filter-mapping> <filter-name>Tiles Decoration Filter</filter-name> <url-pattern>/testdecorationfilter.jsp</url-pattern> <dispatcher>REQUEST</dispatcher> </filter-mapping> The filter will intercept all requests to the indicated url pattern store the initial request path as the "body" component attribute and then render the "test.definition" definition.


Constructor Summary
TilesDecorationFilter()
           
 
Method Summary
 void destroy()
           
 void doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain filterChain)
           
 javax.servlet.FilterConfig getFilterConfig()
           
 javax.servlet.ServletContext getServletContext()
           
 void init(javax.servlet.FilterConfig config)
           
protected  java.util.Map<java.lang.String,java.lang.String> parseAlternateDefinitions()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TilesDecorationFilter

public TilesDecorationFilter()
Method Detail

getFilterConfig

public javax.servlet.FilterConfig getFilterConfig()

getServletContext

public javax.servlet.ServletContext getServletContext()

init

public void init(javax.servlet.FilterConfig config)
          throws javax.servlet.ServletException
Specified by:
init in interface javax.servlet.Filter
Throws:
javax.servlet.ServletException

parseAlternateDefinitions

protected java.util.Map<java.lang.String,java.lang.String> parseAlternateDefinitions()

destroy

public void destroy()
Specified by:
destroy in interface javax.servlet.Filter

doFilter

public void doFilter(javax.servlet.ServletRequest req,
                     javax.servlet.ServletResponse res,
                     javax.servlet.FilterChain filterChain)
              throws java.io.IOException,
                     javax.servlet.ServletException
Specified by:
doFilter in interface javax.servlet.Filter
Throws:
java.io.IOException
javax.servlet.ServletException