org.springframework.boot.web.servlet

Class FilterRegistrationBean

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

org.springframework.boot.web.servlet.AbstractFilterRegistrationBean

org.springframework.boot.web.servlet.FilterRegistrationBean

All Implemented Interfaces:

ServletContextInitializer, org.springframework.core.Ordered

public class FilterRegistrationBean
extends AbstractFilterRegistrationBean

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 AbstractFilterRegistrationBean.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

Author:

Phillip Webb

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	REQUEST_WRAPPER_FILTER_MAX_ORDER Filters that wrap the servlet request should be ordered less than or equal to this.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
FilterRegistrationBean() Create a new FilterRegistrationBean instance.
FilterRegistrationBean(javax.servlet.Filter filter, ServletRegistrationBean... servletRegistrationBeans) Create a new FilterRegistrationBean instance to be registered with the specified ServletRegistrationBeans.

Method Summary

Modifier and Type	Method and Description
javax.servlet.Filter	getFilter() Return the Filter to be registered.
void	setFilter(javax.servlet.Filter filter) Set the filter to be registered.

Methods inherited from class org.springframework.boot.web.servlet.AbstractFilterRegistrationBean

addServletNames, addServletRegistrationBeans, addUrlPatterns, configure, getServletNames, getServletRegistrationBeans, getUrlPatterns, isMatchAfter, onStartup, setDispatcherTypes, setDispatcherTypes, setMatchAfter, setServletNames, setServletRegistrationBeans, setUrlPatterns

Methods inherited from class org.springframework.boot.web.servlet.RegistrationBean

addInitParameter, configure, getInitParameters, getOrDeduceName, getOrder, isAsyncSupported, isEnabled, setAsyncSupported, setEnabled, setInitParameters, setName, setOrder

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_WRAPPER_FILTER_MAX_ORDER

public static final int 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(javax.servlet.Filter 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 javax.servlet.Filter getFilter()

Description copied from class: AbstractFilterRegistrationBean

Return the Filter to be registered.

Specified by:

getFilter in class AbstractFilterRegistrationBean

Returns:

the filter

setFilter

public void setFilter(javax.servlet.Filter filter)

Set the filter to be registered.

Parameters:

filter - the filter