Class FilterRegistrationBean<T extends jakarta.servlet.Filter>

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

org.springframework.boot.web.servlet.DynamicRegistrationBean<jakarta.servlet.FilterRegistration.Dynamic>

org.springframework.boot.web.servlet.AbstractFilterRegistrationBean<T>

org.springframework.boot.web.servlet.FilterRegistrationBean<T>

Type Parameters:

T - the type of Filter to register

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, ServletContextInitializer, org.springframework.core.Ordered

public class FilterRegistrationBean<T extends jakarta.servlet.Filter>
extends AbstractFilterRegistrationBean<T>

A ServletContextInitializer to register Filters in a Servlet 3.0+ container. Similar to the registration features provided by ServletContext but with a Spring Bean friendly design.

The Filter must be specified before calling RegistrationBean.onStartup(ServletContext). Registrations can be associated with URL patterns and/or servlets (either by name or through a ServletRegistrationBeans). When no URL pattern or servlets are specified the filter will be associated to '/*'. The filter name will be deduced if not specified.

Since:

1.4.0

See Also:

• ServletContextInitializer
• ServletContext.addFilter(String, Filter)
• DelegatingFilterProxyRegistrationBean
• FilterRegistration

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
FilterRegistrationBean()	Create a new FilterRegistrationBean instance.
FilterRegistrationBean(T filter, ServletRegistrationBean<?>... servletRegistrationBeans)	Create a new FilterRegistrationBean instance to be registered with the specified ServletRegistrationBeans.

Method Summary

Modifier and Type	Method	Description
@Nullable T	getFilter()	Return the Filter to be registered.
void	setFilter(T filter)	Set the filter to be registered.

Methods inherited from class AbstractFilterRegistrationBean

addRegistration, addServletNames, addServletRegistrationBeans, addUrlPatterns, configure, determineDispatcherTypes, getDescription, getFilterName, getServletNames, getServletRegistrationBeans, getUrlPatterns, isMatchAfter, setDispatcherTypes, setDispatcherTypes, setMatchAfter, setServletNames, setServletRegistrationBeans, setUrlPatterns, toString

Methods inherited from class DynamicRegistrationBean

addInitParameter, getInitParameters, getOrDeduceName, isAsyncSupported, register, setAsyncSupported, setBeanName, setIgnoreRegistrationFailure, setInitParameters, setName

Methods inherited from class RegistrationBean

getOrder, isEnabled, onStartup, setEnabled, setOrder

Methods inherited from class Object

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

Constructor Details

FilterRegistrationBean

public FilterRegistrationBean()

Create a new FilterRegistrationBean instance.

FilterRegistrationBean

public FilterRegistrationBean(T filter,
 ServletRegistrationBean<?>... servletRegistrationBeans)

Create a new FilterRegistrationBean instance to be registered with the specified ServletRegistrationBeans.

Parameters:

filter - the filter to register

servletRegistrationBeans - associate ServletRegistrationBeans

Method Details

getFilter

public @Nullable T getFilter()

Description copied from class: AbstractFilterRegistrationBean

Return the Filter to be registered.

Specified by:

getFilter in class AbstractFilterRegistrationBean<T extends jakarta.servlet.Filter>

Returns:

the filter

setFilter

public void setFilter(T filter)

Set the filter to be registered.

Parameters:

filter - the filter