public class SpringValidatorAdapter extends Object implements SmartValidator, Validator
javax.validator.Validator and
exposes it as a Spring Validator
while also exposing the original JSR-303 Validator interface itself.
Can be used as a programmatic wrapper. Also serves as base class for
CustomValidatorBean and LocalValidatorFactoryBean,
and as the primary implementation of the SmartValidator interface.
As of Spring Framework 5.0, this adapter is fully compatible with Bean Validation 1.1 as well as 2.0.
SmartValidator,
CustomValidatorBean,
LocalValidatorFactoryBean| Constructor and Description |
|---|
SpringValidatorAdapter(Validator targetValidator)
Create a new SpringValidatorAdapter for the given JSR-303 Validator.
|
| Modifier and Type | Method and Description |
|---|---|
protected String |
determineErrorCode(ConstraintDescriptor<?> descriptor)
Determine a Spring-reported error code for the given constraint descriptor.
|
protected String |
determineField(ConstraintViolation<Object> violation)
Determine a field for the given constraint violation.
|
ExecutableValidator |
forExecutables() |
protected Object[] |
getArgumentsForConstraint(String objectName,
String field,
ConstraintDescriptor<?> descriptor)
Return FieldError arguments for a validation error on the given field.
|
BeanDescriptor |
getConstraintsForClass(Class<?> clazz) |
protected Object |
getRejectedValue(String field,
ConstraintViolation<Object> violation,
BindingResult bindingResult)
Extract the rejected value behind the given constraint violation,
for exposure through the Spring errors representation.
|
protected MessageSourceResolvable |
getResolvableField(String objectName,
String field)
Build a resolvable wrapper for the specified field, allowing to resolve the field's
name in a
MessageSource. |
protected void |
processConstraintViolations(Set<ConstraintViolation<Object>> violations,
Errors errors)
Process the given JSR-303 ConstraintViolations, adding corresponding errors to
the provided Spring
Errors object. |
protected boolean |
requiresMessageFormat(ConstraintViolation<?> violation)
Indicate whether this violation's interpolated message has remaining
placeholders and therefore requires
MessageFormat
to be applied to it. |
boolean |
supports(Class<?> clazz)
|
<T> T |
unwrap(Class<T> type) |
void |
validate(Object target,
Errors errors)
Validate the supplied
target object, which must be
of a Class for which the Validator.supports(Class) method
typically has (or would) return true. |
void |
validate(Object target,
Errors errors,
Object... validationHints)
Validate the supplied
target object, which must be of a type of Class
for which the Validator.supports(Class) method typically returns true. |
<T> Set<ConstraintViolation<T>> |
validate(T object,
Class<?>... groups) |
<T> Set<ConstraintViolation<T>> |
validateProperty(T object,
String propertyName,
Class<?>... groups) |
void |
validateValue(Class<?> targetType,
String fieldName,
Object value,
Errors errors,
Object... validationHints)
Validate the supplied value for the specified field on the target type,
reporting the same validation errors as if the value would be bound to
the field on an instance of the target class.
|
<T> Set<ConstraintViolation<T>> |
validateValue(Class<T> beanType,
String propertyName,
Object value,
Class<?>... groups) |
public SpringValidatorAdapter(Validator targetValidator)
targetValidator - the JSR-303 Validator to wrappublic void validate(Object target, Errors errors)
Validatortarget object, which must be
of a Class for which the Validator.supports(Class) method
typically has (or would) return true.
The supplied errors instance can be used to report
any resulting validation errors.
target - the object that is to be validatederrors - contextual state about the validation processValidationUtilspublic void validate(Object target, Errors errors, Object... validationHints)
SmartValidatortarget object, which must be of a type of Class
for which the Validator.supports(Class) method typically returns true.
The supplied errors instance can be used to report any
resulting validation errors.
This variant of validate() supports validation hints, such as
validation groups against a JSR-303 provider (in which case, the provided hint
objects need to be annotation arguments of type Class).
Note: Validation hints may get ignored by the actual target Validator,
in which case this method should behave just like its regular
Validator.validate(Object, Errors) sibling.
validate in interface SmartValidatortarget - the object that is to be validatederrors - contextual state about the validation processvalidationHints - one or more hint objects to be passed to the validation engineValidator.validate(Object, Class[])public void validateValue(Class<?> targetType, String fieldName, @Nullable Object value, Errors errors, Object... validationHints)
SmartValidatorvalidateValue in interface SmartValidatortargetType - the target typefieldName - the name of the fieldvalue - the candidate valueerrors - contextual state about the validation processvalidationHints - one or more hint objects to be passed to the validation engineValidator.validateValue(Class, String, Object, Class[])protected void processConstraintViolations(Set<ConstraintViolation<Object>> violations, Errors errors)
Errors object.violations - the JSR-303 ConstraintViolation resultserrors - the Spring errors object to register toprotected String determineField(ConstraintViolation<Object> violation)
The default implementation returns the stringified property path.
violation - the current JSR-303 ConstraintViolationErrors)ConstraintViolation.getPropertyPath(),
FieldError.getField()protected String determineErrorCode(ConstraintDescriptor<?> descriptor)
The default implementation returns the simple class name of the descriptor's
annotation type. Note that the configured
MessageCodesResolver will automatically
generate error code variations which include the object name and the field name.
descriptor - the JSR-303 ConstraintDescriptor for the current violationErrors)ConstraintDescriptor.getAnnotation(),
MessageCodesResolverprotected Object[] getArgumentsForConstraint(String objectName, String field, ConstraintDescriptor<?> descriptor)
The default implementation returns a first argument indicating the field name
(see getResolvableField(java.lang.String, java.lang.String)). Afterwards, it adds all actual constraint
annotation attributes (i.e. excluding "message", "groups" and "payload") in
alphabetical order of their attribute names.
Can be overridden to e.g. add further attributes from the constraint descriptor.
objectName - the name of the target objectfield - the field that caused the binding errordescriptor - the JSR-303 constraint descriptorDefaultMessageSourceResolvable.getArguments(),
DefaultMessageSourceResolvable,
DefaultBindingErrorProcessor.getArgumentsForBindError(java.lang.String, java.lang.String)protected MessageSourceResolvable getResolvableField(String objectName, String field)
MessageSource.
The default implementation returns a first argument indicating the field:
of type DefaultMessageSourceResolvable, with "objectName.field" and "field"
as codes, and with the plain field name as default message.
objectName - the name of the target objectfield - the field that caused the binding errorMessageSourceResolvable for the specified fieldgetArgumentsForConstraint(java.lang.String, java.lang.String, javax.validation.metadata.ConstraintDescriptor<?>)@Nullable protected Object getRejectedValue(String field, ConstraintViolation<Object> violation, BindingResult bindingResult)
field - the field that caused the binding errorviolation - the corresponding JSR-303 ConstraintViolationbindingResult - a Spring BindingResult for the backing object
which contains the current field's valueConstraintViolation.getInvalidValue(),
FieldError.getRejectedValue()protected boolean requiresMessageFormat(ConstraintViolation<?> violation)
MessageFormat
to be applied to it. Called for a Bean Validation defined message
(coming out ValidationMessages.properties) when rendered
as the default message in Spring's MessageSource.
The default implementation considers a Spring-style "{0}" placeholder
for the field name as an indication for MessageFormat.
Any other placeholder or escape syntax occurrences are typically a
mismatch, coming out of regex pattern values or the like. Note that
standard Bean Validation does not support "{0}" style placeholders at all;
this is a feature typically used in Spring MessageSource resource bundles.
violation - the Bean Validation constraint violation, including
BV-defined interpolation of named attribute references in its messagetrue if java.text.MessageFormat is to be applied,
or false if the violation's message should be used as-isgetArgumentsForConstraint(java.lang.String, java.lang.String, javax.validation.metadata.ConstraintDescriptor<?>)public <T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups)
public <T> Set<ConstraintViolation<T>> validateProperty(T object, String propertyName, Class<?>... groups)
validateProperty in interface Validatorpublic <T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups)
validateValue in interface Validatorpublic BeanDescriptor getConstraintsForClass(Class<?> clazz)
getConstraintsForClass in interface Validatorpublic ExecutableValidator forExecutables()
forExecutables in interface Validator