com.atlassian.jira.web.filters
Class PathExclusionFilter

java.lang.Object
  com.atlassian.core.filters.AbstractHttpFilter
      com.atlassian.jira.web.filters.PathExclusionFilter

All Implemented Interfaces:

javax.servlet.Filter

public final class PathExclusionFilter
extends com.atlassian.core.filters.AbstractHttpFilter

A decorating filter that is configured with a set of excluded servlet paths, basing upon which it decides to run the decorated filter over a particular request.

This filter requires two initialization parameters:

• path.exclusion.filter.className - name of the wrapped filter class
• path.exclusion.filter.paths - comma-separated list of excluded servlet paths

The decorated filter is instantiated from a class name read from an init parameter. If the instantiation fails, an IllegalStateException is raised from within the init(javax.servlet.FilterConfig) method.

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

PathExclusionFilter.InitParams

Constructor Summary

PathExclusionFilter()

Method Summary

void	destroy()
void	doFilter(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig filterConfig) Initializes the path instantiates the wrapped filter

Methods inherited from class com.atlassian.core.filters.AbstractHttpFilter

doFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

PathExclusionFilter

public PathExclusionFilter()

Method Detail

init

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

Initializes the path instantiates the wrapped filter

Specified by:

init in interface javax.servlet.Filter

Overrides:

init in class com.atlassian.core.filters.AbstractHttpFilter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in class com.atlassian.core.filters.AbstractHttpFilter

Throws:

java.io.IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

Overrides:

destroy in class com.atlassian.core.filters.AbstractHttpFilter