Package jakarta.validation
Interface BootstrapConfiguration
public interface BootstrapConfiguration
Represents the user specified default configuration in
META-INF/validation.xml
.
Note that modifications to the returned objects do not have any effect.
Instead use the methods provided on Configuration
in order to
apply modifications to the configuration.
- Since:
- 1.1
- Author:
- Emmanuel Bernard, Gunnar Morling, Hardy Ferentschik, Guillaume Smet
-
Method Summary
Modifier and TypeMethodDescriptionClass name of theClockProvider
implementation ornull
if none is specified.Returns a set of resource paths pointing to XML constraint mapping files.Class name of theConstraintValidatorFactory
implementation ornull
if none is specified.Class name of theValidationProvider
implementation ornull
if none is specified.Returns the set of executable types that should be considered unless explicitly overridden viaValidateOnExecution
.Class name of theMessageInterpolator
implementation ornull
if none is specified.Class name of theParameterNameProvider
implementation ornull
if none is specified.Returns properties as a map of string based key/value pairs.Class name of theTraversableResolver
implementation ornull
if none is specified.Returns the class names ofValueExtractor
s.boolean
Returns true if the validation execution is explicitly marked as enabled or if it is left undefined.
-
Method Details
-
getDefaultProviderClassName
String getDefaultProviderClassName()Class name of theValidationProvider
implementation ornull
if none is specified.- Returns:
- validation provider class name or
null
-
getConstraintValidatorFactoryClassName
String getConstraintValidatorFactoryClassName()Class name of theConstraintValidatorFactory
implementation ornull
if none is specified.- Returns:
- constraint validator factory class name or
null
-
getMessageInterpolatorClassName
String getMessageInterpolatorClassName()Class name of theMessageInterpolator
implementation ornull
if none is specified.- Returns:
- message interpolator class name or
null
-
getTraversableResolverClassName
String getTraversableResolverClassName()Class name of theTraversableResolver
implementation ornull
if none is specified.- Returns:
- traversable resolver class name or
null
-
getParameterNameProviderClassName
String getParameterNameProviderClassName()Class name of theParameterNameProvider
implementation ornull
if none is specified.- Returns:
- parameter name provider class name or
null
-
getClockProviderClassName
String getClockProviderClassName()Class name of theClockProvider
implementation ornull
if none is specified.- Returns:
- clock provider class name or
null
- Since:
- 2.0
-
getValueExtractorClassNames
Returns the class names ofValueExtractor
s.- Returns:
- the value extractor class names or an empty set if none are specified
- Since:
- 2.0
-
getConstraintMappingResourcePaths
Returns a set of resource paths pointing to XML constraint mapping files. The set is empty if none are specified.- Returns:
- set of constraint mapping resource paths
-
isExecutableValidationEnabled
boolean isExecutableValidationEnabled()Returns true if the validation execution is explicitly marked as enabled or if it is left undefined.- Returns:
- whether validation execution is globally enabled
-
getDefaultValidatedExecutableTypes
Set<ExecutableType> getDefaultValidatedExecutableTypes()Returns the set of executable types that should be considered unless explicitly overridden viaValidateOnExecution
.Returns a set containing
ExecutableType.CONSTRUCTORS
andExecutableType.NON_GETTER_METHODS
if unspecified in the configuration.- Returns:
- set of validated executable types
-
getProperties
Returns properties as a map of string based key/value pairs. The map is empty if no property has been specified.- Returns:
- the properties map
-