Skip to content

[jakartaee/validation#257] Support ConstraintValidator declaration via service loader [BVAL-645] #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marko-bekhta merged 1 commit into from
Oct 22, 2025
Merged

[jakartaee/validation#257] Support ConstraintValidator declaration via service loader [BVAL-645] #299

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions sources/_constraint-declaration-validation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1791,9 +1791,33 @@ When the {spec-name-bv} provider is about to perform a cascaded validation of th
* `elementType`: [classname]`ElementType.FIELD`. The [varname]`country` property is annotated on its field.


[[constraintdeclarationvalidationprocess-validationroutine-typevalidatorresolution]]
[[constraintdeclarationvalidationprocess-validationroutine-validatorresolution]]
==== ConstraintValidator resolution

[[constraintdeclarationvalidationprocess-validationroutine-register-validators]]
===== Registering ConstraintValidator implementations

Constraint validators can be registered with the validation engine in the following ways:

* Provided by the validation engine itself (see <<builtinconstraints,Built-in constraints>>)
* [tck-testable]#Via the Java https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ServiceLoader.html[service loader] mechanism;
for this the file _META-INF/services/jakarta.validation.ConstraintValidator_ must be provided#,
with the fully-qualified name(s) of one or more constraint validator implementations as its contents.
* [tck-testable]#Provided in the `validatedBy()` attribute of the `@jakarta.validation.Constraint` annotation#.
* [tck-testable]#Through XML mapping# (see <<xml-mapping-constraintdeclarationinxml>>).

[tck-testable]#If multiple constraint validators for the exactly same constraint and target type are registered via one of the above methods,
a `jakarta.validation.ValidationException` is thrown,#
[tck-testable]#unless the constraint validator configuration source allows specifying that it overrides any previously defined constraint validators
for the particular constraint (e.g. <<xml-mapping-constraintdeclarationinxml-classleveloverriding>>/<<xml-mapping-constraintdeclarationinxml-constructorleveloverriding>>/<<xml-mapping-constraintdeclarationinxml-fieldleveloverriding>>/<<xml-mapping-constraintdeclarationinxml-methodleveloverriding>>/<<xml-mapping-constraintdeclarationinxml-propertyleveloverriding>>).#

==== ConstraintValidator resolution algorithm
[NOTE]
====
{spec-name-bv} providers may have other means to register and/or override constraint validators.
====

[[constraintdeclarationvalidationprocess-validationroutine-typevalidatorresolution]]
===== ConstraintValidator resolution algorithm

A constraint is associated to one or more [classname]`ConstraintValidator` implementations. Each [classname]`ConstraintValidator<A, T>` accepts the type [classname]`T`. The [classname]`ConstraintValidator` executed depends on the type hosting the constraint. For a given constraint evaluation, a single [classname]`ConstraintValidator` is considered.

Expand Down Expand Up @@ -1909,7 +1933,7 @@ Exactly one value extractor must be identified when processing a container eleme
Value extractors can be registered with the validation engine in the following ways (in increasing order of priority):

* Provided by the validation engine itself (see <<valueextractordefinition-builtinvalueextractors>>)
* [tck-testable]#Via the Java https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html[service loader] mechanism; for this the file _META-INF/services/jakarta.validation.valueextraction.ValueExtractor_ must be provided#,
* [tck-testable]#Via the Java https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ServiceLoader.html[service loader] mechanism; for this the file _META-INF/services/jakarta.validation.valueextraction.ValueExtractor_ must be provided#,
with the fully-qualified name(s) of one or more extractor implementations as its contents.
It is undefined which value extractor will be selected if multiple extractors for the same type and type parameter are registered via the service loader mechanism.
* [tck-testable]#By specifying the fully-qualified class name of one or several extractors in `META-INF/validation.xml`# (see <<validationapi-bootstrapping-xmlconfiguration>>). Not more than one extractor for the same type and type parameter may be given.
Expand Down