org.springframework.validation.beanvalidation

Class SpringValidatorAdapter

java.lang.Object

org.springframework.validation.beanvalidation.SpringValidatorAdapter

All Implemented Interfaces:

SmartValidator, Validator

Direct Known Subclasses:

CustomValidatorBean, LocalValidatorFactoryBean

public class SpringValidatorAdapter
extends java.lang.Object
implements SmartValidator

Adapter that takes a JSR-303 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.

Since:

3.0

Author:

Juergen Hoeller

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Set<java.lang.String>	internalAnnotationAttributes
private javax.validation.Validator	targetValidator

Constructor Summary

Constructors

Constructor and Description
SpringValidatorAdapter()
SpringValidatorAdapter(javax.validation.Validator targetValidator) Create a new SpringValidatorAdapter for the given JSR-303 Validator.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	determineErrorCode(<any> descriptor) Determine a Spring-reported error code for the given constraint descriptor.
protected java.lang.String	determineField(<any> violation) Determine a field for the given constraint violation.
protected java.lang.Object[]	getArgumentsForConstraint(java.lang.String objectName, java.lang.String field, <any> descriptor) Return FieldError arguments for a validation error on the given field.
BeanDescriptor	getConstraintsForClass(java.lang.Class<?> clazz)
protected java.lang.Object	getRejectedValue(java.lang.String field, <any> violation, BindingResult bindingResult) Extract the rejected value behind the given constraint violation, for exposure through the Spring errors representation.
protected void	processConstraintViolations(java.util.Set<<any>> violations, Errors errors) Process the given JSR-303 ConstraintViolations, adding corresponding errors to the provided Spring Errors object.
(package private) void	setTargetValidator(javax.validation.Validator targetValidator)
boolean	supports(java.lang.Class<?> clazz) Can this Validator validate instances of the supplied clazz?
<T> T	unwrap(java.lang.Class<T> type)
void	validate(java.lang.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(java.lang.Object target, Errors errors, java.lang.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> java.util.Set<<any>>	validate(T object, java.lang.Class<?>... groups)
<T> java.util.Set<<any>>	validateProperty(T object, java.lang.String propertyName, java.lang.Class<?>... groups)
<T> java.util.Set<<any>>	validateValue(java.lang.Class<T> beanType, java.lang.String propertyName, java.lang.Object value, java.lang.Class<?>... groups)

Methods inherited from class java.lang.Object

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

Field Detail

internalAnnotationAttributes

private static final java.util.Set<java.lang.String> internalAnnotationAttributes

targetValidator

private javax.validation.Validator targetValidator

Constructor Detail

SpringValidatorAdapter

public SpringValidatorAdapter(javax.validation.Validator targetValidator)

Create a new SpringValidatorAdapter for the given JSR-303 Validator.

Parameters:

targetValidator - the JSR-303 Validator to wrap

SpringValidatorAdapter

SpringValidatorAdapter()

Method Detail

setTargetValidator

void setTargetValidator(javax.validation.Validator targetValidator)

supports

public boolean supports(java.lang.Class<?> clazz)

Description copied from interface: Validator

Can this Validator validate instances of the supplied clazz?

This method is typically implemented like so:

return Foo.class.isAssignableFrom(clazz);

(Where Foo is the class (or superclass) of the actual object instance that is to be validated.)

Specified by:

supports in interface Validator

Parameters:

clazz - the Class that this Validator is being asked if it can validate

Returns:

true if this Validator can indeed validate instances of the supplied clazz

validate

public void validate(java.lang.Object target,
                     Errors errors)

Description copied from interface: Validator

Validate the supplied target 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.

Specified by:

validate in interface Validator

Parameters:

target - the object that is to be validated (can be null)

errors - contextual state about the validation process (never null)

See Also:

ValidationUtils

validate

public void validate(java.lang.Object target,
                     Errors errors,
                     java.lang.Object... validationHints)

Description copied from interface: SmartValidator

Validate the supplied target 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.

Specified by:

validate in interface SmartValidator

Parameters:

target - the object that is to be validated (can be null)

errors - contextual state about the validation process (never null)

validationHints - one or more hint objects to be passed to the validation engine

See Also:

ValidationUtils

processConstraintViolations

protected void processConstraintViolations(java.util.Set<<any>> violations,
                                           Errors errors)

Process the given JSR-303 ConstraintViolations, adding corresponding errors to the provided Spring Errors object.

Parameters:

violations - the JSR-303 ConstraintViolation results

errors - the Spring errors object to register to

determineField

protected java.lang.String determineField(<any> 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:

javax.validation.ConstraintViolation#getPropertyPath(), FieldError.getField()

determineErrorCode

protected java.lang.String determineErrorCode(<any> 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 MessageCodesResolver will 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:

javax.validation.metadata.ConstraintDescriptor#getAnnotation(), MessageCodesResolver

getArgumentsForConstraint

protected java.lang.Object[] getArgumentsForConstraint(java.lang.String objectName,
                                                       java.lang.String field,
                                                       <any> 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 (of type DefaultMessageSourceResolvable, with "objectName.field" and "field" as codes). 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 object

field - the field that caused the binding error

descriptor - 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)

getRejectedValue

protected java.lang.Object getRejectedValue(java.lang.String field,
                                            <any> 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 error

violation - the corresponding JSR-303 ConstraintViolation

bindingResult - 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:

javax.validation.ConstraintViolation#getInvalidValue(), FieldError.getRejectedValue()

validate

public <T> java.util.Set<<any>> validate(T object,
                                         java.lang.Class<?>... groups)

validateProperty

public <T> java.util.Set<<any>> validateProperty(T object,
                                                 java.lang.String propertyName,
                                                 java.lang.Class<?>... groups)

validateValue

public <T> java.util.Set<<any>> validateValue(java.lang.Class<T> beanType,
                                              java.lang.String propertyName,
                                              java.lang.Object value,
                                              java.lang.Class<?>... groups)

getConstraintsForClass

public BeanDescriptor getConstraintsForClass(java.lang.Class<?> clazz)

unwrap

public <T> T unwrap(java.lang.Class<T> type)