|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.web.filter.GenericFilterBean org.springframework.security.web.FilterChainProxy
public class FilterChainProxy
Delegates Filter
requests to a list of Spring-managed filter beans.
As of version 2.0, you shouldn't need to explicitly configure a FilterChainProxy
bean in your application
context unless you need very fine control over the filter chain contents. Most cases should be adequately covered
by the default <security:http /> namespace configuration options.
The FilterChainProxy
is loaded via a standard Spring DelegatingFilterProxy
declaration in
web.xml
. FilterChainProxy
will then pass GenericFilterBean.init(FilterConfig)
, GenericFilterBean.destroy()
and doFilter(ServletRequest, ServletResponse, FilterChain)
invocations through to each Filter
defined against FilterChainProxy
.
As of version 2.0, FilterChainProxy is configured using an ordered Map of path patterns to Lists
of Filter objects. In previous
versions, a FilterInvocationSecurityMetadataSource
was used. This is now deprecated in favour of namespace-based
configuration which provides a more robust and simplfied syntax. The Map instance will normally be
created while parsing the namespace configuration, so doesn't have to be set explicitly.
Instead the <filter-chain-map> element should be used within the FilterChainProxy bean declaration.
This in turn should have a list of child <filter-chain> elements which each define a URI pattern and the list
of filters (as comma-separated bean names) which should be applied to requests which match the pattern.
An example configuration might look like this:
<bean id="myfilterChainProxy" class="org.springframework.security.util.FilterChainProxy"> <security:filter-chain-map pathType="ant"> <security:filter-chain pattern="/do/not/filter" filters="none"/> <security:filter-chain pattern="/**" filters="filter1,filter2,filter3"/> </security:filter-chain-map> </bean>The names "filter1", "filter2", "filter3" should be the bean names of
Filter
instances defined in the
application context. The order of the names defines the order in which the filters will be applied. As shown above,
use of the value "none" for the "filters" can be used to exclude
Please consult the security namespace schema file for a full list of available configuration options.
Each possible URI pattern that FilterChainProxy
should service must be entered.
The first matching URI pattern for a given request will be used to define all of the
Filter
s that apply to that request. NB: This means you must put most specific URI patterns at the top
of the list, and ensure all Filter
s that should apply for a given URI pattern are entered against the
respective entry. The FilterChainProxy
will not iterate the remainder of the URI patterns to locate
additional Filter
s.
FilterChainProxy
respects normal handling of Filter
s that elect not to call Filter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse,
javax.servlet.FilterChain)
, in that the remainder of the original or FilterChainProxy
-declared filter
chain will not be called.
HttpFirewall
instance is used to validate incoming requests and create a wrapped request which provides
consistent path values for matching against. See DefaultHttpFirewall
, for more information on the type of
attacks which the default implementation protects against. A custom implementation can be injected to provide
stricter control over the request contents or if an application needs to support certain types of request which
are rejected by default.
Note that this means that you must use the Spring Security filters in combination with a FilterChainProxy
if you want this protection. Don't define them explicitly in your web.xml
file.
FilterChainProxy
will use the firewall instance to obtain both request and response objects which will be
fed down the filter chain, so it is also possible to use this functionality to control the functionality of the
response. When the request has passed through the security filter chain, the reset
method will be called.
With the default implementation this means that the original values of servletPath
and pathInfo
will
be returned thereafter, instead of the modified ones used for security pattern matching.
Note the Filter
lifecycle mismatch between the servlet container and IoC
container. As described in the DelegatingFilterProxy
Javadocs, we recommend you allow the IoC
container to manage the lifecycle instead of the servlet container. FilterChainProxy
does not invoke the
standard filter lifecycle methods on any filter beans that you add to the application context.
Nested Class Summary | |
---|---|
static interface |
FilterChainProxy.FilterChainValidator
|
Field Summary | |
---|---|
static java.lang.String |
TOKEN_NONE
|
Constructor Summary | |
---|---|
FilterChainProxy()
|
Method Summary | |
---|---|
void |
afterPropertiesSet()
|
void |
doFilter(javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response,
javax.servlet.FilterChain chain)
|
java.util.Map<java.lang.String,java.util.List<javax.servlet.Filter>> |
getFilterChainMap()
Returns a copy of the underlying filter chain map. |
java.util.List<javax.servlet.Filter> |
getFilters(java.lang.String url)
Returns the first filter chain matching the supplied URL. |
UrlMatcher |
getMatcher()
|
protected java.util.Collection<javax.servlet.Filter> |
obtainAllDefinedFilters()
Obtains all of the unique Filter instances registered in the map of
filter chains. |
void |
setFilterChainMap(java.util.Map filterChainMap)
Sets the mapping of URL patterns to filter chains. |
void |
setFilterChainValidator(FilterChainProxy.FilterChainValidator filterChainValidator)
Used (internally) to specify a validation strategy for the filters in each configured chain. |
void |
setFirewall(HttpFirewall firewall)
|
void |
setMatcher(UrlMatcher matcher)
|
void |
setStripQueryStringFromUrls(boolean stripQueryStringFromUrls)
If set to 'true', the query string will be stripped from the request URL before attempting to find a matching filter chain. |
java.lang.String |
toString()
|
Methods inherited from class org.springframework.web.filter.GenericFilterBean |
---|
addRequiredProperty, destroy, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setServletContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TOKEN_NONE
Constructor Detail |
---|
public FilterChainProxy()
Method Detail |
---|
public void afterPropertiesSet()
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
afterPropertiesSet
in class org.springframework.web.filter.GenericFilterBean
public void doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public java.util.List<javax.servlet.Filter> getFilters(java.lang.String url)
url
- the request URL
protected java.util.Collection<javax.servlet.Filter> obtainAllDefinedFilters()
Filter
instances registered in the map of
filter chains.
This is useful in ensuring a Filter
is not initialized or destroyed twice.
Filter
instances in the application context which have an entry
in the map (only one entry is included in the array for
each Filter
that actually exists in application context, even if a given
Filter
is defined multiples times in the filter chain map)public void setFilterChainMap(java.util.Map filterChainMap)
Filter
objects.
It's VERY important that the type of map used preserves ordering - the order in which the iterator
returns the entries must be the same as the order they were added to the map, otherwise you have no way
of guaranteeing that the most specific patterns are returned before the more general ones. So make sure
the Map used is an instance of LinkedHashMap
or an equivalent, rather than a plain HashMap
, for
example.
filterChainMap
- the map of path Strings to List<Filter>
s.public java.util.Map<java.lang.String,java.util.List<javax.servlet.Filter>> getFilterChainMap()
setFilterChainMap
.
public void setMatcher(UrlMatcher matcher)
public UrlMatcher getMatcher()
public void setFirewall(HttpFirewall firewall)
public void setStripQueryStringFromUrls(boolean stripQueryStringFromUrls)
public void setFilterChainValidator(FilterChainProxy.FilterChainValidator filterChainValidator)
filterChainValidator
- public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |