Class WebRequestDataBinder
- java.lang.Object
- org.springframework.validation.DataBinder
- org.springframework.web.bind.WebDataBinder
- org.springframework.web.bind.support.WebRequestDataBinder
- All Implemented Interfaces:
PropertyEditorRegistry
,TypeConverter
public class WebRequestDataBinder extends WebDataBinder
SpecialDataBinder
to perform data binding from web 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 used for manual data binding in custom web controllers or interceptors that build on Spring's
WebRequest
abstraction: e.g. in aWebRequestInterceptor
implementation. Simply instantiate a WebRequestDataBinder for each binding process, and invokebind
with the current WebRequest as argument:MyBean myBean = new MyBean(); // apply binder to custom target object WebRequestDataBinder binder = new WebRequestDataBinder(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(); ...
- Since:
- 2.5.2
- Author:
- Juergen Hoeller, Brian Clozel
- See Also:
bind(org.springframework.web.context.request.WebRequest)
,DataBinder.registerCustomEditor(java.lang.Class<?>, java.beans.PropertyEditor)
,DataBinder.setAllowedFields(java.lang.String...)
,DataBinder.setRequiredFields(java.lang.String...)
,WebDataBinder.setFieldMarkerPrefix(java.lang.String)
Field Summary
Fields inherited from class org.springframework.web.bind.WebDataBinder
DEFAULT_FIELD_DEFAULT_PREFIX, DEFAULT_FIELD_MARKER_PREFIX
Fields inherited from class org.springframework.validation.DataBinder
DEFAULT_AUTO_GROW_COLLECTION_LIMIT, DEFAULT_OBJECT_NAME, logger
Constructor Summary
Constructors Constructor Description WebRequestDataBinder(Object target)
Create a new WebRequestDataBinder instance, with default object name.WebRequestDataBinder(Object target, String objectName)
Create a new WebRequestDataBinder instance.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
bind(WebRequest request)
Bind the parameters of the given request to this binder's target, also binding multipart files in case of a multipart request.void
closeNoCatch()
Treats errors as fatal.Methods inherited from class org.springframework.web.bind.WebDataBinder
bindMultipart, checkFieldDefaults, checkFieldMarkers, doBind, getEmptyValue, getEmptyValue, getFieldDefaultPrefix, getFieldMarkerPrefix, isBindEmptyMultipartFiles, setBindEmptyMultipartFiles, setFieldDefaultPrefix, setFieldMarkerPrefix
Methods inherited from class org.springframework.validation.DataBinder
addCustomFormatter, addCustomFormatter, addCustomFormatter, addValidators, applyPropertyValues, bind, checkAllowedFields, checkRequiredFields, close, convertIfNecessary, convertIfNecessary, convertIfNecessary, convertIfNecessary, createBeanPropertyBindingResult, createDirectFieldBindingResult, findCustomEditor, getAllowedFields, getAutoGrowCollectionLimit, getBindingErrorProcessor, getBindingResult, getConversionService, getDisallowedFields, getInternalBindingResult, getObjectName, getPropertyAccessor, getPropertyEditorRegistry, getRequiredFields, getSimpleTypeConverter, getTarget, getTypeConverter, getValidator, getValidators, initBeanPropertyAccess, initDirectFieldAccess, isAllowed, isAutoGrowNestedPaths, isIgnoreInvalidFields, isIgnoreUnknownFields, registerCustomEditor, registerCustomEditor, replaceValidators, setAllowedFields, setAutoGrowCollectionLimit, setAutoGrowNestedPaths, setBindingErrorProcessor, setConversionService, setDisallowedFields, setIgnoreInvalidFields, setIgnoreUnknownFields, setMessageCodesResolver, setRequiredFields, setValidator, validate, validate
Constructor Detail
WebRequestDataBinder
public WebRequestDataBinder(@Nullable Object target)
Create a new WebRequestDataBinder instance, with default object name.- Parameters:
target
- the target object to bind onto (ornull
if the binder is just used to convert a plain parameter value)- See Also:
DataBinder.DEFAULT_OBJECT_NAME
WebRequestDataBinder
public WebRequestDataBinder(@Nullable Object target, String objectName)
Create a new WebRequestDataBinder instance.- Parameters:
target
- the target object to bind onto (ornull
if the binder is just used to convert a plain parameter value)objectName
- the name of the target object
Method Detail
bind
public void bind(WebRequest request)
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 Part, 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.
- Parameters:
request
- the request with parameters to bind (can be multipart)- See Also:
MultipartRequest
,MultipartFile
,Part
,DataBinder.bind(org.springframework.beans.PropertyValues)
closeNoCatch
public void closeNoCatch() throws BindException
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:
BindException
- if binding errors have been encountered