FilterRegistrationBean (Spring Boot API)

java.lang.Object
- org.springframework.boot.web.servlet.RegistrationBean
- - org.springframework.boot.web.servlet.DynamicRegistrationBean<javax.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:
ServletContextInitializer, org.springframework.core.Ordered
```
public class FilterRegistrationBean<T extends javax.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 via 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

Field Summary
Fields
Modifier and Type Field Description
static int REQUEST_WRAPPER_FILTER_MAX_ORDER
Deprecated.
since 2.1.0 in favor of OrderedFilter.REQUEST_WRAPPER_FILTER_MAX_ORDER
- 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 `ServletRegistrationBean`s.

Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type Method Description
T getFilter()
Return the Filter to be registered.
void setFilter(T filter)
Set the filter to be registered.
- Methods inherited from class org.springframework.boot.web.servlet.AbstractFilterRegistrationBean
  addRegistration, addServletNames, addServletRegistrationBeans, addUrlPatterns, configure, getDescription, getServletNames, getServletRegistrationBeans, getUrlPatterns, isMatchAfter, setDispatcherTypes, setDispatcherTypes, setMatchAfter, setServletNames, setServletRegistrationBeans, setUrlPatterns, toString
- Methods inherited from class org.springframework.boot.web.servlet.DynamicRegistrationBean
  addInitParameter, getInitParameters, getOrDeduceName, isAsyncSupported, register, setAsyncSupported, setInitParameters, setName
- Methods inherited from class org.springframework.boot.web.servlet.RegistrationBean
  getOrder, isEnabled, onStartup, setEnabled, setOrder
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - REQUEST_WRAPPER_FILTER_MAX_ORDER
```
@Deprecated
public static final int REQUEST_WRAPPER_FILTER_MAX_ORDER
```
    Deprecated.
    since 2.1.0 in favor of OrderedFilter.REQUEST_WRAPPER_FILTER_MAX_ORDER
    Filters that wrap the servlet request should be ordered less than or equal to this.
    See Also:
    Constant Field Values
- Constructor Detail
  - 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 Detail
  - getFilter
```
public T getFilter()
```
    Description copied from class: AbstractFilterRegistrationBean
    Return the Filter to be registered.
    Specified by:
    getFilter in class AbstractFilterRegistrationBean<T extends javax.servlet.Filter>
    Returns:
    the filter
  - setFilter
```
public void setFilter(T filter)
```
    Set the filter to be registered.
    Parameters:
    filter - the filter