Class MethodValidationAdapter

java.lang.Object

org.springframework.validation.beanvalidation.MethodValidationAdapter

All Implemented Interfaces:

MethodValidator

public class MethodValidationAdapter
extends Object
implements MethodValidator

MethodValidator that uses a Bean Validation Validator for validation, and adapts ConstraintViolations to MethodValidationResult.

since:

6.1

Author:

Rossen stoyanchev

Nested Class summary

Nested Classes

Modifier and Type	Class	Description
static interface 	MethodValidationAdapter.ObjectNameResolver	strategy to resolve the name of an @Valid method parameter to use for its BindingResult.

Constructor summary

Constructors

Constructor	Description
MethodValidationAdapter()	Create an instance using a default JsR-303 validator underneath.
MethodValidationAdapter(jakarta.validation.Validator validator)	Create an instance using the given JsR-303 Validator.
MethodValidationAdapter(jakarta.validation.ValidatorFactory validatorFactory)	Create an instance using the given JsR-303 ValidatorFactory.
MethodValidationAdapter(supplier<jakarta.validation.Validator>&nbsp;validator)	Create an instance for the supplied (potentially lazily initialized) Validator.

Method summary

Modifier and Type	Method	Description
Class<?>[]	determineValidationGroups(Object&nbsp;target, Method&nbsp;method)	Determine the applicable validation groups.
MessageCodesResolver	getMessageCodesResolver()	Return the configured MessageCodesResolver.
ParameterNameDiscoverer	getParameterNameDiscoverer()	Return the configured ParameterNameDiscoverer.
supplier<springValidatorAdapter>	getspringValidatorAdapter()	Return the springValidatorAdapter configured for use.
final set<jakarta.validation.ConstraintViolation<Object>>	invokeValidatorForArguments(Object&nbsp;target, Method&nbsp;method, @Nullable Object[]&nbsp;arguments, Class<?>[]&nbsp;groups)	Invoke the validator, and return the resulting violations.
final set<jakarta.validation.ConstraintViolation<Object>>	invokeValidatorForReturnValue(Object&nbsp;target, Method&nbsp;method, @Nullable Object&nbsp;returnValue, Class<?>[]&nbsp;groups)	Invoke the validator, and return the resulting violations.
void	setMessageCodesResolver(MessageCodesResolver&nbsp;messageCodesResolver)	set the strategy to use to determine message codes for violations.
void	setObjectNameResolver(MethodValidationAdapter.ObjectNameResolver&nbsp;nameResolver)	Configure a resolver to determine the name of an @Valid method parameter to use for its BindingResult.
void	setParameterNameDiscoverer(ParameterNameDiscoverer&nbsp;parameterNameDiscoverer)	set the ParameterNameDiscoverer to discover method parameter names with to create error codes for MessagesourceResolvable.
final MethodValidationResult	validateArguments(Object&nbsp;target, Method&nbsp;method, MethodParameter @Nullable []&nbsp;parameters, @Nullable Object[]&nbsp;arguments, Class<?>[]&nbsp;groups)	Validate the given method arguments and return validation results.
final MethodValidationResult	validateReturnValue(Object&nbsp;target, Method&nbsp;method, @Nullable MethodParameter&nbsp;returnType, @Nullable Object&nbsp;returnValue, Class<?>[]&nbsp;groups)	Validate the given return value and return validation results.

Methods inherited from class Object

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

Methods inherited from interface MethodValidator

applyArgumentValidation, applyReturnValueValidation

Constructor Details

MethodValidationAdapter

public MethodValidationAdapter()

Create an instance using a default JsR-303 validator underneath.

MethodValidationAdapter

public MethodValidationAdapter(jakarta.validation.ValidatorFactory validatorFactory)

Create an instance using the given JsR-303 ValidatorFactory.

Parameters:

validatorFactory - the JsR-303 ValidatorFactory to use

MethodValidationAdapter

public MethodValidationAdapter(jakarta.validation.Validator validator)

Create an instance using the given JsR-303 Validator.

Parameters:

validator - the JsR-303 Validator to use

MethodValidationAdapter

public&nbsp;MethodValidationAdapter(supplier<jakarta.validation.Validator>&nbsp;validator)

