com.atlassian.jira.web.filters
Class SitemeshPageFilter

java.lang.Object
  com.opensymphony.sitemesh.webapp.SiteMeshFilter
      com.atlassian.jira.web.filters.SitemeshPageFilter

All Implemented Interfaces:

javax.servlet.Filter

public final class SitemeshPageFilter
extends com.opensymphony.sitemesh.webapp.SiteMeshFilter

This Sitemesh page filter adds HTTP request header-driven exclusions to the standard PageFilter. Decoration can be skipped based on the present of certain HTTP request headers, or based on the requested path.

This filter accepts two initialization parameters:

• exclude.paths: comma-separated list of excluded servlet paths (REQUIRED)
• exclude.headers: name of HTTP request headers

The excluded paths patterns in the list may come in two forms:

• exact pattern - exact servlet path that will be matched by means of the String.equals(Object) method
• wildcard pattern - part of the path followed by the '*' (wildcard) character, will match against all requests, whose servlet path starts with the pattern (by means of String.startsWith(String))

Since:

v4.2

Nested Class Summary

static class

SitemeshPageFilter.InitParams

Constructor Summary

SitemeshPageFilter()

Method Summary

void	destroy()
void	doFilter(javax.servlet.ServletRequest requestz, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig filterConfig)

Methods inherited from class com.opensymphony.sitemesh.webapp.SiteMeshFilter

initContentProcessor, initDecoratorSelector

Methods inherited from class java.lang.Object

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

Constructor Detail

SitemeshPageFilter

public SitemeshPageFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)

Specified by:

init in interface javax.servlet.Filter

Overrides:

init in class com.opensymphony.sitemesh.webapp.SiteMeshFilter

doFilter

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

Specified by:

doFilter in interface javax.servlet.Filter

Overrides:

doFilter in class com.opensymphony.sitemesh.webapp.SiteMeshFilter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

Overrides:

destroy in class com.opensymphony.sitemesh.webapp.SiteMeshFilter