Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat, Inc. and/or its affiliates, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.hibernate.validator.internal.engine;
import java.lang.annotation.ElementType;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.lang.reflect.Type;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.validation.ConstraintValidatorFactory;
import javax.validation.ConstraintViolation;
import javax.validation.ElementKind;
import javax.validation.MessageInterpolator;
import javax.validation.ParameterNameProvider;
import javax.validation.Path;
import javax.validation.TraversableResolver;
import javax.validation.Validator;
import javax.validation.executable.ExecutableValidator;
import javax.validation.groups.Default;
import javax.validation.metadata.BeanDescriptor;
import org.hibernate.validator.internal.engine.ValidationContext.ValidationContextBuilder;
import org.hibernate.validator.internal.engine.constraintvalidation.ConstraintValidatorManager;
import org.hibernate.validator.internal.engine.groups.Group;
import org.hibernate.validator.internal.engine.groups.Sequence;
import org.hibernate.validator.internal.engine.groups.ValidationOrder;
import org.hibernate.validator.internal.engine.groups.ValidationOrderGenerator;
import org.hibernate.validator.internal.engine.path.PathImpl;
import org.hibernate.validator.internal.engine.resolver.SingleThreadCachedTraversableResolver;
import org.hibernate.validator.internal.metadata.BeanMetaDataManager;
import org.hibernate.validator.internal.metadata.aggregated.BeanMetaData;
import org.hibernate.validator.internal.metadata.aggregated.ExecutableMetaData;
import org.hibernate.validator.internal.metadata.aggregated.ParameterMetaData;
import org.hibernate.validator.internal.metadata.aggregated.PropertyMetaData;
import org.hibernate.validator.internal.metadata.core.MetaConstraint;
import org.hibernate.validator.internal.metadata.facets.Cascadable;
import org.hibernate.validator.internal.metadata.facets.Validatable;
import org.hibernate.validator.internal.metadata.raw.ExecutableElement;
import org.hibernate.validator.internal.util.Contracts;
import org.hibernate.validator.internal.util.ReflectionHelper;
import org.hibernate.validator.internal.util.TypeHelper;
import org.hibernate.validator.internal.util.logging.Log;
import org.hibernate.validator.internal.util.logging.LoggerFactory;
import static org.hibernate.validator.internal.util.CollectionHelper.newArrayList;
import static org.hibernate.validator.internal.util.CollectionHelper.newHashMap;
import static org.hibernate.validator.internal.util.logging.Messages.MESSAGES;
/**
* The main Bean Validation class. This is the core processing class of Hibernate Validator.
*
* @author Emmanuel Bernard
* @author Hardy Ferentschik
* @author Gunnar Morling
* @author Kevin Pollet (C) 2011 SERLI
*/
public class ValidatorImpl implements Validator, ExecutableValidator {
private static final Log log = LoggerFactory.make();
/**
* The default group array used in case any of the validate methods is called without a group.
*/
private static final Class[] DEFAULT_GROUP_ARRAY = new Class[] { Default.class };
/**
* Used to resolve the group execution order for a validate call.
*/
private final transient ValidationOrderGenerator validationOrderGenerator;
/**
* Reference to shared {@code ConstraintValidatorFactory}.
*/
private final ConstraintValidatorFactory constraintValidatorFactory;
/**
* {@link MessageInterpolator} as passed to the constructor of this instance.
*/
private final MessageInterpolator messageInterpolator;
/**
* {@link TraversableResolver} as passed to the constructor of this instance.
* Never use it directly, always use {@link #getCachingTraversableResolver()} to retrieved the single threaded caching wrapper.
*/
private final TraversableResolver traversableResolver;
/**
* Used to get access to the bean meta data. Used to avoid to parsing the constraint configuration for each call
* of a given entity.
*/
private final BeanMetaDataManager beanMetaDataManager;
/**
* Manages the life cycle of constraint validator instances
*/
private final ConstraintValidatorManager constraintValidatorManager;
/**
* Used for retrieving parameter names to be used in constraint violations or node names.
*/
private final ParameterNameProvider parameterNameProvider;
/**
* Indicates if validation has to be stopped on first constraint violation.
*/
private final boolean failFast;
public ValidatorImpl(ConstraintValidatorFactory constraintValidatorFactory,
MessageInterpolator messageInterpolator,
TraversableResolver traversableResolver,
BeanMetaDataManager beanMetaDataManager,
ParameterNameProvider parameterNameProvider,
ConstraintValidatorManager constraintValidatorManager,
boolean failFast) {
this.constraintValidatorFactory = constraintValidatorFactory;
this.messageInterpolator = messageInterpolator;
this.traversableResolver = traversableResolver;
this.beanMetaDataManager = beanMetaDataManager;
this.parameterNameProvider = parameterNameProvider;
this.constraintValidatorManager = constraintValidatorManager;
this.failFast = failFast;
validationOrderGenerator = new ValidationOrderGenerator();
}
@Override
public final Set> validate(T object, Class... groups) {
Contracts.assertNotNull( object, MESSAGES.validatedObjectMustNotBeNull() );
ValidationOrder validationOrder = determineGroupValidationOrder( groups );
ValidationContext validationContext = getValidationContext().forValidate( object );
ValueContext valueContext = ValueContext.getLocalExecutionContext(
object,
beanMetaDataManager.getBeanMetaData( object.getClass() ),
PathImpl.createRootPath()
);
return validateInContext( valueContext, validationContext, validationOrder );
}
@Override
public final Set> validateProperty(T object, String propertyName, Class... groups) {
Contracts.assertNotNull( object, MESSAGES.validatedObjectMustNotBeNull() );
sanityCheckPropertyPath( propertyName );
ValidationOrder validationOrder = determineGroupValidationOrder( groups );
ValidationContext context = getValidationContext().forValidateProperty( object );
return validatePropertyInContext(
context,
PathImpl.createPathFromString( propertyName ),
validationOrder
);
}
@Override
public final Set> validateValue(Class beanType, String propertyName, Object value, Class... groups) {
Contracts.assertNotNull( beanType, MESSAGES.beanTypeCannotBeNull() );
sanityCheckPropertyPath( propertyName );
ValidationOrder validationOrder = determineGroupValidationOrder( groups );
ValidationContext context = getValidationContext().forValidateValue( beanType );
return validateValueInContext(
context,
value,
PathImpl.createPathFromString( propertyName ),
validationOrder
);
}
@Override
public Set> validateParameters(T object, Method method, Object[] parameterValues, Class... groups) {
Contracts.assertNotNull( object, MESSAGES.validatedObjectMustNotBeNull() );
Contracts.assertNotNull( method, MESSAGES.validatedMethodMustNotBeNull() );
Contracts.assertNotNull( parameterValues, MESSAGES.validatedParameterArrayMustNotBeNull() );
return validateParameters( object, ExecutableElement.forMethod( method ), parameterValues, groups );
}
@Override
public Set> validateConstructorParameters(Constructor constructor, Object[] parameterValues, Class... groups) {
Contracts.assertNotNull( constructor, MESSAGES.validatedConstructorMustNotBeNull() );
Contracts.assertNotNull( parameterValues, MESSAGES.validatedParameterArrayMustNotBeNull() );
return validateParameters( null, ExecutableElement.forConstructor( constructor ), parameterValues, groups );
}
@Override
public Set> validateConstructorReturnValue(Constructor constructor, T createdObject, Class... groups) {
Contracts.assertNotNull( constructor, MESSAGES.validatedConstructorMustNotBeNull() );
Contracts.assertNotNull( createdObject, MESSAGES.validatedConstructorCreatedInstanceMustNotBeNull() );
return validateReturnValue( null, ExecutableElement.forConstructor( constructor ), createdObject, groups );
}
@Override
public Set> validateReturnValue(T object, Method method, Object returnValue, Class... groups) {
Contracts.assertNotNull( object, MESSAGES.validatedObjectMustNotBeNull() );
Contracts.assertNotNull( method, MESSAGES.validatedMethodMustNotBeNull() );
return validateReturnValue( object, ExecutableElement.forMethod( method ), returnValue, groups );
}
private Set> validateParameters(T object, ExecutableElement executable, Object[] parameterValues, Class... groups) {
//this might be the case for parameterless methods
if ( parameterValues == null ) {
return Collections.emptySet();
}
ValidationOrder validationOrder = determineGroupValidationOrder( groups );
ValidationContext context = getValidationContext().forValidateParameters(
parameterNameProvider,
object,
executable,
parameterValues
);
validateParametersInContext( context, parameterValues, validationOrder );
return context.getFailingConstraints();
}
private Set> validateReturnValue(T object, ExecutableElement executable, Object returnValue, Class... groups) {
ValidationOrder validationOrder = determineGroupValidationOrder( groups );
ValidationContext context = getValidationContext().forValidateReturnValue(
object,
executable,
returnValue
);
validateReturnValueInContext( context, object, returnValue, validationOrder );
return context.getFailingConstraints();
}
@Override
public final BeanDescriptor getConstraintsForClass(Class clazz) {
return beanMetaDataManager.getBeanMetaData( clazz ).getBeanDescriptor();
}
@Override
public final T unwrap(Class type) {
//allow unwrapping into public super types; intentionally not exposing the
//fact that ExecutableValidator is implemented by this class as well as this
//might change
if ( type.isAssignableFrom( Validator.class ) ) {
return type.cast( this );
}
throw log.getTypeNotSupportedForUnwrappingException( type );
}
@Override
public ExecutableValidator forExecutables() {
return this;
}
private ValidationContextBuilder getValidationContext() {
return ValidationContext.getValidationContext(
beanMetaDataManager,
constraintValidatorManager,
messageInterpolator,
constraintValidatorFactory,
getCachingTraversableResolver(),
failFast
);
}
private void sanityCheckPropertyPath(String propertyName) {
if ( propertyName == null || propertyName.length() == 0 ) {
throw log.getInvalidPropertyPathException();
}
}
private ValidationOrder determineGroupValidationOrder(Class[] groups) {
Contracts.assertNotNull( groups, MESSAGES.groupMustNotBeNull() );
for ( Class clazz : groups ) {
if ( clazz == null ) {
throw new IllegalArgumentException( MESSAGES.groupMustNotBeNull() );
}
}
Class[] tmpGroups = groups;
// if no groups is specified use the default
if ( tmpGroups.length == 0 ) {
tmpGroups = DEFAULT_GROUP_ARRAY;
}
return validationOrderGenerator.getValidationOrder( Arrays.asList( tmpGroups ) );
}
/**
* Validates the given object using the available context information.
*
* @param valueContext the current validation context
* @param context the global validation context
* @param validationOrder Contains the information which and in which order groups have to be executed
* @param The root bean type
*
* @return Set of constraint violations or the empty set if there were no violations.
*/
private Set> validateInContext(ValueContext valueContext, ValidationContext context, ValidationOrder validationOrder) {
if ( valueContext.getCurrentBean() == null ) {
return Collections.emptySet();
}
BeanMetaData beanMetaData = beanMetaDataManager.getBeanMetaData( valueContext.getCurrentBeanType() );
if ( beanMetaData.defaultGroupSequenceIsRedefined() ) {
validationOrder.assertDefaultGroupSequenceIsExpandable( beanMetaData.getDefaultGroupSequence( valueContext.getCurrentBean() ) );
}
// process first single groups. For these we can optimise object traversal by first running all validations on the current bean
// before traversing the object.
Iterator groupIterator = validationOrder.getGroupIterator();
while ( groupIterator.hasNext() ) {
Group group = groupIterator.next();
valueContext.setCurrentGroup( group.getDefiningClass() );
validateConstraintsForCurrentGroup( context, valueContext );
if ( shouldFailFast( context ) ) {
return context.getFailingConstraints();
}
}
groupIterator = validationOrder.getGroupIterator();
while ( groupIterator.hasNext() ) {
Group group = groupIterator.next();
valueContext.setCurrentGroup( group.getDefiningClass() );
validateCascadedConstraints( context, valueContext );
if ( shouldFailFast( context ) ) {
return context.getFailingConstraints();
}
}
// now we process sequences. For sequences I have to traverse the object graph since I have to stop processing when an error occurs.
Iterator sequenceIterator = validationOrder.getSequenceIterator();
while ( sequenceIterator.hasNext() ) {
Sequence sequence = sequenceIterator.next();
for ( Group group : sequence.getComposingGroups() ) {
int numberOfViolations = context.getFailingConstraints().size();
valueContext.setCurrentGroup( group.getDefiningClass() );
validateConstraintsForCurrentGroup( context, valueContext );
if ( shouldFailFast( context ) ) {
return context.getFailingConstraints();
}
validateCascadedConstraints( context, valueContext );
if ( shouldFailFast( context ) ) {
return context.getFailingConstraints();
}
if ( context.getFailingConstraints().size() > numberOfViolations ) {
break;
}
}
}
return context.getFailingConstraints();
}
private void validateConstraintsForCurrentGroup(ValidationContext validationContext, ValueContext valueContext) {
// we are not validating the default group there is nothing special to consider. If we are validating the default
// group sequence we have to consider that a class in the hierarchy could redefine the default group sequence.
if ( !valueContext.validatingDefault() ) {
validateConstraintsForNonDefaultGroup( validationContext, valueContext );
}
else {
validateConstraintsForDefaultGroup( validationContext, valueContext );
}
}
private void validateConstraintsForDefaultGroup(ValidationContext validationContext, ValueContext valueContext) {
final BeanMetaData beanMetaData = beanMetaDataManager.getBeanMetaData( valueContext.getCurrentBeanType() );
final Map, Class> validatedInterfaces = newHashMap();
// evaluating the constraints of a bean per class in hierarchy, this is necessary to detect potential default group re-definitions
for ( Class clazz : beanMetaData.getClassHierarchy() ) {
BeanMetaData hostingBeanMetaData = beanMetaDataManager.getBeanMetaData( clazz );
boolean defaultGroupSequenceIsRedefined = hostingBeanMetaData.defaultGroupSequenceIsRedefined();
List> defaultGroupSequence = hostingBeanMetaData.getDefaultGroupSequence( valueContext.getCurrentBean() );
Set> metaConstraints = hostingBeanMetaData.getDirectMetaConstraints();
// if the current class redefined the default group sequence, this sequence has to be applied to all the class hierarchy.
if ( defaultGroupSequenceIsRedefined ) {
metaConstraints = hostingBeanMetaData.getMetaConstraints();
}
PathImpl currentPath = valueContext.getPropertyPath();
for ( Class defaultSequenceMember : defaultGroupSequence ) {
valueContext.setCurrentGroup( defaultSequenceMember );
boolean validationSuccessful = true;
for ( MetaConstraint metaConstraint : metaConstraints ) {
// HV-466, an interface implemented more than one time in the hierarchy has to be validated only one
// time. An interface can define more than one constraint, we have to check the class we are validating.
final Class declaringClass = metaConstraint.getLocation().getBeanClass();
if ( declaringClass.isInterface() ) {
Class validatedForClass = validatedInterfaces.get( declaringClass );
if ( validatedForClass != null && !validatedForClass.equals( clazz ) ) {
continue;
}
validatedInterfaces.put( declaringClass, clazz );
}
boolean tmp = validateConstraint( validationContext, valueContext, metaConstraint );
if ( shouldFailFast( validationContext ) ) {
return;
}
validationSuccessful = validationSuccessful && tmp;
valueContext.setPropertyPath( currentPath );
}
if ( !validationSuccessful ) {
break;
}
}
validationContext.markCurrentBeanAsProcessed( valueContext );
// all constraints in the hierarchy has been validated, stop validation.
if ( defaultGroupSequenceIsRedefined ) {
break;
}
}
}
private void validateConstraintsForNonDefaultGroup(ValidationContext validationContext, ValueContext valueContext) {
BeanMetaData beanMetaData = beanMetaDataManager.getBeanMetaData( valueContext.getCurrentBeanType() );
PathImpl currentPath = valueContext.getPropertyPath();
for ( MetaConstraint metaConstraint : beanMetaData.getMetaConstraints() ) {
validateConstraint( validationContext, valueContext, metaConstraint );
if ( shouldFailFast( validationContext ) ) {
return;
}
// reset the path to the state before this call
valueContext.setPropertyPath( currentPath );
}
validationContext.markCurrentBeanAsProcessed( valueContext );
}
private boolean validateConstraint(ValidationContext validationContext,
ValueContext valueContext,
MetaConstraint metaConstraint) {
boolean validationSuccessful = true;
if ( metaConstraint.getElementType() != ElementType.TYPE ) {
valueContext.appendNode(
beanMetaDataManager.getBeanMetaData( valueContext.getCurrentBeanType() ).getMetaDataFor(
ReflectionHelper.getPropertyName( metaConstraint.getLocation().getMember() )
)
);
}
else {
valueContext.appendBeanNode();
}
if ( isValidationRequired( validationContext, valueContext, metaConstraint ) ) {
Object valueToValidate = metaConstraint.getValue( valueContext.getCurrentBean() );
valueContext.setCurrentValidatedValue( valueToValidate );
validationSuccessful = metaConstraint.validateConstraint( validationContext, valueContext );
}
return validationSuccessful;
}
/**
* Validates all cascaded constraints for the given bean using the current group set in the execution context.
* This method must always be called after validateConstraints for the same context.
*
* @param validationContext The execution context
* @param valueContext Collected information for single validation
*/
private void validateCascadedConstraints(ValidationContext validationContext, ValueContext valueContext) {
Validatable validatable = valueContext.getCurrentValidatable();
PathImpl originalPath = valueContext.getPropertyPath();
Class originalGroup = valueContext.getCurrentGroup();
for ( Cascadable cascadable : validatable.getCascadables() ) {
valueContext.appendNode( cascadable );
Class group = cascadable.convertGroup( originalGroup );
valueContext.setCurrentGroup( group );
ElementType elementType = cascadable.getElementType();
if ( isCascadeRequired(
validationContext,
valueContext.getCurrentBean(),
valueContext.getPropertyPath(),
elementType
) ) {
Object value = cascadable.getValue(
valueContext.getCurrentBean()
);
if ( value != null ) {
Type type = value.getClass();
Iterator iter = createIteratorForCascadedValue( type, value, valueContext );
boolean isIndexable = isIndexable( type );
// expand the group only if was created by group conversion;
// otherwise we're looping through the right validation order
// already and need only to pass the current element
ValidationOrder validationOrder = validationOrderGenerator.getValidationOrder(
group,
group != originalGroup
);
validateCascadedConstraint(
validationContext,
iter,
isIndexable,
valueContext,
validationOrder
);
if ( shouldFailFast( validationContext ) ) {
return;
}
}
}
// reset the path
valueContext.setPropertyPath( originalPath );
valueContext.setCurrentGroup( originalGroup );
}
}
/**
* Called when processing cascaded constraints. This methods inspects the type of the cascaded constraints and in case
* of a list or array creates an iterator in order to validate each element.
*
* @param type the type of the cascaded field or property.
* @param value the actual value.
* @param valueContext context object containing state about the currently validated instance
*
* @return An iterator over the value of a cascaded property.
*/
private Iterator createIteratorForCascadedValue(Type type, Object value, ValueContext valueContext) {
Iterator iter;
if ( ReflectionHelper.isIterable( type ) ) {
iter = ( (Iterable) value ).iterator();
valueContext.markCurrentPropertyAsIterable();
}
else if ( ReflectionHelper.isMap( type ) ) {
Map map = (Map) value;
iter = map.entrySet().iterator();
valueContext.markCurrentPropertyAsIterable();
}
else if ( TypeHelper.isArray( type ) ) {
List arrayList = Arrays.asList( (Object[]) value );
iter = arrayList.iterator();
valueContext.markCurrentPropertyAsIterable();
}
else {
List