org.springframework.web.filter

Class HttpPutFormContentFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.web.filter.HttpPutFormContentFilter

All Implemented Interfaces:

Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, ServletContextAware

public class HttpPutFormContentFilter
extends OncePerRequestFilter

javax.servlet.Filter that makes form encoded data available through the ServletRequest.getParameter*() family of methods during HTTP PUT or PATCH requests.

The Servlet spec requires form data to be available for HTTP POST but not for HTTP PUT or PATCH requests. This filter intercepts HTTP PUT and PATCH requests where content type is 'application/x-www-form-urlencoded', reads form encoded content from the body of the request, and wraps the ServletRequest in order to make the form data available as request parameters just like it is for HTTP POST requests.

Since:

3.1

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	HttpPutFormContentFilter.HttpPutFormContentRequestWrapper

Field Summary

Fields

Modifier and Type	Field and Description
private FormHttpMessageConverter	formConverter

Fields 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 and Description
HttpPutFormContentFilter()

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) Same contract as for doFilter, but guaranteed to be just invoked once per request within a single request thread.
private boolean	isFormContentType(HttpServletRequest request)
void	setCharset(java.nio.charset.Charset charset) The default character set to use for reading form data.

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, destroy, 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

Field Detail

formConverter

private final FormHttpMessageConverter formConverter

Constructor Detail

HttpPutFormContentFilter

public HttpPutFormContentFilter()

Method Detail

setCharset

public void setCharset(java.nio.charset.Charset charset)

The default character set to use for reading form data.

doFilterInternal

protected void doFilterInternal(HttpServletRequest request,
                                HttpServletResponse response,
                                FilterChain filterChain)
                         throws ServletException,
                                java.io.IOException

Description copied from class: OncePerRequestFilter

Same contract as for doFilter, but guaranteed to be just invoked once per request within a single request thread. See OncePerRequestFilter.shouldNotFilterAsyncDispatch() for details.

Provides HttpServletRequest and HttpServletResponse arguments instead of the default ServletRequest and ServletResponse ones.

Specified by:

doFilterInternal in class OncePerRequestFilter

Throws:

ServletException

java.io.IOException

isFormContentType

private boolean isFormContentType(HttpServletRequest request)