Package com.opensymphony.sitemesh.webapp

Class SiteMeshFilter

java.lang.Object

com.opensymphony.sitemesh.webapp.SiteMeshFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

MultipassFilter, PageFilter

public class SiteMeshFilter
extends Object
implements javax.servlet.Filter

Core Filter for integrating SiteMesh into a Java web application.

Since:

SiteMesh 3

Author:

Joe Walnes, Scott Farquhar

Constructor Summary

Constructors

Constructor	Description
SiteMeshFilter()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest rq, javax.servlet.ServletResponse rs, javax.servlet.FilterChain chain)	Main method of the Filter.
void	init(javax.servlet.FilterConfig filterConfig)
protected ContentProcessor	initContentProcessor(SiteMeshWebAppContext webAppContext)	Inits the content processor.
protected DecoratorSelector	initDecoratorSelector(SiteMeshWebAppContext webAppContext)	Inits the decorator selector.

Methods inherited from class java.lang.Object

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

Constructor Details

SiteMeshFilter

public SiteMeshFilter()

Method Details

init

public void init(javax.servlet.FilterConfig filterConfig)

Specified by:

init in interface javax.servlet.Filter

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

doFilter

public void doFilter(javax.servlet.ServletRequest rq,
 javax.servlet.ServletResponse rs,
 javax.servlet.FilterChain chain)
              throws IOException,
javax.servlet.ServletException

Main method of the Filter.

Checks if the Filter has been applied this request. If not, parses the page and applies Decorator (if found).

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

initContentProcessor

protected ContentProcessor initContentProcessor(SiteMeshWebAppContext webAppContext)

Inits the content processor.

Parameters:

webAppContext - the web app context

Returns:

the content processor

initDecoratorSelector

protected DecoratorSelector initDecoratorSelector(SiteMeshWebAppContext webAppContext)

Inits the decorator selector.

Parameters:

webAppContext - the web app context

Returns:

the decorator selector