Class SpringValidatorAdapter
- java.lang.Object
- org.springframework.validation.beanvalidation.SpringValidatorAdapter
- All Implemented Interfaces:
Validator,SmartValidator,Validator
- Direct Known Subclasses:
CustomValidatorBean,LocalValidatorFactoryBean
public class SpringValidatorAdapter extends Object implements SmartValidator, Validator
Adapter that takes a JSR-303javax.validator.Validatorand exposes it as a SpringValidatorwhile also exposing the original JSR-303 Validator interface itself.Can be used as a programmatic wrapper. Also serves as base class for
CustomValidatorBeanandLocalValidatorFactoryBean, and as the primary implementation of theSmartValidatorinterface.As of Spring Framework 5.0, this adapter is fully compatible with Bean Validation 1.1 as well as 2.0.
- Since:
- 3.0
- Author:
- Juergen Hoeller
- See Also:
SmartValidator,CustomValidatorBean,LocalValidatorFactoryBean
Constructor Summary
Constructors Constructor Description SpringValidatorAdapter(Validator targetValidator)Create a new SpringValidatorAdapter for the given JSR-303 Validator.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected StringdetermineErrorCode(ConstraintDescriptor<?> descriptor)Determine a Spring-reported error code for the given constraint descriptor.protected StringdetermineField(ConstraintViolation<Object> violation)Determine a field for the given constraint violation.ExecutableValidatorforExecutables()protected Object[]getArgumentsForConstraint(String objectName, String field, ConstraintDescriptor<?> descriptor)Return FieldError arguments for a validation error on the given field.BeanDescriptorgetConstraintsForClass(Class<?> clazz)protected ObjectgetRejectedValue(String field, ConstraintViolation<Object> violation, BindingResult bindingResult)Extract the rejected value behind the given constraint violation, for exposure through the Spring errors representation.protected MessageSourceResolvablegetResolvableField(String objectName, String field)Build a resolvable wrapper for the specified field, allowing to resolve the field's name in aMessageSource.protected voidprocessConstraintViolations(Set<ConstraintViolation<Object>> violations, Errors errors)Process the given JSR-303 ConstraintViolations, adding corresponding errors to the provided SpringErrorsobject.protected booleanrequiresMessageFormat(ConstraintViolation<?> violation)Indicate whether this violation's interpolated message has remaining placeholders and therefore requiresMessageFormatto be applied to it.booleansupports(Class<?> clazz)<T> Tunwrap(Class<T> type)voidvalidate(Object target, Errors errors)Validate the suppliedtargetobject, which must be of aClassfor which theValidator.supports(Class)method typically has (or would) returntrue.voidvalidate(Object target, Errors errors, Object... validationHints)Validate the suppliedtargetobject, which must be of a type ofClassfor which theValidator.supports(Class)method typically returnstrue.<T> Set<ConstraintViolation<T>>validate(T object, Class<?>... groups)<T> Set<ConstraintViolation<T>>validateProperty(T object, String propertyName, Class<?>... groups)voidvalidateValue(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)
Constructor Detail
SpringValidatorAdapter
public SpringValidatorAdapter(Validator targetValidator)
Create a new SpringValidatorAdapter for the given JSR-303 Validator.- Parameters:
targetValidator- the JSR-303 Validator to wrap
Method Detail
validate
public void validate(Object target, Errors errors)
Description copied from interface:ValidatorValidate the suppliedtargetobject, which must be of aClassfor which theValidator.supports(Class)method typically has (or would) returntrue.The supplied
errorsinstance can be used to report any resulting validation errors.- Specified by:
validatein interfaceValidator- Parameters:
target- the object that is to be validatederrors- contextual state about the validation process- See Also:
ValidationUtils
validate
public void validate(Object target, Errors errors, Object... validationHints)
Description copied from interface:SmartValidatorValidate the suppliedtargetobject, which must be of a type ofClassfor which theValidator.supports(Class)method typically returnstrue.The supplied
errorsinstance 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 typeClass).Note: Validation hints may get ignored by the actual target
Validator, in which case this method should behave just like its regularValidator.validate(Object, Errors)sibling.- Specified by:
validatein interfaceSmartValidator- Parameters:
target- the object that is to be validatederrors- contextual state about the validation processvalidationHints- one or more hint objects to be passed to the validation engine- See Also:
Validator.validate(Object, Class[])
validateValue
public void validateValue(Class<?> targetType, String fieldName, @Nullable Object value, Errors errors, Object... validationHints)
Description copied from interface:SmartValidatorValidate 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.- Specified by:
validateValuein interfaceSmartValidator- Parameters:
targetType- 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 engine- See Also:
Validator.validateValue(Class, String, Object, Class[])
processConstraintViolations
protected void processConstraintViolations(Set<ConstraintViolation<Object>> violations, Errors errors)
Process the given JSR-303 ConstraintViolations, adding corresponding errors to the provided SpringErrorsobject.- Parameters:
violations- the JSR-303 ConstraintViolation resultserrors- the Spring errors object to register to
determineField
protected String determineField(ConstraintViolation<Object> violation)
Determine a field for the given constraint violation.The default implementation returns the stringified property path.
- Parameters:
violation- the current JSR-303 ConstraintViolation- Returns:
- the Spring-reported field (for use with
Errors) - Since:
- 4.2
- See Also:
ConstraintViolation.getPropertyPath(),FieldError.getField()
determineErrorCode
protected String determineErrorCode(ConstraintDescriptor<?> descriptor)
Determine a Spring-reported error code for the given constraint descriptor.The default implementation returns the simple class name of the descriptor's annotation type. Note that the configured
MessageCodesResolverwill automatically generate error code variations which include the object name and the field name.- Parameters:
descriptor- the JSR-303 ConstraintDescriptor for the current violation- Returns:
- a corresponding error code (for use with
Errors) - Since:
- 4.2
- See Also:
ConstraintDescriptor.getAnnotation(),MessageCodesResolver
getArgumentsForConstraint
protected Object[] getArgumentsForConstraint(String objectName, String field, ConstraintDescriptor<?> descriptor)
Return FieldError arguments for a validation error on the given field. Invoked for each violated constraint.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.
- Parameters:
objectName- the name of the target objectfield- the field that caused the binding errordescriptor- the JSR-303 constraint descriptor- Returns:
- the Object array that represents the FieldError arguments
- See Also:
DefaultMessageSourceResolvable.getArguments(),DefaultMessageSourceResolvable,DefaultBindingErrorProcessor.getArgumentsForBindError(java.lang.String, java.lang.String)
getResolvableField
protected MessageSourceResolvable getResolvableField(String objectName, String field)
Build a resolvable wrapper for the specified field, allowing to resolve the field's name in aMessageSource.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.- Parameters:
objectName- the name of the target objectfield- the field that caused the binding error- Returns:
- a corresponding
MessageSourceResolvablefor the specified field - Since:
- 4.3
- See Also:
getArgumentsForConstraint(java.lang.String, java.lang.String, javax.validation.metadata.ConstraintDescriptor<?>)
getRejectedValue
@Nullable 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.- Parameters:
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 value- Returns:
- the invalid value to expose as part of the field error
- Since:
- 4.2
- See Also:
ConstraintViolation.getInvalidValue(),FieldError.getRejectedValue()
requiresMessageFormat
protected boolean requiresMessageFormat(ConstraintViolation<?> violation)
Indicate whether this violation's interpolated message has remaining placeholders and therefore requiresMessageFormatto be applied to it. Called for a Bean Validation defined message (coming outValidationMessages.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.- Parameters:
violation- the Bean Validation constraint violation, including BV-defined interpolation of named attribute references in its message- Returns:
trueifjava.text.MessageFormatis to be applied, orfalseif the violation's message should be used as-is- Since:
- 5.1.8
- See Also:
getArgumentsForConstraint(java.lang.String, java.lang.String, javax.validation.metadata.ConstraintDescriptor<?>)
validate
public <T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups)
validateProperty
public <T> Set<ConstraintViolation<T>> validateProperty(T object, String propertyName, Class<?>... groups)
- Specified by:
validatePropertyin interfaceValidator
validateValue
public <T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups)
- Specified by:
validateValuein interfaceValidator
getConstraintsForClass
public BeanDescriptor getConstraintsForClass(Class<?> clazz)
- Specified by:
getConstraintsForClassin interfaceValidator
forExecutables
public ExecutableValidator forExecutables()
- Specified by:
forExecutablesin interfaceValidator