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, if actually present in the method signature, with error information from beanResults. Also, helps to determine parameter names for @ModelAttribute, @RequestBody, and @RequestPart parameters.

Since:

6.1

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method	Description
void	applyArgumentValidation(Object target, Method method, MethodParameter @Nullable [] parameters, @Nullable Object[] arguments, Class<?>[] groups)	Delegate to MethodValidator.validateArguments(Object, Method, MethodParameter[], Object[], Class[]) and handle the validation result, by default raising MethodValidationException in case of errors.
void	applyReturnValueValidation(Object target, Method method, @Nullable MethodParameter returnType, @Nullable Object returnValue, Class<?>[] groups)	Delegate to MethodValidator.validateReturnValue(Object, Method, MethodParameter, Object, Class[]) and handle the validation result, by default raising MethodValidationException in case of errors.
Class<?>[]	determineValidationGroups(Object target, Method method)	Deprecated, for removal: This API element is subject to removal in a future version.
static @Nullable MethodValidator	from(@Nullable WebBindingInitializer initializer, @Nullable ParameterNameDiscoverer paramNameDiscoverer, Predicate<MethodParameter> modelAttributePredicate, 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 @Nullable [] parameters, @Nullable Object[] arguments, Class<?>[] groups)	Validate the given method arguments and return validation results.
MethodValidationResult	validateReturnValue(Object target, Method method, @Nullable MethodParameter returnType, @Nullable Object returnValue, Class<?>[] 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

Method Details

determineValidationGroups

@Deprecated(since="7.0.4",
            forRemoval=true)
public Class<?>[] determineValidationGroups(Object target,
 Method method)

Deprecated, for removal: This API element is subject to removal in a future version.

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,
 MethodParameter @Nullable [] parameters,
 @Nullable Object[] arguments,
 Class<?>[] groups)

Description copied from interface: MethodValidator

Delegate to MethodValidator.validateArguments(Object, Method, MethodParameter[], Object[], Class[]) and handle the validation result, by default raising MethodValidationException in case of errors. Implementations may provide alternative handling, for example, injecting Errors into the method.

Specified by:

applyArgumentValidation in interface MethodValidator

validateArguments

public MethodValidationResult validateArguments(Object target,
 Method method,
 MethodParameter @Nullable [] parameters,
 @Nullable 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 ValidationAnnotationUtils.determineValidationGroups(Object, 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(Object, Method, MethodParameter, Object, 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 ValidationAnnotationUtils.determineValidationGroups(Object, Method)

Returns:

the result of validation

from

public static @Nullable MethodValidator from(@Nullable WebBindingInitializer initializer,
 @Nullable ParameterNameDiscoverer paramNameDiscoverer,
 Predicate<MethodParameter> modelAttributePredicate,
 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.