Package org.springframework.web.reactive

Class BindingContext

java.lang.Object

org.springframework.web.reactive.BindingContext

public class BindingContext
extends Object

Context to assist with binding request data onto Objects and provide access to a shared Model with controller-specific attributes.

Provides methods to create a WebExchangeDataBinder for a specific target, command Object to apply data binding and validation to, or without a target Object for simple type conversion from request values.

Container for the default model for the request.

Since:

5.0

Author:

Rossen Stoyanchev, Juergen Hoeller

Constructor Summary

Constructors

Constructor	Description
BindingContext()	Create a new BindingContext.
BindingContext(WebBindingInitializer initializer)	Create a new BindingContext with the given initializer.

Method Summary

Modifier and Type	Method	Description
WebExchangeDataBinder	createDataBinder(ServerWebExchange exchange, Object target, String name)	Create a WebExchangeDataBinder to apply data binding and validation with on the target, command object.
WebExchangeDataBinder	createDataBinder(ServerWebExchange exchange, Object target, String name, MethodParameter parameter)	Variant of createDataBinder(ServerWebExchange, Object, String) with a MethodParameter for which the DataBinder is created.
WebExchangeDataBinder	createDataBinder(ServerWebExchange exchange, String name)	Create a WebExchangeDataBinder without a target object for type conversion of request values to simple types.
Model	getModel()	Return the default model.
protected WebExchangeDataBinder	initDataBinder(WebExchangeDataBinder binder, ServerWebExchange exchange)	Initialize the data binder instance for the given exchange.
void	setMethodValidationApplicable(boolean methodValidationApplicable)	Configure flag to signal whether validation will be applied to handler method arguments, which is the case if Bean Validation is enabled in Spring MVC, and method parameters have @Constraint annotations.

Methods inherited from class java.lang.Object

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

Constructor Details

BindingContext

public BindingContext()

Create a new BindingContext.

BindingContext

public BindingContext(@Nullable
 WebBindingInitializer initializer)

Create a new BindingContext with the given initializer.

Parameters:

initializer - the binding initializer to apply (may be null)

Method Details

getModel

public Model getModel()

Return the default model.

setMethodValidationApplicable

public void setMethodValidationApplicable(boolean methodValidationApplicable)

Configure flag to signal whether validation will be applied to handler method arguments, which is the case if Bean Validation is enabled in Spring MVC, and method parameters have @Constraint annotations.

Since:

6.1

createDataBinder

public WebExchangeDataBinder createDataBinder(ServerWebExchange exchange,
 @Nullable
 Object target,
 String name)

Create a WebExchangeDataBinder to apply data binding and validation with on the target, command object.

Parameters:

exchange - the current exchange

target - the object to create a data binder for

name - the name of the target object

Returns:

the created data binder

Throws:

ServerErrorException - if @InitBinder method invocation fails

initDataBinder

protected WebExchangeDataBinder initDataBinder(WebExchangeDataBinder binder,
 ServerWebExchange exchange)

Initialize the data binder instance for the given exchange.

Throws:

ServerErrorException - if @InitBinder method invocation fails

createDataBinder

public WebExchangeDataBinder createDataBinder(ServerWebExchange exchange,
 String name)

Create a WebExchangeDataBinder without a target object for type conversion of request values to simple types.

Parameters:

exchange - the current exchange

name - the name of the target object

Returns:

the created data binder

Throws:

ServerErrorException - if @InitBinder method invocation fails

createDataBinder

public WebExchangeDataBinder createDataBinder(ServerWebExchange exchange,
 @Nullable
 Object target,
 String name,
 MethodParameter parameter)

Variant of createDataBinder(ServerWebExchange, Object, String) with a MethodParameter for which the DataBinder is created. That may provide more insight to initialize the WebExchangeDataBinder.

By default, if the parameter has @Valid, Bean Validation is excluded, deferring to method validation.

Since:

6.1