org.hibernate.validator

Interface HibernateValidatorConfiguration

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSTRAINT_DEFINITION_CONTRIBUTORS Property corresponding to the addConstraintDefinitionContributor(org.hibernate.validator.spi.constraintdefinition.ConstraintDefinitionContributor) method.
static String	CONSTRAINT_MAPPING_CONTRIBUTOR Property for configuring a constraint mapping contributor, allowing to set up one or more constraint mappings for the default validator factory.
static String	FAIL_FAST Property corresponding to the failFast(boolean) method.
static String	TIME_PROVIDER
static String	VALIDATED_VALUE_HANDLERS Property corresponding to the addValidatedValueHandler(ValidatedValueUnwrapper) method.

Method Summary

Modifier and Type	Method and Description
HibernateValidatorConfiguration	addConstraintDefinitionContributor(ConstraintDefinitionContributor contributor) Registers the given ConstraintDefinitionContributor with the bootstrapped validator factory.
HibernateValidatorConfiguration	addMapping(ConstraintMapping mapping) Adds the specified ConstraintMapping instance to the configuration.
HibernateValidatorConfiguration	addValidatedValueHandler(ValidatedValueUnwrapper<?> handler) Registers the given validated value unwrapper with the bootstrapped validator factory.
ConstraintMapping	createConstraintMapping() Creates a new constraint mapping which can be used to programmatically configure the constraints for given types.
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.
ConstraintDefinitionContributor	getDefaultConstraintDefinitionContributor()
ResourceBundleLocator	getDefaultResourceBundleLocator() Returns the ResourceBundleLocator used by the default message interpolator to load user-provided resource bundles.
HibernateValidatorConfiguration	timeProvider(TimeProvider timeProvider) Registers the given time provider with the bootstrapped validator factory.

Methods inherited from interface javax.validation.Configuration

addMapping, addProperty, buildValidatorFactory, constraintValidatorFactory, getBootstrapConfiguration, 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

VALIDATED_VALUE_HANDLERS

static final String VALIDATED_VALUE_HANDLERS

Property corresponding to the addValidatedValueHandler(ValidatedValueUnwrapper) method. Accepts a String with the comma-separated fully-qualified names of one or more ValidatedValueUnwrapper implementations.

See Also:

Constant Field Values

CONSTRAINT_DEFINITION_CONTRIBUTORS

static final String CONSTRAINT_DEFINITION_CONTRIBUTORS

Property corresponding to the addConstraintDefinitionContributor(org.hibernate.validator.spi.constraintdefinition.ConstraintDefinitionContributor) method. Accepts a String with the comma-separated fully-qualified names of one or more ConstraintDefinitionContributor implementations.

Since:

5.2

See Also:

Constant Field Values

CONSTRAINT_MAPPING_CONTRIBUTOR

static final String CONSTRAINT_MAPPING_CONTRIBUTOR

Property for configuring a constraint mapping contributor, allowing to set up one or more constraint mappings for the default validator factory. Accepts a String with the fully-qualified class name of a ConstraintMappingContributor implementation.

Since:

5.2

See Also:

Constant Field Values

TIME_PROVIDER

static final String TIME_PROVIDER

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.

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

addValidatedValueHandler

HibernateValidatorConfiguration addValidatedValueHandler(ValidatedValueUnwrapper<?> handler)

Registers the given validated value unwrapper with the bootstrapped validator factory. When validating an element which is of a type supported by the unwrapper and which is annotated with UnwrapValidatedValue, the unwrapper will be applied to retrieve the value to validate.

Parameters:

handler - the unwrapper to register

Returns:

this following the chaining method pattern

getDefaultConstraintDefinitionContributor

ConstraintDefinitionContributor getDefaultConstraintDefinitionContributor()

Returns:

the default ConstraintDefinitionContributor. Never null.

Since:

5.2

addConstraintDefinitionContributor

HibernateValidatorConfiguration addConstraintDefinitionContributor(ConstraintDefinitionContributor contributor)

Registers the given ConstraintDefinitionContributor with the bootstrapped validator factory.

Parameters:

contributor - the ConstraintDefinitionContributor to register. Cannot be null.

Returns:

this following the chaining method pattern

Since:

5.2

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

timeProvider

HibernateValidatorConfiguration timeProvider(TimeProvider timeProvider)

Registers the given time provider with the bootstrapped validator factory. This provider will be used to obtain the current time when validating @Future and @Past constraints. By default the current system time and the current default time zone will be used when validating these constraints.

Parameters:

timeProvider - the time provider to register. Must not be null

Returns:

this following the chaining method pattern

Since:

5.2