Create an instance for the supplied (potentially lazily initialized) Validator.

Parameters:

validator - a supplier for the Validator to use

Method Details

getspringValidatorAdapter

public&nbsp;supplier<springValidatorAdapter>&nbsp;getspringValidatorAdapter()

Return the springValidatorAdapter configured for use.

setMessageCodesResolver

public void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)

set the strategy to use to determine message codes for violations.

Default is a DefaultMessageCodesResolver.

getMessageCodesResolver

public MessageCodesResolver getMessageCodesResolver()

Return the configured MessageCodesResolver.

setParameterNameDiscoverer

public void setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer)

set the ParameterNameDiscoverer to discover method parameter names with to create error codes for MessagesourceResolvable. Used only when MethodParameters are not passed into validateArguments(Object, Method, MethodParameter[], Object[], Class[]) or validateReturnValue(Object, Method, MethodParameter, Object, Class[]).

Default is DefaultParameterNameDiscoverer.

getParameterNameDiscoverer

public ParameterNameDiscoverer getParameterNameDiscoverer()

Return the configured ParameterNameDiscoverer.

setObjectNameResolver

public void setObjectNameResolver(MethodValidationAdapter.ObjectNameResolver nameResolver)

Configure a resolver to determine the name of an @Valid method parameter to use for its BindingResult. This allows aligning with a higher level programming model such as to resolve the name of an @ModelAttribute method parameter in spring MVC.

By default, the object name is resolved through:

• MethodParameter.getParameterName() for input parameters
• Conventions.getVariableNameForReturnType(Method, Class, Object) for a return type

If a name cannot be determined, for example, a return value with insufficient type information, then it defaults to one of:

• "{methodName}.arg{index}" for input parameters
• "{methodName}.returnValue" for a return type

determineValidationGroups

public&nbsp;Class<?>[]&nbsp;determineValidationGroups(Object&nbsp;target,
 Method&nbsp;method)

Determine the applicable validation groups. By default, obtained from an @Validated annotation on the method, or on the class level.

Default are the validation groups as specified in the Validated annotation on the method, or on the containing target class of the method, or for an AOP proxy without a target (with all behavior in advisors), also check on proxied interfaces.

specified by:

determineValidationGroups in interface MethodValidator

Parameters:

target - the target Object

method - the target method

Returns:

the applicable validation groups as a Class array

validateArguments

public final MethodValidationResult validateArguments(Object target,
 Method method,
 MethodParameter @Nullable [] parameters,
 @Nullable Object[] arguments,
 Class<?>[]&nbsp;groups)

Description copied from interface: MethodValidator

Validate the given method arguments and return validation results.

specified by:

validateArguments in interface MethodValidator

Parameters:

target - the target Object

method - the target method

parameters - the parameters, if already created and available

arguments - the candidate argument values to validate

groups - validation groups from MethodValidator.determineValidationGroups(Object, Method)

Returns:

the result of validation

invokeValidatorForArguments

public final&nbsp;set<jakarta.validation.ConstraintViolation<Object>>&nbsp;invokeValidatorForArguments(Object&nbsp;target,
 Method&nbsp;method,
 @Nullable Object[]&nbsp;arguments,
 Class<?>[]&nbsp;groups)

Invoke the validator, and return the resulting violations.

validateReturnValue

public final MethodValidationResult validateReturnValue(Object target,
 Method method,
 @Nullable MethodParameter returnType,
 @Nullable Object returnValue,
 Class<?>[]&nbsp;groups)

Description copied from interface: MethodValidator

Validate the given return value and return validation results.

specified by:

validateReturnValue in interface MethodValidator

Parameters:

target - the target Object

method - the target method

returnType - the return parameter, if already created and available

returnValue - the return value to validate

groups - validation groups from MethodValidator.determineValidationGroups(Object, Method)

Returns:

the result of validation

invokeValidatorForReturnValue

public final&nbsp;set<jakarta.validation.ConstraintViolation<Object>>&nbsp;invokeValidatorForReturnValue(Object&nbsp;target,
 Method&nbsp;method,
 @Nullable Object&nbsp;returnValue,
 Class<?>[]&nbsp;groups)

Invoke the validator, and return the resulting violations.