org.openmrs.module.web.filter

Class ModuleFilterChain

java.lang.Object

org.openmrs.module.web.filter.ModuleFilterChain

All Implemented Interfaces:

javax.servlet.FilterChain

public class ModuleFilterChain
extends Object
implements javax.servlet.FilterChain

This class is an implementation of FilterChain for use in using Filters defined within Modules. It enables the Module system to iterate through all of the defined Filters before continuing down the initial filter chain.

Method Summary

Modifier and Type	Method and Description
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) This Iterates across all of the Filters defined by modules before handing control back over to the initial filter chain to continue on.
static ModuleFilterChain	getInstance(Collection<javax.servlet.Filter> filters, javax.servlet.FilterChain initialFilterChain) Factory method to construct and return a ModuleFilterChain

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ModuleFilterChain getInstance(Collection<javax.servlet.Filter> filters,
                                            javax.servlet.FilterChain initialFilterChain)

Factory method to construct and return a ModuleFilterChain

Parameters:

filters: - The Collection of Filters that this FilterChain will iterate over before returning control back the the initialFilterChain

initialFilterChain: - The FilterChain to return control to once all of the Filters have been executed

Returns:

The ModuleFilterChain that is fully initialized with the passed parameters

doFilter

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

This Iterates across all of the Filters defined by modules before handing control back over to the initial filter chain to continue on.

Specified by:

doFilter in interface javax.servlet.FilterChain

Throws:

javax.servlet.ServletException

IOException

See Also:

FilterChain.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse)