HibernateValidatorConfiguration (Red Hat JBoss Enterprise Application Platform 7.2.0.GA public API)

All Superinterfaces:

Configuration<HibernateValidatorConfiguration>

All Known Implementing Classes:

ConfigurationImpl
```
public interface HibernateValidatorConfiguration
extends Configuration<HibernateValidatorConfiguration>
```
Uniquely identifies Hibernate Validator in the Bean Validation bootstrap strategy. Also contains Hibernate Validator specific configurations.

Author:

Emmanuel Bernard, Gunnar Morling, Kevin Pollet <kevin.pollet@serli.com> (C) 2011 SERLI, Hardy Ferentschik, Chris Beckey <cbeckey@paypal.com>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOW_MULTIPLE_CASCADED_VALIDATION_ON_RESULT` Property corresponding to the `allowMultipleCascadedValidationOnReturnValues(boolean)` method.
`static String`	`ALLOW_PARALLEL_METHODS_DEFINE_PARAMETER_CONSTRAINTS` Property corresponding to the `allowParallelMethodsDefineParameterConstraints(boolean)` method.
`static String`	`ALLOW_PARAMETER_CONSTRAINT_OVERRIDE` Property corresponding to the `allowOverridingMethodAlterParameterConstraint(boolean)` method.
`static String`	`CONSTRAINT_MAPPING_CONTRIBUTOR` Deprecated. planned for removal. Use hibernate.validator.constraint_mapping_contributors instead.
`static String`	`CONSTRAINT_MAPPING_CONTRIBUTORS` Property for configuring constraint mapping contributors, allowing to set up one or more constraint mappings for the default validator factory.
`static String`	`ENABLE_TRAVERSABLE_RESOLVER_RESULT_CACHE` Property corresponding to the `enableTraversableResolverResultCache(boolean)`.
`static String`	`FAIL_FAST` Property corresponding to the `failFast(boolean)` method.
`static String`	`SCRIPT_EVALUATOR_FACTORY_CLASSNAME` Property for configuring the script evaluator factory, allowing to set up which factory will be used to create `ScriptEvaluator`s for evaluation of script expressions in `ScriptAssert` and `ParameterScriptAssert` constraints.
`static String`	`TEMPORAL_VALIDATION_TOLERANCE` Property for configuring temporal validation tolerance, allowing to set the acceptable margin of error when comparing date/time in temporal constraints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`HibernateValidatorConfiguration`	`addMapping(ConstraintMapping mapping)` Adds the specified `ConstraintMapping` instance to the configuration.
`HibernateValidatorConfiguration`	`allowMultipleCascadedValidationOnReturnValues(boolean allow)` Define whether more than one constraint on a return value may be marked for cascading validation are allowed.
`HibernateValidatorConfiguration`	`allowOverridingMethodAlterParameterConstraint(boolean allow)` Define whether overriding methods that override constraints should throw a `ConstraintDefinitionException`.
`HibernateValidatorConfiguration`	`allowParallelMethodsDefineParameterConstraints(boolean allow)` Define whether parallel methods that define constraints should throw a `ConstraintDefinitionException`.
`HibernateValidatorConfiguration`	`constraintValidatorPayload(Object constraintValidatorPayload)` Allows to set a payload which will be passed to the constraint validators.
`ConstraintMapping`	`createConstraintMapping()` Creates a new constraint mapping which can be used to programmatically configure the constraints for given types.
`HibernateValidatorConfiguration`	`enableTraversableResolverResultCache(boolean enabled)` Define whether the per validation call caching of `TraversableResolver` results is enabled.
`HibernateValidatorConfiguration`	`externalClassLoader(ClassLoader externalClassLoader)` Sets the class loader to be used for loading user-provided resources: XML descriptors (`META-INF/validation.xml` as well as XML constraint mappings) classes specified by name in XML descriptors (e.g.
`HibernateValidatorConfiguration`	`failFast(boolean failFast)` En- or disables the fail fast mode.
`ResourceBundleLocator`	`getDefaultResourceBundleLocator()` Returns the `ResourceBundleLocator` used by the `default message interpolator` to load user-provided resource bundles.
`Set<ValueExtractor<?>>`	`getDefaultValueExtractors()` Returns the default `ValueExtractor` implementations as per the specification.
`HibernateValidatorConfiguration`	`scriptEvaluatorFactory(ScriptEvaluatorFactory scriptEvaluatorFactory)` Allows to specify a custom `ScriptEvaluatorFactory` responsible for creating `ScriptEvaluator`s used to evaluate script expressions for `ScriptAssert` and `ParameterScriptAssert` constraints.
`HibernateValidatorConfiguration`	`temporalValidationTolerance(Duration temporalValidationTolerance)` Allows to set the acceptable margin of error when comparing date/time in temporal constraints such as `Past`/`PastOrPresent` and `Future`/`FutureOrPresent`.

Methods inherited from interface javax.validation.Configuration
addMapping, addProperty, addValueExtractor, buildValidatorFactory, clockProvider, constraintValidatorFactory, getBootstrapConfiguration, getDefaultClockProvider, getDefaultConstraintValidatorFactory, getDefaultMessageInterpolator, getDefaultParameterNameProvider, getDefaultTraversableResolver, ignoreXmlConfiguration, messageInterpolator, parameterNameProvider, traversableResolver

- Field Detail
  - FAIL_FAST
```
static final String FAIL_FAST
```
    Property corresponding to the failFast(boolean) method. Accepts true or false. Defaults to false.
    
    See Also:
    
    Constant Field Values
  - ALLOW_PARAMETER_CONSTRAINT_OVERRIDE
```
static final String ALLOW_PARAMETER_CONSTRAINT_OVERRIDE
```
    Property corresponding to the allowOverridingMethodAlterParameterConstraint(boolean) method. Accepts true or false. Defaults to false.
    
    See Also:
    
    Constant Field Values
  - ALLOW_MULTIPLE_CASCADED_VALIDATION_ON_RESULT
```
static final String ALLOW_MULTIPLE_CASCADED_VALIDATION_ON_RESULT
```
    Property corresponding to the allowMultipleCascadedValidationOnReturnValues(boolean) method. Accepts true or false. Defaults to false.
    
    See Also:
    
    Constant Field Values
  - ALLOW_PARALLEL_METHODS_DEFINE_PARAMETER_CONSTRAINTS
```
static final String ALLOW_PARALLEL_METHODS_DEFINE_PARAMETER_CONSTRAINTS
```
    Property corresponding to the allowParallelMethodsDefineParameterConstraints(boolean) method. Accepts true or false. Defaults to false.
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_MAPPING_CONTRIBUTOR
```
@Deprecated
static final String CONSTRAINT_MAPPING_CONTRIBUTOR
```
    Deprecated. planned for removal. Use hibernate.validator.constraint_mapping_contributors instead.
    
    Since:
    
    5.2
    
    See Also:
    
    Constant Field Values
  - CONSTRAINT_MAPPING_CONTRIBUTORS
```
static final String CONSTRAINT_MAPPING_CONTRIBUTORS
```
    Property for configuring constraint mapping contributors, allowing to set up one or more constraint mappings for the default validator factory. Accepts a String with the comma separated fully-qualified class names of one or more ConstraintMappingContributor implementations.
    
    Since:
    
    5.3
    
    See Also:
    
    Constant Field Values
  - ENABLE_TRAVERSABLE_RESOLVER_RESULT_CACHE
```
static final String ENABLE_TRAVERSABLE_RESOLVER_RESULT_CACHE
```
    Property corresponding to the enableTraversableResolverResultCache(boolean). Accepts true or false. Defaults to true.
    
    Since:
    
    6.0.3
    
    See Also:
    
    Constant Field Values
  - SCRIPT_EVALUATOR_FACTORY_CLASSNAME
```
@Incubating
static final String SCRIPT_EVALUATOR_FACTORY_CLASSNAME
```
    Property for configuring the script evaluator factory, allowing to set up which factory will be used to create ScriptEvaluators for evaluation of script expressions in ScriptAssert and ParameterScriptAssert constraints. A fully qualified name of a class implementing ScriptEvaluatorFactory is expected as a value.
    
    Since:
    
    6.0.3
    
    See Also:
    
    Constant Field Values
  - TEMPORAL_VALIDATION_TOLERANCE
```
@Incubating
static final String TEMPORAL_VALIDATION_TOLERANCE
```
    Property for configuring temporal validation tolerance, allowing to set the acceptable margin of error when comparing date/time in temporal constraints. In milliseconds.
    
    Since:
    
    6.0.5
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDefaultResourceBundleLocator
```
ResourceBundleLocator getDefaultResourceBundleLocator()
```
    Returns the ResourceBundleLocator used by the default message interpolator to load user-provided resource bundles. In conformance with the specification this default locator retrieves the bundle "ValidationMessages".
    
    This locator can be used as delegate for custom locators when setting a customized ResourceBundleMessageInterpolator:
```
 
 	HibernateValidatorConfiguration configure =
    Validation.byProvider(HibernateValidator.class).configure();

  ResourceBundleLocator defaultResourceBundleLocator =
    configure.getDefaultBundleLocator();
  ResourceBundleLocator myResourceBundleLocator =
    new MyResourceBundleLocator(defaultResourceBundleLocator);

  configure.messageInterpolator(
    new ResourceBundleMessageInterpolator(myResourceBundleLocator));
 
 
```
    Returns:
    
    The default ResourceBundleLocator. Never null.
  - createConstraintMapping
```
ConstraintMapping createConstraintMapping()
```
    Creates a new constraint mapping which can be used to programmatically configure the constraints for given types. After the mapping has been set up, it must be added to this configuration via addMapping(ConstraintMapping).
    
    Returns:
    
    A new constraint mapping.
  - getDefaultValueExtractors
```
@Incubating
Set<ValueExtractor<?>> getDefaultValueExtractors()
```
    Returns the default ValueExtractor implementations as per the specification.
    
    Returns:
    
    the default ValueExtractor implementations compliant with the specification
    
    Since:
    
    6.0
  - addMapping
```
HibernateValidatorConfiguration addMapping(ConstraintMapping mapping)
```
    Adds the specified ConstraintMapping instance to the configuration. Constraints configured in mapping will be added to the constraints configured via annotations and/or xml.
    
    Parameters:
    
    mapping - ConstraintMapping instance containing programmatic configured constraints
    
    Returns:
    
    this following the chaining method pattern
    
    Throws:
    
    IllegalArgumentException - if mapping is null
  - failFast
```
HibernateValidatorConfiguration failFast(boolean failFast)
```
    En- or disables the fail fast mode. When fail fast is enabled the validation will stop on the first constraint violation detected.
    
    Parameters:
    
    failFast - true to enable fail fast, false otherwise.
    
    Returns:
    
    this following the chaining method pattern
  - externalClassLoader
```
HibernateValidatorConfiguration externalClassLoader(ClassLoader externalClassLoader)
```
    Sets the class loader to be used for loading user-provided resources:
    - XML descriptors (META-INF/validation.xml as well as XML constraint mappings)
    - classes specified by name in XML descriptors (e.g. custom message interpolators etc.)
    - the ValidationMessages resource bundle
    If no class loader is given, these resources will be obtained through the thread context class loader and as a last fallback through Hibernate Validator's own class loader.
    Parameters:
    
    externalClassLoader - The class loader for loading user-provided resources.
    
    Returns:
    
    this following the chaining method pattern
    
    Since:
    
    5.2
  - allowOverridingMethodAlterParameterConstraint
```
HibernateValidatorConfiguration allowOverridingMethodAlterParameterConstraint(boolean allow)
```
    Define whether overriding methods that override constraints should throw a ConstraintDefinitionException. The default value is false, i.e. do not allow.
    See Section 4.5.5 of the JSR 380 specification, specifically
```
 "In sub types (be it sub classes/interfaces or interface implementations), no parameter constraints may
 be declared on overridden or implemented methods, nor may parameters be marked for cascaded validation.
 This would pose a strengthening of preconditions to be fulfilled by the caller."
 
