Class MethodValidationInterceptor
java.lang.Object
org.springframework.validation.beanvalidation.MethodValidationInterceptor
- All Implemented Interfaces:
Advice
,Interceptor
,MethodInterceptor
An AOP Alliance
MethodInterceptor
implementation that delegates to a
JSR-303 provider for performing method-level validation on annotated methods.
Applicable methods have JSR-303 constraint annotations on their parameters and/or on their return value (in the latter case specified at the method level, typically as inline annotation).
E.g.: public @NotNull Object myValidMethod(@NotNull String arg1, @Max(10) int arg2)
Validation groups can be specified through Spring's Validated
annotation
at the type level of the containing target class, applying to all public service methods
of that class. By default, JSR-303 will validate against its default group only.
As of Spring 5.0, this functionality requires a Bean Validation 1.1+ provider.
- Since:
- 3.1
- Author:
- Juergen Hoeller
- See Also:
-
Constructor Summary
ConstructorDescriptionCreate a new MethodValidationInterceptor using a default JSR-303 validator underneath.MethodValidationInterceptor
(Validator validator) Create a new MethodValidationInterceptor using the given JSR-303 Validator.MethodValidationInterceptor
(ValidatorFactory validatorFactory) Create a new MethodValidationInterceptor using the given JSR-303 ValidatorFactory.MethodValidationInterceptor
(Supplier<Validator> validator) Create a new MethodValidationInterceptor for the supplied (potentially lazily initialized) Validator. -
Method Summary
Modifier and TypeMethodDescriptionprotected Class<?>[]
determineValidationGroups
(MethodInvocation invocation) Determine the validation groups to validate against for the given method invocation.invoke
(MethodInvocation invocation) Implement this method to perform extra treatments before and after the invocation.
-
Constructor Details
-
MethodValidationInterceptor
public MethodValidationInterceptor()Create a new MethodValidationInterceptor using a default JSR-303 validator underneath. -
MethodValidationInterceptor
Create a new MethodValidationInterceptor using the given JSR-303 ValidatorFactory.- Parameters:
validatorFactory
- the JSR-303 ValidatorFactory to use
-
MethodValidationInterceptor
Create a new MethodValidationInterceptor using the given JSR-303 Validator.- Parameters:
validator
- the JSR-303 Validator to use
-
MethodValidationInterceptor
Create a new MethodValidationInterceptor for the supplied (potentially lazily initialized) Validator.- Parameters:
validator
- a Supplier for the Validator to use- Since:
- 6.0
-
-
Method Details
-
invoke
Description copied from interface:MethodInterceptor
Implement this method to perform extra treatments before and after the invocation. Polite implementations would certainly like to invokeJoinpoint.proceed()
.- Specified by:
invoke
in interfaceMethodInterceptor
- Parameters:
invocation
- the method invocation joinpoint- Returns:
- the result of the call to
Joinpoint.proceed()
; might be intercepted by the interceptor - Throws:
Throwable
- if the interceptors or the target object throws an exception
-
determineValidationGroups
Determine the validation groups to validate against for the given method invocation.Default are the validation groups as specified in the
Validated
annotation on the containing target class of the method.- Parameters:
invocation
- the current MethodInvocation- Returns:
- the applicable validation groups as a Class array
-