public class FilterRegistrationBean extends RegistrationBean
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
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.
ServletContextInitializer,
ServletContext.addFilter(String, Filter),
DelegatingFilterProxyRegistrationBean| 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.
|
| 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. |
| Modifier and Type | Method and Description |
|---|---|
void |
addServletNames(String... servletNames)
Add servlet names for the filter.
|
void |
addServletRegistrationBeans(ServletRegistrationBean... servletRegistrationBeans)
Add
ServletRegistrationBeans for the filter. |
void |
addUrlPatterns(String... urlPatterns)
Add URL patterns, as defined in the Servlet specification, that the filter will be
registered against.
|
protected void |
configure(javax.servlet.FilterRegistration.Dynamic registration)
Configure registration settings.
|
javax.servlet.Filter |
getFilter()
Return the
Filter to be registered. |
Collection<String> |
getServletNames()
Return a mutable collection of servlet names that the filter will be registered
against.
|
Collection<ServletRegistrationBean> |
getServletRegistrationBeans()
Return a mutable collection of the
ServletRegistrationBean that the filter
will be registered against. |
Collection<String> |
getUrlPatterns()
Return a mutable collection of URL patterns, as defined in the Servlet
specification, that the filter will be registered against.
|
boolean |
isMatchAfter()
Return if filter mappings should be matched after any declared Filter mappings of
the ServletContext.
|
void |
onStartup(javax.servlet.ServletContext servletContext)
Configure the given
ServletContext with any servlets, filters, listeners
context-params and attributes necessary for initialization. |
void |
setDispatcherTypes(javax.servlet.DispatcherType first,
javax.servlet.DispatcherType... rest)
Convenience method to
set dispatcher types
using the specified elements. |
void |
setDispatcherTypes(EnumSet<javax.servlet.DispatcherType> dispatcherTypes)
Sets the dispatcher types that should be used with the registration.
|
void |
setFilter(javax.servlet.Filter filter)
Set the filter to be registered.
|
void |
setMatchAfter(boolean matchAfter)
Set if the filter mappings should be matched after any declared filter mappings of
the ServletContext.
|
void |
setServletNames(Collection<String> servletNames)
Set servlet names that the filter will be registered against.
|
void |
setServletRegistrationBeans(Collection<? extends ServletRegistrationBean> servletRegistrationBeans)
Set
ServletRegistrationBeans that the filter will be registered against. |
void |
setUrlPatterns(Collection<String> urlPatterns)
Set the URL patterns that the filter will be registered against.
|
addInitParameter, configure, getInitParameters, getOrDeduceName, getOrder, isAsyncSupported, isEnabled, setAsyncSupported, setEnabled, setInitParameters, setName, setOrderpublic static final int REQUEST_WRAPPER_FILTER_MAX_ORDER
public FilterRegistrationBean()
FilterRegistrationBean instance.public FilterRegistrationBean(javax.servlet.Filter filter,
ServletRegistrationBean... servletRegistrationBeans)
FilterRegistrationBean instance to be registered with the
specified ServletRegistrationBeans.filter - the filter to registerservletRegistrationBeans - associate ServletRegistrationBeanspublic javax.servlet.Filter getFilter()
Filter to be registered.public void setFilter(javax.servlet.Filter filter)
filter - the filterpublic void setServletRegistrationBeans(Collection<? extends ServletRegistrationBean> servletRegistrationBeans)
ServletRegistrationBeans that the filter will be registered against.servletRegistrationBeans - the Servlet registration beanspublic Collection<ServletRegistrationBean> getServletRegistrationBeans()
ServletRegistrationBean that the filter
will be registered against. ServletRegistrationBeans.setServletNames(java.util.Collection<java.lang.String>),
setUrlPatterns(java.util.Collection<java.lang.String>)public void addServletRegistrationBeans(ServletRegistrationBean... servletRegistrationBeans)
ServletRegistrationBeans for the filter.servletRegistrationBeans - the servlet registration beans to addsetServletRegistrationBeans(java.util.Collection<? extends org.springframework.boot.web.servlet.ServletRegistrationBean>)public void setServletNames(Collection<String> servletNames)
servletNames - the servlet namessetServletRegistrationBeans(java.util.Collection<? extends org.springframework.boot.web.servlet.ServletRegistrationBean>),
setUrlPatterns(java.util.Collection<java.lang.String>)public Collection<String> getServletNames()
public void addServletNames(String... servletNames)
servletNames - the servlet names to addpublic void setUrlPatterns(Collection<String> urlPatterns)
urlPatterns - the URL patternssetServletRegistrationBeans(java.util.Collection<? extends org.springframework.boot.web.servlet.ServletRegistrationBean>),
setServletNames(java.util.Collection<java.lang.String>)public Collection<String> getUrlPatterns()
public void addUrlPatterns(String... urlPatterns)
urlPatterns - the URL patternspublic void setDispatcherTypes(javax.servlet.DispatcherType first,
javax.servlet.DispatcherType... rest)
set dispatcher types
using the specified elements.first - the first dispatcher typerest - additional dispatcher typespublic void setDispatcherTypes(EnumSet<javax.servlet.DispatcherType> dispatcherTypes)
RegistrationBean.isAsyncSupported().dispatcherTypes - the dispatcher typespublic void setMatchAfter(boolean matchAfter)
false indicating the filters are supposed
to be matched before any declared filter mappings of the ServletContext.matchAfter - if filter mappings are matched afterpublic boolean isMatchAfter()
public void onStartup(javax.servlet.ServletContext servletContext)
throws javax.servlet.ServletException
ServletContextInitializerServletContext with any servlets, filters, listeners
context-params and attributes necessary for initialization.servletContext - the ServletContext to initializejavax.servlet.ServletException - if any call against the given ServletContext
throws a ServletExceptionprotected void configure(javax.servlet.FilterRegistration.Dynamic registration)
registration - the registrationCopyright © 2018 Pivotal Software, Inc.. All rights reserved.