```
    Parameters:
    
    allow - flag determining whether validation will allow overriding to alter parameter constraints.
    
    Returns:
    
    this following the chaining method pattern
    
    Since:
    
    5.3
  - allowMultipleCascadedValidationOnReturnValues
```
HibernateValidatorConfiguration allowMultipleCascadedValidationOnReturnValues(boolean allow)
```
    Define whether more than one constraint on a return value may be marked for cascading validation are allowed. The default value is false, i.e. do not allow.
    See Section 4.5.5 of the JSR 380 specification, specifically
```
 "One must not mark a method return value for cascaded validation more than once in a line of a class hierarchy.
 In other words, overriding methods on sub types (be it sub classes/interfaces or interface implementations)
 cannot mark the return value for cascaded validation if the return value has already been marked on the
 overridden method of the super type or interface."
 
```
    Parameters:
    
    allow - flag determining whether validation will allow multiple cascaded validation on return values.
    
    Returns:
    
    this following the chaining method pattern
    
    Since:
    
    5.3
  - allowParallelMethodsDefineParameterConstraints
```
HibernateValidatorConfiguration allowParallelMethodsDefineParameterConstraints(boolean allow)
```
    Define whether parallel methods that define constraints should throw a ConstraintDefinitionException. The default value is false, i.e. do not allow.
    See Section 4.5.5 of the JSR 380 specification, specifically
```
 "If a sub type overrides/implements a method originally defined in several parallel types of the hierarchy
 (e.g. two interfaces not extending each other, or a class and an interface not implemented by said class),
 no parameter constraints may be declared for that method at all nor parameters be marked for cascaded validation.
 This again is to avoid an unexpected strengthening of preconditions to be fulfilled by the caller."
 
