spring-framework / org.springframework.web.filter / CompositeFilter

CompositeFilter

open class CompositeFilter : 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.

Author
Dave Syer

Since
3.1

Constructors

<init>

CompositeFilter()

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.

Functions

destroy

open fun destroy(): Unit

Clean up all the filters supplied, calling each one's destroy method in turn, but in reverse order.

doFilter

open fun doFilter(request: ServletRequest, response: ServletResponse, chain: FilterChain): Unit

Forms a temporary chain from the list of delegate filters supplied (#setFilters) 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.

init

open fun init(config: FilterConfig): Unit

Initialize all the filters, calling each one's init method in turn in the order supplied.

setFilters

open fun setFilters(filters: MutableList<out Filter>): Unit