Package org.springframework.web.method.annotation

Class HandlerMethodValidator

java.lang.Object

org.springframework.web.method.annotation.HandlerMethodValidator

All Implemented Interfaces:

MethodValidator

public final class HandlerMethodValidator
extends Object
implements MethodValidator

MethodValidator that uses Bean Validation to validate @RequestMapping method arguments.

Handles validation results by populating BindingResult method arguments with errors from beanResults. Also, helps to determine parameter names for @ModelAttribute and @RequestBody parameters.

Since:

6.1

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method	Description
void	applyArgumentValidation(Object target, Method method, MethodParameter[] parameters, Object[] arguments, Class<?>[] groups)	Delegate to MethodValidator.validateArguments(java.lang.Object, java.lang.reflect.Method, org.springframework.core.MethodParameter[], java.lang.Object[], java.lang.Class<?>[]) and handle the validation result, by default raising MethodValidationException in case of errors.
void	applyReturnValueValidation(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups)	Delegate to MethodValidator.validateReturnValue(java.lang.Object, java.lang.reflect.Method, org.springframework.core.MethodParameter, java.lang.Object, java.lang.Class<?>[]) and handle the validation result, by default raising MethodValidationException in case of errors.
Class<?>[]	determineValidationGroups(Object target, Method method)	Determine the applicable validation groups.
static MethodValidator	from(WebBindingInitializer initializer, ParameterNameDiscoverer paramNameDiscoverer, Predicate<MethodParameter> modelAttribitePredicate, Predicate<MethodParameter> requestParamPredicate)	Static factory method to create a HandlerMethodValidator when Bean Validation is enabled for use via ConfigurableWebBindingInitializer, for example in Spring MVC or WebFlux config.
MethodValidationResult	validateArguments(Object target, Method method, MethodParameter[] parameters, Object[] arguments, Class<?>[] groups)	Validate the given method arguments and return validation results.
MethodValidationResult	validateReturnValue(Object target, Method method, MethodParameter returnType, Object returnValue, Class<?>[] groups)	Validate the given return value and return validation results.

Methods inherited from class java.lang.Object

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

Method Details

determineValidationGroups

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

Description copied from interface: MethodValidator

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

Specified by:

determineValidationGroups in interface MethodValidator

Parameters:

target - the target Object

method - the target method

Returns:

the applicable validation groups as a Class array

applyArgumentValidation

public void applyArgumentValidation(Object target,
 Method method,
 @Nullable
 MethodParameter[] parameters,
 Object[] arguments,
 Class<?>[] groups)

Description copied from interface: MethodValidator

Delegate to MethodValidator.validateArguments(java.lang.Object, java.lang.reflect.Method, org.springframework.core.MethodParameter[], java.lang.Object[], java.lang.Class<?>[]) and handle the validation result, by default raising MethodValidationException in case of errors. Implementations may provide alternative handling, e.g. injecting Errors into the method.

Specified by:

applyArgumentValidation in interface MethodValidator

validateArguments

public MethodValidationResult validateArguments(Object target,
 Method method,
 @Nullable
 MethodParameter[] parameters,
 Object[] arguments,
 Class<?>[] 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(java.lang.Object, java.lang.reflect.Method)

Returns:

the result of validation

applyReturnValueValidation

public void applyReturnValueValidation(Object target,
 Method method,
 @Nullable
 MethodParameter returnType,
 @Nullable
 Object returnValue,
 Class<?>[] groups)

Description copied from interface: MethodValidator

Delegate to MethodValidator.validateReturnValue(java.lang.Object, java.lang.reflect.Method, org.springframework.core.MethodParameter, java.lang.Object, java.lang.Class<?>[]) and handle the validation result, by default raising MethodValidationException in case of errors. Implementations may provide alternative handling.

Specified by:

applyReturnValueValidation in interface MethodValidator

validateReturnValue

public MethodValidationResult validateReturnValue(Object target,
 Method method,
 @Nullable
 MethodParameter returnType,
 @Nullable
 Object returnValue,
 Class<?>[] 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(java.lang.Object, java.lang.reflect.Method)

Returns:

the result of validation

from

@Nullable
public static MethodValidator from(@Nullable
 WebBindingInitializer initializer,
 @Nullable
 ParameterNameDiscoverer paramNameDiscoverer,
 Predicate<MethodParameter> modelAttribitePredicate,
 Predicate<MethodParameter> requestParamPredicate)

Static factory method to create a HandlerMethodValidator when Bean Validation is enabled for use via ConfigurableWebBindingInitializer, for example in Spring MVC or WebFlux config.