```
    Parameters:
    
    allow - flag determining whether validation will allow parameter constraints in parallel hierarchies
    
    Returns:
    
    this following the chaining method pattern
    
    Since:
    
    5.3
  - enableTraversableResolverResultCache
```
HibernateValidatorConfiguration enableTraversableResolverResultCache(boolean enabled)
```
    Define whether the per validation call caching of TraversableResolver results is enabled. The default value is true, i.e. the caching is enabled.
    This behavior was initially introduced to cache the JPATraversableResolver results but the map lookups it introduces can be counterproductive when the TraversableResolver calls are very fast.
    
    Parameters:
    
    enabled - flag determining whether per validation call caching is enabled for TraversableResolver results.
    
    Returns:
    
    this following the chaining method pattern
    
    Since:
    
    6.0.3
  - scriptEvaluatorFactory
```
@Incubating
HibernateValidatorConfiguration scriptEvaluatorFactory(ScriptEvaluatorFactory scriptEvaluatorFactory)
```
    Allows to specify a custom ScriptEvaluatorFactory responsible for creating ScriptEvaluators used to evaluate script expressions for ScriptAssert and ParameterScriptAssert constraints.
    
    Parameters:
    
    scriptEvaluatorFactory - the ScriptEvaluatorFactory to be used
    
    Returns:
    
    this following the chaining method pattern
    
    Since:
    
    6.0.3
  - temporalValidationTolerance
```
@Incubating
HibernateValidatorConfiguration temporalValidationTolerance(Duration temporalValidationTolerance)
```
    Allows to set the acceptable margin of error when comparing date/time in temporal constraints such as Past/PastOrPresent and Future/FutureOrPresent.
    
    Parameters:
    
    temporalValidationTolerance - the acceptable tolerance
    
    Returns:
    
    this following the chaining method pattern
    
    Since:
    
    6.0.5
  - constraintValidatorPayload
```
@Incubating
HibernateValidatorConfiguration constraintValidatorPayload(Object constraintValidatorPayload)
```
    Allows to set a payload which will be passed to the constraint validators. If the method is called multiple times, only the payload passed last will be propagated.
    
    Parameters:
    
    constraintValidatorPayload - the payload passed to constraint validators
    
    Returns:
    
    this following the chaining method pattern
    
    Since:
    
    6.0.8

Interface HibernateValidatorConfiguration

Field Summary

Method Summary

Methods inherited from interface javax.validation.Configuration

Field Detail

FAIL_FAST

ALLOW_PARAMETER_CONSTRAINT_OVERRIDE

ALLOW_MULTIPLE_CASCADED_VALIDATION_ON_RESULT

ALLOW_PARALLEL_METHODS_DEFINE_PARAMETER_CONSTRAINTS

CONSTRAINT_MAPPING_CONTRIBUTOR

CONSTRAINT_MAPPING_CONTRIBUTORS

ENABLE_TRAVERSABLE_RESOLVER_RESULT_CACHE

SCRIPT_EVALUATOR_FACTORY_CLASSNAME

TEMPORAL_VALIDATION_TOLERANCE

Method Detail

getDefaultResourceBundleLocator

createConstraintMapping

getDefaultValueExtractors

addMapping

failFast

externalClassLoader

allowOverridingMethodAlterParameterConstraint

allowMultipleCascadedValidationOnReturnValues

allowParallelMethodsDefineParameterConstraints

enableTraversableResolverResultCache

scriptEvaluatorFactory

temporalValidationTolerance

constraintValidatorPayload