ServletRequestDataBinder

Class Overview

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.

Used by Spring Web MVC's BaseCommandController and MultiActionController. Note that BaseCommandController and its subclasses allow for easy customization of the binder instances that they use through overriding initBinder.

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();
 ...

Summary

[Expand] Inherited Constants
From class org.springframework.web.bind.WebDataBinder String DEFAULT_FIELD_DEFAULT_PREFIX Default prefix that field default parameters start with, followed by the field name: e.g. String DEFAULT_FIELD_MARKER_PREFIX Default prefix that field marker parameters start with, followed by the field name: e.g.
From class org.springframework.validation.DataBinder String DEFAULT_OBJECT_NAME Default object name used for binding: "target"

[Expand] Inherited Fields
From class org.springframework.validation.DataBinder protected static final Log logger We'll create a lot of DataBinder instances: Let's use a static logger.

[Expand] Inherited Methods
From class org.springframework.web.bind.WebDataBinder void bindMultipart(Map<String, List<MultipartFile>> multipartFiles, MutablePropertyValues mpvs) Bind all multipart files contained in the given request, if any (in case of a multipart request). void bindMultipartFiles(Map<String, MultipartFile> multipartFiles, MutablePropertyValues mpvs) This method is deprecated. as of Spring 3.0, in favor of bindMultipart(Map>, MutablePropertyValues) which binds all multipart files, even if more than one sent for the same name void checkFieldDefaults(MutablePropertyValues mpvs) Check the given property values for field defaults, i.e. void checkFieldMarkers(MutablePropertyValues mpvs) Check the given property values for field markers, i.e. void doBind(MutablePropertyValues mpvs) This implementation performs a field default and marker check before delegating to the superclass binding process. Object getEmptyValue(String field, Class fieldType) Determine an empty value for the specified field. String getFieldDefaultPrefix() Return the prefix for parameters that mark default fields. String getFieldMarkerPrefix() Return the prefix for parameters that mark potentially empty fields. boolean isBindEmptyMultipartFiles() Return whether to bind empty MultipartFile parameters. void setBindEmptyMultipartFiles(boolean bindEmptyMultipartFiles) Set whether to bind empty MultipartFile parameters. void setFieldDefaultPrefix(String fieldDefaultPrefix) Specify a prefix that can be used for parameters that indicate default value fields, having "prefix + field" as name. void setFieldMarkerPrefix(String fieldMarkerPrefix) Specify a prefix that can be used for parameters that mark potentially empty fields, having "prefix + field" as name.
From class org.springframework.validation.DataBinder void applyPropertyValues(MutablePropertyValues mpvs) Apply given property values to the target object. void bind(PropertyValues pvs) Bind the given property values to this binder's target. void checkAllowedFields(MutablePropertyValues mpvs) Check the given property values against the allowed fields, removing values for fields that are not allowed. void checkRequiredFields(MutablePropertyValues mpvs) Check the given property values against the required fields, generating missing field errors where appropriate. Map close() Close this DataBinder, which may result in throwing a BindException if it encountered any errors. <T> T convertIfNecessary(Object value, Class<T> requiredType) Convert the value to the required type (if necessary from a String). <T> T convertIfNecessary(Object value, Class<T> requiredType, MethodParameter methodParam) Convert the value to the required type (if necessary from a String). void doBind(MutablePropertyValues mpvs) Actual implementation of the binding process, working with the passed-in MutablePropertyValues instance. PropertyEditor findCustomEditor(Class requiredType, String propertyPath) Find a custom property editor for the given type and property. String[] getAllowedFields() Return the fields that should be allowed for binding. BindingErrorProcessor getBindingErrorProcessor() Return the strategy for processing binding errors. BindingResult getBindingResult() Return the BindingResult instance created by this DataBinder. ConversionService getConversionService() Return the associated ConversionService, if any. String[] getDisallowedFields() Return the fields that should not be allowed for binding. BindException getErrors() This method is deprecated. in favor of getBindingResult(). Use the BindException(BindingResult) constructor to create a BindException instance if still needed. AbstractPropertyBindingResult getInternalBindingResult() Return the internal BindingResult held by this DataBinder, as AbstractPropertyBindingResult. String getObjectName() Return the name of the bound object. ConfigurablePropertyAccessor getPropertyAccessor() Return the underlying PropertyAccessor of this binder's BindingResult. PropertyEditorRegistry getPropertyEditorRegistry() Return the underlying TypeConverter of this binder's BindingResult. String[] getRequiredFields() Return the fields that are required for each binding process. SimpleTypeConverter getSimpleTypeConverter() Return this binder's underlying SimpleTypeConverter. Object getTarget() Return the wrapped target object. TypeConverter getTypeConverter() Return the underlying TypeConverter of this binder's BindingResult. Validator getValidator() Return the Validator to apply after each binding step, if any. void initBeanPropertyAccess() Initialize standard JavaBean property access for this DataBinder. void initDirectFieldAccess() Initialize direct field access for this DataBinder, as alternative to the default bean property access. boolean isAllowed(String field) Return if the given field is allowed for binding. boolean isAutoGrowNestedPaths() Return whether "auto-growing" of nested paths has been activated. boolean isIgnoreInvalidFields() Return whether to ignore invalid fields when binding. boolean isIgnoreUnknownFields() Return whether to ignore unknown fields when binding. void registerCustomEditor(Class requiredType, String field, PropertyEditor propertyEditor) Register the given custom property editor for the given type and property, or for all properties of the given type. void registerCustomEditor(Class requiredType, PropertyEditor propertyEditor) Register the given custom property editor for all properties of the given type. void setAllowedFields(String... allowedFields) Register fields that should be allowed for binding. void setAutoGrowNestedPaths(boolean autoGrowNestedPaths) Set whether this binder should attempt to "auto-grow" a nested path that contains a null value. void setBindingErrorProcessor(BindingErrorProcessor bindingErrorProcessor) Set the strategy to use for processing binding errors, that is, required field errors and PropertyAccessExceptions. void setConversionService(ConversionService conversionService) Specify a Spring 3.0 ConversionService to use for converting property values, as an alternative to JavaBeans PropertyEditors. void setDisallowedFields(String... disallowedFields) Register fields that should not be allowed for binding. void setExtractOldValueForEditor(boolean extractOldValueForEditor) Set whether to extract the old field value when applying a property editor to a new value for a field. void setIgnoreInvalidFields(boolean ignoreInvalidFields) Set whether to ignore invalid fields, that is, whether to ignore bind parameters that have corresponding fields in the target object which are not accessible (for example because of null values in the nested path). void setIgnoreUnknownFields(boolean ignoreUnknownFields) Set whether to ignore unknown fields, that is, whether to ignore bind parameters that do not have corresponding fields in the target object. void setMessageCodesResolver(MessageCodesResolver messageCodesResolver) Set the strategy to use for resolving errors into message codes. void setRequiredFields(String... requiredFields) Register fields that are required for each binding process. void setValidator(Validator validator) Set the Validator to apply after each binding step. void validate() Invoke the specified Validator, if any.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.PropertyEditorRegistry abstract PropertyEditor findCustomEditor(Class requiredType, String propertyPath) Find a custom property editor for the given type and property. abstract void registerCustomEditor(Class requiredType, String propertyPath, PropertyEditor propertyEditor) Register the given custom property editor for the given type and property, or for all properties of the given type. abstract void registerCustomEditor(Class requiredType, PropertyEditor propertyEditor) Register the given custom property editor for all properties of the given type.
From interface org.springframework.beans.TypeConverter abstract <T> T convertIfNecessary(Object value, Class<T> requiredType) Convert the value to the required type (if necessary from a String). abstract <T> T convertIfNecessary(Object value, Class<T> requiredType, MethodParameter methodParam) Convert the value to the required type (if necessary from a String).