public class DelegatingFilterProxyRegistrationBean extends AbstractFilterRegistrationBean<org.springframework.web.filter.DelegatingFilterProxy> implements org.springframework.context.ApplicationContextAware
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.
ServletContextInitializer,
ServletContext.addFilter(String, Filter),
FilterRegistrationBean,
DelegatingFilterProxy| Constructor and Description |
|---|
DelegatingFilterProxyRegistrationBean(java.lang.String targetBeanName,
ServletRegistrationBean<?>... servletRegistrationBeans)
Create a new
DelegatingFilterProxyRegistrationBean instance to be
registered with the specified ServletRegistrationBeans. |
| Modifier and Type | Method and Description |
|---|---|
org.springframework.web.filter.DelegatingFilterProxy |
getFilter()
Return the
Filter to be registered. |
protected java.lang.String |
getTargetBeanName() |
void |
setApplicationContext(org.springframework.context.ApplicationContext applicationContext) |
addRegistration, addServletNames, addServletRegistrationBeans, addUrlPatterns, configure, getDescription, getServletNames, getServletRegistrationBeans, getUrlPatterns, isMatchAfter, setDispatcherTypes, setDispatcherTypes, setMatchAfter, setServletNames, setServletRegistrationBeans, setUrlPatterns, toStringaddInitParameter, getInitParameters, getOrDeduceName, isAsyncSupported, register, setAsyncSupported, setInitParameters, setNamegetOrder, isEnabled, onStartup, setEnabled, setOrderpublic DelegatingFilterProxyRegistrationBean(java.lang.String targetBeanName,
ServletRegistrationBean<?>... servletRegistrationBeans)
DelegatingFilterProxyRegistrationBean instance to be
registered with the specified ServletRegistrationBeans.targetBeanName - name of the target filter bean to look up in the Spring
application context (must not be null).servletRegistrationBeans - associate ServletRegistrationBeanspublic void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
throws org.springframework.beans.BeansException
setApplicationContext in interface org.springframework.context.ApplicationContextAwareorg.springframework.beans.BeansExceptionprotected java.lang.String getTargetBeanName()
public org.springframework.web.filter.DelegatingFilterProxy getFilter()
AbstractFilterRegistrationBeanFilter to be registered.getFilter in class AbstractFilterRegistrationBean<org.springframework.web.filter.DelegatingFilterProxy>