public class ConfigurationImpl extends java.lang.Object implements HibernateValidatorConfiguration, javax.validation.spi.ConfigurationState
Configuration
implementation.ALLOW_MULTIPLE_CASCADED_VALIDATION_ON_RESULT, ALLOW_PARALLEL_METHODS_DEFINE_PARAMETER_CONSTRAINTS, ALLOW_PARAMETER_CONSTRAINT_OVERRIDE, CONSTRAINT_MAPPING_CONTRIBUTOR, CONSTRAINT_MAPPING_CONTRIBUTORS, ENABLE_TRAVERSABLE_RESOLVER_RESULT_CACHE, FAIL_FAST, SCRIPT_EVALUATOR_FACTORY_CLASSNAME, TEMPORAL_VALIDATION_TOLERANCE
Constructor and Description |
---|
ConfigurationImpl(javax.validation.spi.BootstrapState state) |
ConfigurationImpl(javax.validation.spi.ValidationProvider<?> provider) |
Modifier and Type | Method and Description |
---|---|
HibernateValidatorConfiguration |
addMapping(ConstraintMapping mapping)
Adds the specified
ConstraintMapping instance to the configuration. |
HibernateValidatorConfiguration |
addMapping(java.io.InputStream stream) |
HibernateValidatorConfiguration |
addProperty(java.lang.String name,
java.lang.String value) |
HibernateValidatorConfiguration |
addValueExtractor(javax.validation.valueextraction.ValueExtractor<?> extractor) |
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 |
beanMetaDataClassNormalizer(BeanMetaDataClassNormalizer beanMetaDataClassNormalizer)
Allows to set a
BeanMetaDataClassNormalizer that will be used to normalize the class before
accessing the metadata. |
javax.validation.ValidatorFactory |
buildValidatorFactory() |
HibernateValidatorConfiguration |
clockProvider(javax.validation.ClockProvider clockProvider) |
ConfigurationImpl |
constraintValidatorFactory(javax.validation.ConstraintValidatorFactory constraintValidatorFactory) |
HibernateValidatorConfiguration |
constraintValidatorPayload(java.lang.Object constraintValidatorPayload)
Allows to set a payload which will be passed to the constraint validators.
|
DefaultConstraintMapping |
createConstraintMapping()
Creates a new constraint mapping which can be used to programmatically configure the constraints for given types.
|
ConfigurationImpl |
enableTraversableResolverResultCache(boolean enabled)
Define whether the per validation call caching of
TraversableResolver results is enabled. |
HibernateValidatorConfiguration |
externalClassLoader(java.lang.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.
|
BeanMetaDataClassNormalizer |
getBeanMetaDataClassNormalizer() |
javax.validation.BootstrapConfiguration |
getBootstrapConfiguration() |
javax.validation.ClockProvider |
getClockProvider() |
javax.validation.ConstraintValidatorFactory |
getConstraintValidatorFactory() |
java.lang.Object |
getConstraintValidatorPayload() |
javax.validation.ClockProvider |
getDefaultClockProvider() |
javax.validation.ConstraintValidatorFactory |
getDefaultConstraintValidatorFactory() |
javax.validation.MessageInterpolator |
getDefaultMessageInterpolator() |
javax.validation.ParameterNameProvider |
getDefaultParameterNameProvider() |
ResourceBundleLocator |
getDefaultResourceBundleLocator()
Returns the
ResourceBundleLocator used by the
default message
interpolator to load user-provided resource bundles. |
javax.validation.TraversableResolver |
getDefaultTraversableResolver() |
java.util.Set<javax.validation.valueextraction.ValueExtractor<?>> |
getDefaultValueExtractors()
Returns the default
ValueExtractor implementations as per the
specification. |
java.lang.ClassLoader |
getExternalClassLoader() |
boolean |
getFailFast() |
java.util.Set<java.io.InputStream> |
getMappingStreams() |
javax.validation.MessageInterpolator |
getMessageInterpolator() |
MethodValidationConfiguration |
getMethodValidationConfiguration() |
javax.validation.ParameterNameProvider |
getParameterNameProvider() |
java.util.Set<DefaultConstraintMapping> |
getProgrammaticMappings() |
java.util.Map<java.lang.String,java.lang.String> |
getProperties() |
ScriptEvaluatorFactory |
getScriptEvaluatorFactory() |
java.time.Duration |
getTemporalValidationTolerance() |
javax.validation.TraversableResolver |
getTraversableResolver() |
java.util.Set<javax.validation.valueextraction.ValueExtractor<?>> |
getValueExtractors() |
HibernateValidatorConfiguration |
ignoreXmlConfiguration() |
boolean |
isAllowMultipleCascadedValidationOnReturnValues() |
boolean |
isAllowOverridingMethodAlterParameterConstraint() |
boolean |
isAllowParallelMethodsDefineParameterConstraints() |
boolean |
isIgnoreXmlConfiguration() |
boolean |
isTraversableResolverResultCacheEnabled() |
ConfigurationImpl |
messageInterpolator(javax.validation.MessageInterpolator interpolator) |
HibernateValidatorConfiguration |
parameterNameProvider(javax.validation.ParameterNameProvider parameterNameProvider) |
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(java.time.Duration temporalValidationTolerance)
Allows to set the acceptable margin of error when comparing date/time in temporal constraints such as
Past /PastOrPresent and Future /FutureOrPresent . |
ConfigurationImpl |
traversableResolver(javax.validation.TraversableResolver resolver) |
public ConfigurationImpl(javax.validation.spi.BootstrapState state)
public ConfigurationImpl(javax.validation.spi.ValidationProvider<?> provider)
public final HibernateValidatorConfiguration ignoreXmlConfiguration()
ignoreXmlConfiguration
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public final ConfigurationImpl messageInterpolator(javax.validation.MessageInterpolator interpolator)
messageInterpolator
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public final ConfigurationImpl traversableResolver(javax.validation.TraversableResolver resolver)
traversableResolver
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public final ConfigurationImpl enableTraversableResolverResultCache(boolean enabled)
HibernateValidatorConfiguration
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.
enableTraversableResolverResultCache
in interface HibernateValidatorConfiguration
enabled
- flag determining whether per validation call caching is enabled for TraversableResolver
results.this
following the chaining method patternpublic final boolean isTraversableResolverResultCacheEnabled()
public final ConfigurationImpl constraintValidatorFactory(javax.validation.ConstraintValidatorFactory constraintValidatorFactory)
constraintValidatorFactory
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public HibernateValidatorConfiguration parameterNameProvider(javax.validation.ParameterNameProvider parameterNameProvider)
parameterNameProvider
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public HibernateValidatorConfiguration clockProvider(javax.validation.ClockProvider clockProvider)
clockProvider
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public HibernateValidatorConfiguration addValueExtractor(javax.validation.valueextraction.ValueExtractor<?> extractor)
addValueExtractor
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public final HibernateValidatorConfiguration addMapping(java.io.InputStream stream)
addMapping
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public final HibernateValidatorConfiguration failFast(boolean failFast)
HibernateValidatorConfiguration
failFast
in interface HibernateValidatorConfiguration
failFast
- true
to enable fail fast, false
otherwise.this
following the chaining method patternpublic HibernateValidatorConfiguration allowOverridingMethodAlterParameterConstraint(boolean allow)
HibernateValidatorConfiguration
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."
allowOverridingMethodAlterParameterConstraint
in interface HibernateValidatorConfiguration
allow
- flag determining whether validation will allow overriding to alter parameter constraints.this
following the chaining method patternpublic boolean isAllowOverridingMethodAlterParameterConstraint()
public HibernateValidatorConfiguration allowMultipleCascadedValidationOnReturnValues(boolean allow)
HibernateValidatorConfiguration
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."
allowMultipleCascadedValidationOnReturnValues
in interface HibernateValidatorConfiguration
allow
- flag determining whether validation will allow multiple cascaded validation on return values.this
following the chaining method patternpublic boolean isAllowMultipleCascadedValidationOnReturnValues()
public HibernateValidatorConfiguration allowParallelMethodsDefineParameterConstraints(boolean allow)
HibernateValidatorConfiguration
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."
allowParallelMethodsDefineParameterConstraints
in interface HibernateValidatorConfiguration
allow
- flag determining whether validation will allow parameter constraints in parallel hierarchiesthis
following the chaining method patternpublic HibernateValidatorConfiguration scriptEvaluatorFactory(ScriptEvaluatorFactory scriptEvaluatorFactory)
HibernateValidatorConfiguration
ScriptEvaluatorFactory
responsible for creating ScriptEvaluator
s
used to evaluate script expressions for ScriptAssert
and ParameterScriptAssert
constraints.scriptEvaluatorFactory
in interface HibernateValidatorConfiguration
scriptEvaluatorFactory
- the ScriptEvaluatorFactory
to be usedthis
following the chaining method patternpublic HibernateValidatorConfiguration temporalValidationTolerance(java.time.Duration temporalValidationTolerance)
HibernateValidatorConfiguration
Past
/PastOrPresent
and Future
/FutureOrPresent
.temporalValidationTolerance
in interface HibernateValidatorConfiguration
temporalValidationTolerance
- the acceptable tolerancethis
following the chaining method patternpublic HibernateValidatorConfiguration constraintValidatorPayload(java.lang.Object constraintValidatorPayload)
HibernateValidatorConfiguration
constraintValidatorPayload
in interface HibernateValidatorConfiguration
constraintValidatorPayload
- the payload passed to constraint validatorsthis
following the chaining method patternpublic boolean isAllowParallelMethodsDefineParameterConstraints()
public MethodValidationConfiguration getMethodValidationConfiguration()
public final DefaultConstraintMapping createConstraintMapping()
HibernateValidatorConfiguration
HibernateValidatorConfiguration.addMapping(ConstraintMapping)
.createConstraintMapping
in interface HibernateValidatorConfiguration
public final HibernateValidatorConfiguration addMapping(ConstraintMapping mapping)
HibernateValidatorConfiguration
ConstraintMapping
instance to the configuration. Constraints configured in mapping
will be added to the constraints configured via annotations and/or xml.addMapping
in interface HibernateValidatorConfiguration
mapping
- ConstraintMapping
instance containing programmatic configured constraintsthis
following the chaining method patternpublic final HibernateValidatorConfiguration addProperty(java.lang.String name, java.lang.String value)
addProperty
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public HibernateValidatorConfiguration externalClassLoader(java.lang.ClassLoader externalClassLoader)
HibernateValidatorConfiguration
META-INF/validation.xml
as well as XML constraint mappings)ValidationMessages
resource bundleexternalClassLoader
in interface HibernateValidatorConfiguration
externalClassLoader
- The class loader for loading user-provided resources.this
following the chaining method patternpublic HibernateValidatorConfiguration beanMetaDataClassNormalizer(BeanMetaDataClassNormalizer beanMetaDataClassNormalizer)
HibernateValidatorConfiguration
BeanMetaDataClassNormalizer
that will be used to normalize the class before
accessing the metadata.beanMetaDataClassNormalizer
in interface HibernateValidatorConfiguration
beanMetaDataClassNormalizer
- the BeanMetaDataClassNormalizer
to usethis
following the chaining method patternpublic BeanMetaDataClassNormalizer getBeanMetaDataClassNormalizer()
public final javax.validation.ValidatorFactory buildValidatorFactory()
buildValidatorFactory
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public final boolean isIgnoreXmlConfiguration()
isIgnoreXmlConfiguration
in interface javax.validation.spi.ConfigurationState
public final javax.validation.MessageInterpolator getMessageInterpolator()
getMessageInterpolator
in interface javax.validation.spi.ConfigurationState
public final java.util.Set<java.io.InputStream> getMappingStreams()
getMappingStreams
in interface javax.validation.spi.ConfigurationState
public final boolean getFailFast()
public final javax.validation.ConstraintValidatorFactory getConstraintValidatorFactory()
getConstraintValidatorFactory
in interface javax.validation.spi.ConfigurationState
public final javax.validation.TraversableResolver getTraversableResolver()
getTraversableResolver
in interface javax.validation.spi.ConfigurationState
public javax.validation.BootstrapConfiguration getBootstrapConfiguration()
getBootstrapConfiguration
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public javax.validation.ParameterNameProvider getParameterNameProvider()
getParameterNameProvider
in interface javax.validation.spi.ConfigurationState
public javax.validation.ClockProvider getClockProvider()
getClockProvider
in interface javax.validation.spi.ConfigurationState
public ScriptEvaluatorFactory getScriptEvaluatorFactory()
public java.time.Duration getTemporalValidationTolerance()
public java.lang.Object getConstraintValidatorPayload()
public java.util.Set<javax.validation.valueextraction.ValueExtractor<?>> getValueExtractors()
getValueExtractors
in interface javax.validation.spi.ConfigurationState
public final java.util.Map<java.lang.String,java.lang.String> getProperties()
getProperties
in interface javax.validation.spi.ConfigurationState
public java.lang.ClassLoader getExternalClassLoader()
public final javax.validation.MessageInterpolator getDefaultMessageInterpolator()
getDefaultMessageInterpolator
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public final javax.validation.TraversableResolver getDefaultTraversableResolver()
getDefaultTraversableResolver
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public final javax.validation.ConstraintValidatorFactory getDefaultConstraintValidatorFactory()
getDefaultConstraintValidatorFactory
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public final ResourceBundleLocator getDefaultResourceBundleLocator()
HibernateValidatorConfiguration
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));
getDefaultResourceBundleLocator
in interface HibernateValidatorConfiguration
ResourceBundleLocator
. Never null.public javax.validation.ParameterNameProvider getDefaultParameterNameProvider()
getDefaultParameterNameProvider
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public javax.validation.ClockProvider getDefaultClockProvider()
getDefaultClockProvider
in interface javax.validation.Configuration<HibernateValidatorConfiguration>
public java.util.Set<javax.validation.valueextraction.ValueExtractor<?>> getDefaultValueExtractors()
HibernateValidatorConfiguration
ValueExtractor
implementations as per the
specification.getDefaultValueExtractors
in interface HibernateValidatorConfiguration
ValueExtractor
implementations compliant
with the specificationpublic final java.util.Set<DefaultConstraintMapping> getProgrammaticMappings()
Copyright © 2007-2022 Red Hat, Inc. All Rights Reserved