/*
 * Copyright 2002-2017 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.bind;

import javax.servlet.ServletRequest;

import org.springframework.beans.MutablePropertyValues;
import org.springframework.lang.Nullable;
import org.springframework.validation.BindException;
import org.springframework.web.multipart.MultipartRequest;
import org.springframework.web.util.WebUtils;

Special DataBinder to perform data binding from servlet request parameters to JavaBeans, including support for multipart files.

See the DataBinder/WebDataBinder superclasses for customization options, which include specifying allowed/required fields, and registering custom property editors.

Can also be used for manual data binding in custom web controllers: for example, in a plain Controller implementation or in a MultiActionController handler method. Simply instantiate a ServletRequestDataBinder for each binding process, and invoke bind with the current ServletRequest as argument:

MyBean myBean = new MyBean();
// apply binder to custom target object
ServletRequestDataBinder binder = new ServletRequestDataBinder(myBean);
// register custom editors, if desired
binder.registerCustomEditor(...);
// trigger actual binding of request parameters
binder.bind(request);
// optionally evaluate binding errors
Errors errors = binder.getErrors();
...
Author:Rod Johnson, Juergen Hoeller
See Also:
/** * Special {@link org.springframework.validation.DataBinder} to perform data binding * from servlet request parameters to JavaBeans, including support for multipart files. * * <p>See the DataBinder/WebDataBinder superclasses for customization options, * which include specifying allowed/required fields, and registering custom * property editors. * * <p>Can also be used for manual data binding in custom web controllers: * for example, in a plain Controller implementation or in a MultiActionController * handler method. Simply instantiate a ServletRequestDataBinder for each binding * process, and invoke {@code bind} with the current ServletRequest as argument: * * <pre class="code"> * MyBean myBean = new MyBean(); * // apply binder to custom target object * ServletRequestDataBinder binder = new ServletRequestDataBinder(myBean); * // register custom editors, if desired * binder.registerCustomEditor(...); * // trigger actual binding of request parameters * binder.bind(request); * // optionally evaluate binding errors * Errors errors = binder.getErrors(); * ...</pre> * * @author Rod Johnson * @author Juergen Hoeller * @see #bind(javax.servlet.ServletRequest) * @see #registerCustomEditor * @see #setAllowedFields * @see #setRequiredFields * @see #setFieldMarkerPrefix */
public class ServletRequestDataBinder extends WebDataBinder {
Create a new ServletRequestDataBinder instance, with default object name.
Params:
  • target – the target object to bind onto (or null if the binder is just used to convert a plain parameter value)
See Also:
/** * Create a new ServletRequestDataBinder instance, with default object name. * @param target the target object to bind onto (or {@code null} * if the binder is just used to convert a plain parameter value) * @see #DEFAULT_OBJECT_NAME */
public ServletRequestDataBinder(@Nullable Object target) { super(target); }
Create a new ServletRequestDataBinder instance.
Params:
  • target – the target object to bind onto (or null if the binder is just used to convert a plain parameter value)
  • objectName – the name of the target object
/** * Create a new ServletRequestDataBinder instance. * @param target the target object to bind onto (or {@code null} * if the binder is just used to convert a plain parameter value) * @param objectName the name of the target object */
public ServletRequestDataBinder(@Nullable Object target, String objectName) { super(target, objectName); }
Bind the parameters of the given request to this binder's target, also binding multipart files in case of a multipart request.

This call can create field errors, representing basic binding errors like a required field (code "required"), or type mismatch between value and bean property (code "typeMismatch").

Multipart files are bound via their parameter name, just like normal HTTP parameters: i.e. "uploadedFile" to an "uploadedFile" bean property, invoking a "setUploadedFile" setter method.

The type of the target property for a multipart file can be MultipartFile, byte[], or String. The latter two receive the contents of the uploaded file; all metadata like original file name, content type, etc are lost in those cases.

Params:
  • request – request with parameters to bind (can be multipart)
See Also:
/** * Bind the parameters of the given request to this binder's target, * also binding multipart files in case of a multipart request. * <p>This call can create field errors, representing basic binding * errors like a required field (code "required"), or type mismatch * between value and bean property (code "typeMismatch"). * <p>Multipart files are bound via their parameter name, just like normal * HTTP parameters: i.e. "uploadedFile" to an "uploadedFile" bean property, * invoking a "setUploadedFile" setter method. * <p>The type of the target property for a multipart file can be MultipartFile, * byte[], or String. The latter two receive the contents of the uploaded file; * all metadata like original file name, content type, etc are lost in those cases. * @param request request with parameters to bind (can be multipart) * @see org.springframework.web.multipart.MultipartHttpServletRequest * @see org.springframework.web.multipart.MultipartFile * @see #bind(org.springframework.beans.PropertyValues) */
public void bind(ServletRequest request) { MutablePropertyValues mpvs = new ServletRequestParameterPropertyValues(request); MultipartRequest multipartRequest = WebUtils.getNativeRequest(request, MultipartRequest.class); if (multipartRequest != null) { bindMultipart(multipartRequest.getMultiFileMap(), mpvs); } addBindValues(mpvs, request); doBind(mpvs); }
Extension point that subclasses can use to add extra bind values for a request. Invoked before WebDataBinder.doBind(MutablePropertyValues). The default implementation is empty.
Params:
  • mpvs – the property values that will be used for data binding
  • request – the current request
/** * Extension point that subclasses can use to add extra bind values for a * request. Invoked before {@link #doBind(MutablePropertyValues)}. * The default implementation is empty. * @param mpvs the property values that will be used for data binding * @param request the current request */
protected void addBindValues(MutablePropertyValues mpvs, ServletRequest request) { }
Treats errors as fatal.

Use this method only if it's an error if the input isn't valid. This might be appropriate if all input is from dropdowns, for example.

Throws:
  • ServletRequestBindingException – subclass of ServletException on any binding problem
/** * Treats errors as fatal. * <p>Use this method only if it's an error if the input isn't valid. * This might be appropriate if all input is from dropdowns, for example. * @throws ServletRequestBindingException subclass of ServletException on any binding problem */
public void closeNoCatch() throws ServletRequestBindingException { if (getBindingResult().hasErrors()) { throw new ServletRequestBindingException( "Errors binding onto object '" + getBindingResult().getObjectName() + "'", new BindException(getBindingResult())); } } }