Class CompositeFilter

java.lang.Object
org.springframework.web.filter.CompositeFilter
All Implemented Interfaces:
jakarta.servlet.Filter
public class CompositeFilter extends Object implements jakarta.servlet.Filter
A generic composite servlet Filter that just delegates its behavior to a chain (list) of user-supplied filters, achieving the functionality of a FilterChain, but conveniently using only Filter instances.

This is useful for filters that require dependency injection, and can therefore be set up in a Spring application context. Typically, this composite would be used in conjunction with DelegatingFilterProxy, so that it can be declared in Spring but applied to a servlet context.

Since:
3.1
Author:
Dave Syer

  • Constructor Summary

    Constructors
    Constructor
    Description
    CompositeFilter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    destroy()
    Clean up all the filters supplied, calling each one's destroy method in turn, but in reverse order.
    void
    doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
    Forms a temporary chain from the list of delegate filters supplied (setFilters(List)) and executes them in order.
    void
    init(jakarta.servlet.FilterConfig config)
    Initialize all the filters, calling each one's init method in turn in the order supplied.
    void
    setFilters(List<? extends jakarta.servlet.Filter> filters)
     

    Methods inherited from class Object

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

  • Constructor Details

    • CompositeFilter

      public CompositeFilter()

  • Method Details

    • setFilters

      public void setFilters(List<? extends jakarta.servlet.Filter> filters)

    • init

      public void init(jakarta.servlet.FilterConfig config) throws jakarta.servlet.ServletException
      Initialize all the filters, calling each one's init method in turn in the order supplied.
      Specified by:
      init in interface jakarta.servlet.Filter
      Throws:
      jakarta.servlet.ServletException
      See Also:
      • Filter.init(FilterConfig)

    • doFilter

      public void doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) throws IOException, jakarta.servlet.ServletException
      Forms a temporary chain from the list of delegate filters supplied (setFilters(List)) and executes them in order. Each filter delegates to the next one in the list, achieving the normal behavior of a FilterChain, despite the fact that this is a Filter.
      Specified by:
      doFilter in interface jakarta.servlet.Filter
      Throws:
      IOException
      jakarta.servlet.ServletException
      See Also:
      • Filter.doFilter(ServletRequest, ServletResponse, FilterChain)

    • destroy

      public void destroy()
      Clean up all the filters supplied, calling each one's destroy method in turn, but in reverse order.
      Specified by:
      destroy in interface jakarta.servlet.Filter
      See Also:
      • Filter.init(FilterConfig)