org.springframework.web.bind.support

Class WebExchangeDataBinder

java.lang.Object

org.springframework.validation.DataBinder

org.springframework.web.bind.WebDataBinder

org.springframework.web.bind.support.WebExchangeDataBinder

All Implemented Interfaces:

org.springframework.beans.PropertyEditorRegistry, org.springframework.beans.TypeConverter

public class WebExchangeDataBinder
extends WebDataBinder

Specialized DataBinder to perform data binding from URL query params or form data in the request data to Java objects.

Since:

5.0

Author:

Rossen Stoyanchev

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 and Description
WebExchangeDataBinder(Object target) Create a new instance, with default object name.
WebExchangeDataBinder(Object target, String objectName) Create a new instance.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Void>	bind(ServerWebExchange exchange) Bind the URL query parameters or form data of the body of the given request to this binder's target.
protected Map<String,?>	getExtraValuesToBind(ServerWebExchange exchange) Extension point that subclasses can use to add extra bind values for a request.
protected Map<String,List<MultipartFile>>	getMultipartFiles(ServerWebExchange exchange) Bind all multipart files contained in the given request, if any (in case of a multipart request).

Methods inherited from class org.springframework.web.bind.WebDataBinder

bindMultipart, checkFieldDefaults, checkFieldMarkers, doBind, 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, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebExchangeDataBinder

public WebExchangeDataBinder(Object target)

Create a new instance, with default object name.

Parameters:

target - the target object to bind onto (or null if the binder is just used to convert a plain parameter value)

See Also:

DataBinder.DEFAULT_OBJECT_NAME

WebExchangeDataBinder

public WebExchangeDataBinder(Object target,
                             String objectName)

Create a new instance.

Parameters:

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

Method Detail

bind

public reactor.core.publisher.Mono<Void> bind(ServerWebExchange exchange)

Bind the URL query parameters or form data of the body of the given request to this binder's target. The request body is parsed if the Content-Type is "application/x-www-form-urlencoded".

Parameters:

exchange - the current exchange.

Returns:

a Mono<Void> when binding is complete

getMultipartFiles

protected Map<String,List<MultipartFile>> getMultipartFiles(ServerWebExchange exchange)

Bind all multipart files contained in the given request, if any (in case of a multipart request).

Multipart files will only be added to the property values if they are not empty or if we're configured to bind empty multipart files too.

Parameters:

exchange - the current exchange

Returns:

Map of field name String to MultipartFile object

getExtraValuesToBind

protected Map<String,?> getExtraValuesToBind(ServerWebExchange exchange)

Extension point that subclasses can use to add extra bind values for a request. Invoked before WebDataBinder.doBind(MutablePropertyValues). The default implementation is empty.

Parameters:

exchange - the current exchange