com.github.stefanbirkner.filtertools.filter

Class EncasedFilters

java.lang.Object

com.github.stefanbirkner.filtertools.filter.EncasedFilters

All Implemented Interfaces:

javax.servlet.Filter

public class EncasedFilters
extends Object
implements javax.servlet.Filter

Encase multiple filters into a single filter.

This allows you to include multiple filters into your web.xml by including a single filter. You can provide recommended filter combinations as a single filter, too.

Example

The filter

 public class MyEncasedFilters extends EncasedFilters {
   public MyEncasedFilters() {
     super(MyFirstFilter(), MySecondFilter());
   }
 }
 

 <filter>
   <filter-name>MyEncasedFilters</filter-name>
   <filter-class>my.package.MyEncasedFilters</filter-class>
 </filter>
 <filter-mapping>
   <filter-name>MyEncasedFilters</filter-name>
   <url-pattern>/*</url-pattern>
 </filter-mapping>
 

is a replacement for

 <filter>
   <filter-name>MyFirstFilter</filter-name>
   <filter-class>my.package.MyFirstFilter</filter-class>
 </filter>
 <filter>
   <filter-name>MySecondFilter</filter-name>
   <filter-class>my.package.MySecondFilter</filter-class>
 </filter>
 <filter-mapping>
   <filter-name>MyFirstFilter</filter-name>
   <url-pattern>/*</url-pattern>
 </filter-mapping>
 <filter-mapping>
   <filter-name>MySecondFilter</filter-name>
   <url-pattern>/*</url-pattern>
 </filter-mapping>
 

Constructor Summary

Constructors

Constructor and Description
EncasedFilters(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 filterChain)
void	init(javax.servlet.FilterConfig filterConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

EncasedFilters

public EncasedFilters(javax.servlet.Filter... filters)

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          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 filterChain)
              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