com.atlassian.johnson.plugin.servlet.filter

Class JohnsonServletFilterModuleContainerFilter

java.lang.Object

com.atlassian.plugin.servlet.filter.ServletFilterModuleContainerFilter

com.atlassian.johnson.plugin.servlet.filter.JohnsonServletFilterModuleContainerFilter

All Implemented Interfaces:

javax.servlet.Filter

public class JohnsonServletFilterModuleContainerFilter
extends com.atlassian.plugin.servlet.filter.ServletFilterModuleContainerFilter

Extends the plugin framework's ServletFilterModuleContainerFilter to bypass servlet-provided filters when Johnson events are present.

When the system is Johnsoned, the exact set of resources that are available is unknown. In some cases, that can cause plugin-provided filters which attempt to access those resources to fail in an unexpected ways. That, in turn can block access to Johnson's error page, or even hang request threads. Replacing the standard filter with this Johnson-aware version ensures servlet-provided filters are automatically bypassed while Johnson events are present.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
JohnsonServletFilterModuleContainerFilter()

Method Summary

Modifier and Type	Method and Description
protected boolean	bypassFilters() Determines whether plugin-provided filters should be bypassed.
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) Checks whether plugin-provided filters should be bypassed and, if so, directly invokes the FilterChain; otherwise, processes super.doFilter normally.
protected JohnsonEventContainer	getEventContainer() Retrieves the JohnsonEventContainer using the FilterConfig's ServletContext.

Methods inherited from class com.atlassian.plugin.servlet.filter.ServletFilterModuleContainerFilter

destroy, getFilterConfig, getFilterLocation, getServletModuleManager, init

Methods inherited from class java.lang.Object

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

Constructor Detail

JohnsonServletFilterModuleContainerFilter

public JohnsonServletFilterModuleContainerFilter()

Method Detail

doFilter

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

Checks whether plugin-provided filters should be bypassed and, if so, directly invokes the FilterChain; otherwise, processes super.doFilter normally.

Specified by:

doFilter in interface javax.servlet.Filter

Overrides:

doFilter in class com.atlassian.plugin.servlet.filter.ServletFilterModuleContainerFilter

Parameters:

request - the request

response - the response

chain - the remaining filter chain

Throws:

IOException - if thrown by the base class, or the FilterChain

javax.servlet.ServletException - if thrown by the base class, or the FilterChain

bypassFilters

protected boolean bypassFilters()

Determines whether plugin-provided filters should be bypassed. The default implementation bypasses plugin- provided filters whenever there are events in the container.

Applications can override this method in subclasses to apply a more specific set of restrictions. For example, they could choose to allow plugin-provided filters to be applied in specific Johnson states, or based on other knowledge of the application as a whole.

Returns:

true if plugin-provided filters should be bypassed; otherwise, false to apply plugin-provided filters normally

getEventContainer

protected JohnsonEventContainer getEventContainer()

Retrieves the JohnsonEventContainer using the FilterConfig's ServletContext.

Returns:

the JohnsonEventContainer