public Interface BaseHibernateValidatorConfiguration<S extends org.hibernate.validator.BaseHibernateValidatorConfiguration<S>>

Property corresponding to the allowMultipleCascadedValidationOnReturnValues method. Accepts true or false. Defaults to false.

Property corresponding to the allowParallelMethodsDefineParameterConstraints method. Accepts true or false. Defaults to false.

Property corresponding to the allowOverridingMethodAlterParameterConstraint method. Accepts true or false. Defaults to false.

Property for configuring the Expression Language feature level for constraints, allowing to define which Expression Language features are available for message interpolation.

This property only affects the EL feature level of "static" constraint violation messages. In particular, it doesn't affect the default EL feature level for custom violations. Refer to CUSTOM_VIOLATION_EXPRESSION_LANGUAGE_FEATURE_LEVEL to configure that.

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 org.hibernate.validator.spi.cfg.ConstraintMappingContributor implementations.

Since

5.3

Property for configuring the Expression Language feature level for custom violations, allowing to define which Expression Language features are available for message interpolation.

Property corresponding to the enableTraversableResolverResultCache(boolean). Accepts true or false. Defaults to true.

Since

6.0.3

Property corresponding to the failFast method. Accepts true or false. Defaults to false.

Property for configuring the getter property selection strategy, allowing to set which rules will be applied to determine if a method is a valid JavaBean getter.

Property for configuring the locale resolver, allowing to select an implementation of LocaleResolver which will be used for locale resolution when interpolating a message.

Property for configuring the property node name provider, allowing to select an implementation of PropertyNodeNameProvider which will be used for property name resolution when creating a property path.

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.

Property for trace level logs to include values under validation when constraint checks are executed.

Property for configuring temporal validation tolerance, allowing to set the acceptable margin of error when comparing date/time in temporal constraints. In milliseconds.

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

ConstraintMapping instance containing programmatic configured constraints

Returns:S

this following the chaining method pattern

Exceptions

IllegalArgumentException:

if mapping is null

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

flag determining whether validation will allow multiple cascaded validation on return values.

Returns:S

this following the chaining method pattern

Since

5.3

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

flag determining whether validation will allow overriding to alter parameter constraints.

Returns:S

this following the chaining method pattern

Since

5.3

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

flag determining whether validation will allow parameter constraints in parallel hierarchies

Returns:S

this following the chaining method pattern

Since

5.3

Annotations

@Incubating

Allows setting the Expression Language feature level for message interpolation of constraint messages.

This is the feature level used for messages hardcoded inside the constraint declaration.

If you are creating custom constraint violations, Expression Language support needs to be explicitly enabled and use the safest feature level by default if enabled.

Parameters

expressionLanguageFeatureLevel:ExpressionLanguageFeatureLevel

the ExpressionLanguageFeatureLevel to be used

Returns:S

this following the chaining method pattern

Annotations

@Incubating

Since

6.2

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

the payload passed to constraint validators

Returns:S

this following the chaining method pattern

Annotations

@Incubating

Since

6.0.8

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

A new constraint mapping.

Allows setting the Expression Language feature level for message interpolation of custom violation messages.

This is the feature level used for messages of custom violations created by the ConstraintValidatorContext.

Parameters

expressionLanguageFeatureLevel:ExpressionLanguageFeatureLevel

the ExpressionLanguageFeatureLevel to be used

Returns:S

this following the chaining method pattern

Annotations

@Incubating

Since

6.2

Allows setting the default locale used to interpolate the constraint violation messages.

If not set, defaults to the system locale obtained via Locale#getDefault().

Annotations

@Incubating

Since

6.1.1

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

flag determining whether per validation call caching is enabled for TraversableResolver results.

Returns:S

this following the chaining method pattern

Since

6.0.3

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

Parameters

externalClassLoader:ClassLoader

The class loader for loading user-provided resources.

Returns:S

this following the chaining method pattern

Since

5.2

En- or disables the fail fast mode. When fail fast is enabled the validation will stop on the first constraint violation detected.

Parameters

failFast:boolean

true to enable fail fast, false otherwise.

Returns:S

this following the chaining method pattern

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 org.hibernate.validator.messageinterpolation.ResourceBundleMessageInterpolator:

HibernateValidatorConfiguration configure =
   Validation.byProvider(HibernateValidator.class).configure();

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

 configure.messageInterpolator(
   new ResourceBundleMessageInterpolator(myResourceBundleLocator));

Returns:ResourceBundleLocator

The default ResourceBundleLocator. Never null.

Returns the default ValueExtractor implementations as per the specification.

Returns:Set<ValueExtractor<?>>

the default ValueExtractor implementations compliant with the specification

Annotations

@Incubating

Since

6.0

Allows to set a getter property selection strategy defining the rules determining if a method is a getter or not.

Parameters

getterPropertySelectionStrategy:GetterPropertySelectionStrategy

the GetterPropertySelectionStrategy to be used

Returns:S

this following the chaining method pattern

Annotations

@Incubating

Since

6.1.0

Allows setting a locale resolver, defining how the locale will be resolved when interpolating the message of a constraint violation.

Parameters

localeResolver:LocaleResolver

the LocaleResolver to be used

Returns:S

this following the chaining method pattern

Annotations

@Incubating

Since

6.1.1

Allows setting the list of the locales supported by this ValidatorFactory.

Can be used for advanced locale resolution and/or to force the initialization of the resource bundles at bootstrap.

If not set, defaults to a singleton containing Locale#getDefault().

Annotations

@Incubating

Since

6.1.1

Allows setting the list of the locales supported by this ValidatorFactory.

Can be used for advanced locale resolution and/or to force the initialization of the resource bundles at bootstrap.

If not set, defaults to a singleton containing Locale#getDefault().

Annotations

@Incubating

Since

6.1.1

Allows to set a property node name provider, defining how the name of a property node will be resolved when constructing a property path as the one returned by ConstraintViolation#getPropertyPath().

Parameters

propertyNodeNameProvider:PropertyNodeNameProvider

the PropertyNodeNameProvider to be used

Returns:S

this following the chaining method pattern

Annotations

@Incubating

Since

6.1.0

Allows to specify a custom ScriptEvaluatorFactory responsible for creating ScriptEvaluators used to evaluate script expressions for ScriptAssert and ParameterScriptAssert constraints.

Parameters

scriptEvaluatorFactory:ScriptEvaluatorFactory

the ScriptEvaluatorFactory to be used

Returns:S

this following the chaining method pattern

Annotations

@Incubating

Since

6.0.3

Allows setting the logging configuration that would include validated values in trace level logs.

By default, values will not be printed to the logs as they might contain sensitive data.

Parameters

enabled:boolean

flag determining whether validated values will be printed out into trace level logs or not.

Returns:S

this following the chaining method pattern

Annotations

@Incubating

Since

8.0

Allows to set the acceptable margin of error when comparing date/time in temporal constraints such as Past/PastOrPresent and Future/FutureOrPresent.

Parameters

temporalValidationTolerance:Duration

the acceptable tolerance

Returns:S

this following the chaining method pattern

Annotations

@Incubating

Since

6.0.5