org.springframework.web.servlet.resource

Class ResourceUrlEncodingFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.servlet.resource.ResourceUrlEncodingFilter

All Implemented Interfaces:

Filter, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, EnvironmentCapable, ServletContextAware

public class ResourceUrlEncodingFilter
extends GenericFilterBean

A filter that wraps the HttpServletResponse and overrides its encodeURL method in order to translate internal resource request URLs into public URL paths for external use.

Since:

4.1

Author:

Jeremy Grelle, Rossen Stoyanchev, Sam Brannen, Brian Clozel

Constructor Summary

Constructors

Constructor and Description
ResourceUrlEncodingFilter()

Method Summary

Modifier and Type	Method and Description
void	doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceUrlEncodingFilter

public ResourceUrlEncodingFilter()

Method Detail

doFilter

public void doFilter(ServletRequest request,
                     ServletResponse response,
                     FilterChain filterChain)
              throws ServletException,
                     IOException

Description copied from interface: javax.servlet.Filter

The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:

1. Examine the request
2. Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
4. • Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
   • or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.

Parameters:

request - the ServletRequest object contains the client's request

response - the ServletResponse object contains the filter's response

filterChain - the FilterChain for invoking the next filter or the resource

Throws:

ServletException - if an exception occurs that interferes with the filter's normal operation

IOException - if an I/O related error has occurred during the processing

See Also:

UnavailableException