com.github.bordertech.taskmaster.servlet.combo

Class AbstractComboFilter

java.lang.Object

com.github.bordertech.taskmaster.servlet.combo.AbstractComboFilter

All Implemented Interfaces:

javax.servlet.Filter

public abstract class AbstractComboFilter
extends Object
implements javax.servlet.Filter

Combo Filter that allows a group of Filters to be defined in one class.

This allows multiple filters to be easily annotated in one class instead of multiple entries in a web.xml.

The class is abstract as projects are expected to extend this class and annotate it with the WebFilter annotation.

See Also:

WebFilter, Filter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractComboFilter(javax.servlet.Filter filter, javax.servlet.Filter... filters)
protected	AbstractComboFilter(List<javax.servlet.Filter> filters)

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
List<javax.servlet.Filter>	getFilters()
void	init(javax.servlet.FilterConfig config)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractComboFilter

protected AbstractComboFilter(javax.servlet.Filter filter,
                              javax.servlet.Filter... filters)

Parameters:

filter - the first filter to combine

filters - the other filters to combine into a single filter

AbstractComboFilter

protected AbstractComboFilter(List<javax.servlet.Filter> filters)

Parameters:

filters - the group of filters to combine into a single filter

Method Detail

getFilters

public final List<javax.servlet.Filter> getFilters()

Returns:

the list of filters to be combined

init

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

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

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

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter