Package org.springframework.web.filter
Class HiddenHttpMethodFilter
- java.lang.Object
- org.springframework.web.filter.GenericFilterBean
- org.springframework.web.filter.OncePerRequestFilter
- org.springframework.web.filter.HiddenHttpMethodFilter
- All Implemented Interfaces:
Filter,Aware,BeanNameAware,DisposableBean,InitializingBean,EnvironmentAware,EnvironmentCapable,ServletContextAware
public class HiddenHttpMethodFilter extends OncePerRequestFilter
Filterthat converts posted method parameters into HTTP methods, retrievable viaHttpServletRequest.getMethod(). Since browsers currently only support GET and POST, a common technique - used by the Prototype library, for instance - is to use a normal POST with an additional hidden form field (_method) to pass the "real" HTTP method along. This filter reads that parameter and changes theHttpServletRequestWrapper.getMethod()return value accordingly. Only"PUT","DELETE"and"PATCH"HTTP methods are allowed.The name of the request parameter defaults to
_method, but can be adapted via themethodParamproperty.NOTE: This filter needs to run after multipart processing in case of a multipart POST request, due to its inherent need for checking a POST body parameter. So typically, put a Spring
MultipartFilterbefore this HiddenHttpMethodFilter in yourweb.xmlfilter chain.- Since:
- 3.0
- Author:
- Arjen Poutsma, Juergen Hoeller
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_METHOD_PARAMDefault method parameter:_methodFields inherited from class org.springframework.web.filter.OncePerRequestFilter
ALREADY_FILTERED_SUFFIX
Fields inherited from class org.springframework.web.filter.GenericFilterBean
logger
Constructor Summary
Constructors Constructor Description HiddenHttpMethodFilter()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voiddoFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)Same contract as fordoFilter, but guaranteed to be just invoked once per request within a single request thread.voidsetMethodParam(String methodParam)Set the parameter name to look for HTTP methods.Methods inherited from class org.springframework.web.filter.OncePerRequestFilter
doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch
Methods inherited from class org.springframework.web.filter.GenericFilterBean
addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext
Field Detail
DEFAULT_METHOD_PARAM
public static final String DEFAULT_METHOD_PARAM
Default method parameter:_method- See Also:
- Constant Field Values
Constructor Detail
HiddenHttpMethodFilter
public HiddenHttpMethodFilter()
Method Detail
setMethodParam
public void setMethodParam(String methodParam)
Set the parameter name to look for HTTP methods.- See Also:
DEFAULT_METHOD_PARAM
doFilterInternal
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException
Description copied from class:OncePerRequestFilterSame contract as fordoFilter, but guaranteed to be just invoked once per request within a single request thread. SeeOncePerRequestFilter.shouldNotFilterAsyncDispatch()for details.Provides HttpServletRequest and HttpServletResponse arguments instead of the default ServletRequest and ServletResponse ones.
- Specified by:
doFilterInternalin classOncePerRequestFilter- Throws:
ServletExceptionIOException