org.springframework.boot.web.servlet

Class DelegatingFilterProxyRegistrationBean

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

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

org.springframework.boot.web.servlet.DelegatingFilterProxyRegistrationBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, ServletContextInitializer, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered

public class DelegatingFilterProxyRegistrationBean
extends DynamicRegistrationBean<javax.servlet.FilterRegistration.Dynamic>
implements org.springframework.context.ApplicationContextAware

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

The bean name of the actual delegate Filter should be specified using the targetBeanName constructor argument. Unlike the FilterRegistrationBean, referenced filters are not instantiated early. In fact, if the delegate filter bean is marked @Lazy it won't be instantiated at all until the filter is called.

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 targetBeanName will be used as the filter name if not otherwise specified.

Since:

1.4.0

Author:

Phillip Webb

See Also:

ServletContextInitializer, ServletContext.addFilter(String, Filter), FilterRegistrationBean, DelegatingFilterProxy

Field Summary

Fields

Modifier and Type	Field and Description
protected 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
DelegatingFilterProxyRegistrationBean(String targetBeanName, ServletRegistrationBean<?>... servletRegistrationBeans) Create a new DelegatingFilterProxyRegistrationBean instance to be registered with the specified ServletRegistrationBeans.

Method Summary

Modifier and Type	Method and Description
protected javax.servlet.FilterRegistration.Dynamic	addRegistration(String description, javax.servlet.ServletContext servletContext)
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 that the filter will be registered against.
protected void	configure(javax.servlet.FilterRegistration.Dynamic registration) Configure registration settings.
protected String	getDescription() Return a description of the registration.
org.springframework.web.filter.DelegatingFilterProxy	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.
protected String	getTargetBeanName()
Collection<String>	getUrlPatterns() Return a mutable collection of URL patterns 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	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
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	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.

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, toString, wait, wait, wait

Field Detail

REQUEST_WRAPPER_FILTER_MAX_ORDER

protected 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

DelegatingFilterProxyRegistrationBean

public DelegatingFilterProxyRegistrationBean(String targetBeanName,
                                             ServletRegistrationBean<?>... servletRegistrationBeans)

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

Parameters:

targetBeanName - name of the target filter bean to look up in the Spring application context (must not be null).

servletRegistrationBeans - associate ServletRegistrationBeans

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getTargetBeanName

protected String getTargetBeanName()

getFilter

public org.springframework.web.filter.DelegatingFilterProxy getFilter()

Return the Filter to be registered.

Returns:

the filter

setServletRegistrationBeans

public void setServletRegistrationBeans(Collection<? extends ServletRegistrationBean<?>> servletRegistrationBeans)

Set ServletRegistrationBeans that the filter will be registered against.

Parameters:

servletRegistrationBeans - the Servlet registration beans

getServletRegistrationBeans

public Collection<ServletRegistrationBean<?>> getServletRegistrationBeans()

Return a mutable collection of the ServletRegistrationBean that the filter will be registered against. ServletRegistrationBeans.

Returns:

the Servlet registration beans

See Also:

setServletNames(java.util.Collection<java.lang.String>), setUrlPatterns(java.util.Collection<java.lang.String>)

addServletRegistrationBeans

public void addServletRegistrationBeans(ServletRegistrationBean<?>... servletRegistrationBeans)

Add ServletRegistrationBeans for the filter.

Parameters:

servletRegistrationBeans - the servlet registration beans to add

See Also:

setServletRegistrationBeans(java.util.Collection<? extends org.springframework.boot.web.servlet.ServletRegistrationBean<?>>)

setServletNames

public void setServletNames(Collection<String> servletNames)

Set servlet names that the filter will be registered against. This will replace any previously specified servlet names.

Parameters:

servletNames - the servlet names

See Also:

setServletRegistrationBeans(java.util.Collection<? extends org.springframework.boot.web.servlet.ServletRegistrationBean<?>>), setUrlPatterns(java.util.Collection<java.lang.String>)

getServletNames

public Collection<String> getServletNames()

Return a mutable collection of servlet names that the filter will be registered against.

Returns:

the servlet names

addServletNames

public void addServletNames(String... servletNames)

Add servlet names for the filter.

Parameters:

servletNames - the servlet names to add

setUrlPatterns

public void setUrlPatterns(Collection<String> urlPatterns)

Set the URL patterns that the filter will be registered against. This will replace any previously specified URL patterns.

Parameters:

urlPatterns - the URL patterns

See Also:

setServletRegistrationBeans(java.util.Collection<? extends org.springframework.boot.web.servlet.ServletRegistrationBean<?>>), setServletNames(java.util.Collection<java.lang.String>)

getUrlPatterns

public Collection<String> getUrlPatterns()

Return a mutable collection of URL patterns that the filter will be registered against.

Returns:

the URL patterns

addUrlPatterns

public void addUrlPatterns(String... urlPatterns)

Add URL patterns that the filter will be registered against.

Parameters:

urlPatterns - the URL patterns

setDispatcherTypes

public void setDispatcherTypes(javax.servlet.DispatcherType first,
                               javax.servlet.DispatcherType... rest)

Convenience method to set dispatcher types using the specified elements.

Parameters:

first - the first dispatcher type

rest - additional dispatcher types

setDispatcherTypes

public void setDispatcherTypes(EnumSet<javax.servlet.DispatcherType> dispatcherTypes)

Sets the dispatcher types that should be used with the registration. If not specified the types will be deduced based on the value of DynamicRegistrationBean.isAsyncSupported().

Parameters:

dispatcherTypes - the dispatcher types

setMatchAfter

public void setMatchAfter(boolean matchAfter)

Set if the filter mappings should be matched after any declared filter mappings of the ServletContext. Defaults to false indicating the filters are supposed to be matched before any declared filter mappings of the ServletContext.

Parameters:

matchAfter - if filter mappings are matched after

isMatchAfter

public boolean isMatchAfter()

Return if filter mappings should be matched after any declared Filter mappings of the ServletContext.

Returns:

if filter mappings are matched after

getDescription

protected String getDescription()

Description copied from class: RegistrationBean

Return a description of the registration. For example "Servlet resourceServlet"

Specified by:

getDescription in class RegistrationBean

Returns:

a description of the registration

addRegistration

protected javax.servlet.FilterRegistration.Dynamic addRegistration(String description,
                                                                   javax.servlet.ServletContext servletContext)

Specified by:

addRegistration in class DynamicRegistrationBean<javax.servlet.FilterRegistration.Dynamic>

configure

protected void configure(javax.servlet.FilterRegistration.Dynamic registration)

Configure registration settings. Subclasses can override this method to perform additional configuration if required.

Overrides:

configure in class DynamicRegistrationBean<javax.servlet.FilterRegistration.Dynamic>

Parameters:

registration - the registration