public final class

SitemeshPageFilter

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

Class Overview

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 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 startsWith(String))

Summary

Nested Classes
enum SitemeshPageFilter.InitParams  
Public Constructors
SitemeshPageFilter()
Public Methods
void destroy()
void doFilter(ServletRequest requestz, ServletResponse response, FilterChain chain)
void init(FilterConfig filterConfig)
[Expand]
Inherited Methods
From class com.opensymphony.sitemesh.webapp.SiteMeshFilter
From class java.lang.Object
From interface javax.servlet.Filter

Public Constructors

public SitemeshPageFilter ()

Public Methods

public void destroy ()

public void doFilter (ServletRequest requestz, ServletResponse response, FilterChain chain)

Throws
IOException
ServletException

public void init (FilterConfig filterConfig)