HV-1942 Allow a single impl of a DefaultGroupSequenceProvider to be used on a wider range of types

marko-bekhta · marko-bekhta · commit 4d09a41742d1 · 2024-10-14T12:48:39.000+02:00
Since the existing assumption is that the provider is specific to a single type and cannot be placed on multiple types
diff --git a/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/BazDefaultGroupSequenceProvider.java b/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/BazDefaultGroupSequenceProvider.java
@@ -16,5 +16,5 @@
  */
 public interface BazDefaultGroupSequenceProvider extends DefaultGroupSequenceProvider<Baz> {
 	@Override
-	List<Class<?>> getValidationGroups(GroupSequenceProviderDefinition.Baz object);
+	List<Class<?>> getValidationGroups(Class<?> klass, GroupSequenceProviderDefinition.Baz object);
 }
diff --git a/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/FooBarBazDefaultGroupSequenceProvider.java b/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/FooBarBazDefaultGroupSequenceProvider.java
@@ -20,7 +20,7 @@ public FooBarBazDefaultGroupSequenceProvider(FooBarBaz fooBarBaz) {
 	}
 
 	@Override
-	public List<Class<?>> getValidationGroups(FooBarBaz object) {
+	public List<Class<?>> getValidationGroups(Class<?> klass, FooBarBaz object) {
 		return null;
 	}
 }
diff --git a/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/FooBarDefaultGroupSequenceProvider.java b/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/FooBarDefaultGroupSequenceProvider.java
@@ -17,5 +17,5 @@
 public abstract class FooBarDefaultGroupSequenceProvider implements DefaultGroupSequenceProvider<FooBar> {
 
 	@Override
-	public abstract List<Class<?>> getValidationGroups(FooBar object);
+	public abstract List<Class<?>> getValidationGroups(Class<?> klass, FooBar object);
 }
diff --git a/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/FooDefaultGroupSequenceProvider.java b/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/FooDefaultGroupSequenceProvider.java
@@ -17,7 +17,7 @@
 public class FooDefaultGroupSequenceProvider implements DefaultGroupSequenceProvider<Foo> {
 
 	@Override
-	public List<Class<?>> getValidationGroups(Foo object) {
+	public List<Class<?>> getValidationGroups(Class<?> klass, Foo object) {
 		return null;
 	}
 }
diff --git a/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/QuxDefaultGroupSequenceProvider.java b/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/QuxDefaultGroupSequenceProvider.java
@@ -17,7 +17,7 @@
 public class QuxDefaultGroupSequenceProvider implements DefaultGroupSequenceProvider<Qux> {
 
 	@Override
-	public List<Class<?>> getValidationGroups(Qux object) {
+	public List<Class<?>> getValidationGroups(Class<?> klass, Qux object) {
 		return null;
 	}
 }
diff --git a/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/SampleDefaultGroupSequenceProvider.java b/annotation-processor/src/test/java/org/hibernate/validator/ap/testmodel/groupsequenceprovider/SampleDefaultGroupSequenceProvider.java
@@ -17,7 +17,7 @@
 public class SampleDefaultGroupSequenceProvider implements DefaultGroupSequenceProvider<Sample> {
 
 	@Override
-	public List<Class<?>> getValidationGroups(Sample object) {
+	public List<Class<?>> getValidationGroups(Class<?> klass, Sample object) {
 		return null;
 	}
 }
diff --git a/documentation/src/test/java/org/hibernate/validator/referenceguide/chapter05/groupsequenceprovider/RentalCarGroupSequenceProvider.java b/documentation/src/test/java/org/hibernate/validator/referenceguide/chapter05/groupsequenceprovider/RentalCarGroupSequenceProvider.java
@@ -13,7 +13,7 @@ public class RentalCarGroupSequenceProvider
 		implements DefaultGroupSequenceProvider<RentalCar> {
 
 	@Override
-	public List<Class<?>> getValidationGroups(RentalCar car) {
+	public List<Class<?>> getValidationGroups(Class<?> klass, RentalCar car) {
 		List<Class<?>> defaultGroupSequence = new ArrayList<Class<?>>();
 		defaultGroupSequence.add( RentalCar.class );
 
diff --git a/documentation/src/test/java/org/hibernate/validator/referenceguide/chapter12/constraintapi/RentalCarGroupSequenceProvider.java b/documentation/src/test/java/org/hibernate/validator/referenceguide/chapter12/constraintapi/RentalCarGroupSequenceProvider.java
@@ -6,7 +6,7 @@
 
 public class RentalCarGroupSequenceProvider implements DefaultGroupSequenceProvider<RentalCar> {
 	@Override
-	public List<Class<?>> getValidationGroups(RentalCar car) {
+	public List<Class<?>> getValidationGroups(Class<?> klass, RentalCar car) {
 		return null;
 	}
 }
diff --git a/engine/src/main/java/org/hibernate/validator/internal/metadata/aggregated/BeanMetaDataImpl.java b/engine/src/main/java/org/hibernate/validator/internal/metadata/aggregated/BeanMetaDataImpl.java
@@ -378,7 +378,7 @@ public Optional<ExecutableMetaData> getMetaDataFor(Executable executable) {
 	@Override
 	public List<Class<?>> getDefaultGroupSequence(T beanState) {
 		if ( hasDefaultGroupSequenceProvider() ) {
-			List<Class<?>> providerDefaultGroupSequence = defaultGroupSequenceProvider.getValidationGroups( beanState );
+			List<Class<?>> providerDefaultGroupSequence = defaultGroupSequenceProvider.getValidationGroups( beanClass, beanState );
 			return getValidDefaultGroupSequence( beanClass, providerDefaultGroupSequence );
 		}
 
@@ -388,7 +388,7 @@ public List<Class<?>> getDefaultGroupSequence(T beanState) {
 	@Override
 	public Iterator<Sequence> getDefaultValidationSequence(T beanState) {
 		if ( hasDefaultGroupSequenceProvider() ) {
-			List<Class<?>> providerDefaultGroupSequence = defaultGroupSequenceProvider.getValidationGroups( beanState );
+			List<Class<?>> providerDefaultGroupSequence = defaultGroupSequenceProvider.getValidationGroups( beanClass, beanState );
 			return validationOrderGenerator.getDefaultValidationOrder(
 					beanClass,
 					getValidDefaultGroupSequence( beanClass, providerDefaultGroupSequence )
diff --git a/engine/src/main/java/org/hibernate/validator/internal/metadata/provider/AnnotationMetaDataProvider.java b/engine/src/main/java/org/hibernate/validator/internal/metadata/provider/AnnotationMetaDataProvider.java
@@ -169,14 +169,30 @@ private <T> DefaultGroupSequenceProvider<? super T> getDefaultGroupSequenceProvi
 	private <T> DefaultGroupSequenceProvider<? super T> newGroupSequenceProviderClassInstance(Class<T> beanClass,
 			Class<? extends DefaultGroupSequenceProvider<? super T>> providerClass) {
 		Method[] providerMethods = GetMethods.action( providerClass );
+		int numberOfDefaultMethods = 0;
 		for ( Method method : providerMethods ) {
 			if ( "getValidationGroups".equals( method.getName() )
 					&& !method.isBridge()
 					&& method.getParameterCount() == 1 && method.getParameterTypes()[0].isAssignableFrom( beanClass ) ) {
-
+				if ( method.isDefault() ) {
+					numberOfDefaultMethods++;
+					continue;
+				}
+				return NewInstance.action( providerClass, "the default group sequence provider" );
+			}
+			if ( "getValidationGroups".equals( method.getName() )
+					&& !method.isBridge()
+					&& method.getParameterCount() == 2 && method.getParameterTypes()[1].isAssignableFrom( beanClass ) ) {
+				if ( method.isDefault() ) {
+					numberOfDefaultMethods++;
+					continue;
+				}
 				return NewInstance.action( providerClass, "the default group sequence provider" );
 			}
 		}
+		if ( numberOfDefaultMethods == 2 ) {
+			throw LOG.getDefaultGroupSequenceProviderTypeDoesNotImplementAnyMethodsException( providerClass );
+		}
 
 		throw LOG.getWrongDefaultGroupSequenceProviderTypeException( beanClass );
 	}
diff --git a/engine/src/main/java/org/hibernate/validator/internal/util/logging/Log.java b/engine/src/main/java/org/hibernate/validator/internal/util/logging/Log.java
@@ -940,4 +940,8 @@ ConstraintDefinitionException getConstraintValidatorDefinitionConstraintMismatch
 
 	@Message(id = 267, value = "'%c' is neither a digit nor an upper case ASCII letter.")
 	IllegalArgumentException getCharacterIsNotDigitOrUpperCaseLetterException(char c);
+
+	@Message(id = 268, value = "The default group sequence provider %s does not implement neither `getValidationGroups(Class<?> klass, T object)` nor `getValidationGroups(T object)` methods."
+			+ " One of them has to be implemented for the default group sequence provider to be correctly defined.")
+	GroupDefinitionException getDefaultGroupSequenceProviderTypeDoesNotImplementAnyMethodsException(@FormatWith(ClassObjectFormatter.class) Class<?> klass);
 }
diff --git a/engine/src/main/java/org/hibernate/validator/spi/group/DefaultGroupSequenceProvider.java b/engine/src/main/java/org/hibernate/validator/spi/group/DefaultGroupSequenceProvider.java
@@ -11,28 +11,45 @@
 /**
  * This class defines the dynamic group sequence provider contract.
  * <p>
- * In order to redefine dynamically the default group sequence for a type T, the {@link org.hibernate.validator.group.GroupSequenceProvider} annotation
- * must be placed on T, specifying as its value a concrete implementation of {@code DefaultGroupSequenceProvider}, which
- * must be parametrized with the type T.
- * </p>
+ * In order to dynamically redefine the default group sequence for a type {@code T},
+ * the {@link org.hibernate.validator.group.GroupSequenceProvider} annotation
+ * must be placed on {@code T}, specifying as its value a concrete implementation of {@code DefaultGroupSequenceProvider}, which
+ * must be parametrized with that same type {@code T}, its subclass {@code Y} ({@code T t; t instanceof Y == true }
+ * or an interface {@code I} that is common to the beans on for which this sequence provider is expected to be applied to.
  * <p>
- * If during the validation process the {@code Default} group is validated for T, the actual validated instance
+ * If during the validation process the {@code Default} group is validated for {@code T}, the actual validated instance
  * is passed to the {@code DefaultGroupSequenceProvider} to determine the default group sequence.
- * </p>
  * <p>
  * Note:
  * <ul>
  * <li>Implementations must provide a public default constructor.</li>
  * <li>Implementations must be thread-safe.</li>
+ * <li>Implementations must return a valid default group sequence,
+ * i.e. the returned sequence <b>must</b> contain the bean type itself,
+ * which represents the {@link jakarta.validation.groups.Default default group}.</li>
  * </ul>
  *
  * @param <T> The type for which an implementation is defined.
- *
  * @author Kevin Pollet &lt;kevin.pollet@serli.com&gt; (C) 2011 SERLI
  * @author Hardy Ferentschik
  */
 public interface DefaultGroupSequenceProvider<T> {
 
+	/**
+	 * This method returns the default group sequence for the given {@code klass} bean type and {@code object} instance.
+	 * <p>
+	 * The object parameter allows to dynamically compose the default group sequence based on the state of the validated value.
+	 *
+	 * @param klass the type of the bean for which the group sequence is requested.
+	 * @param object the instance under validation. This value <b>can</b> be {@code null}, e.g. in case this method was called as part of
+	 * {@linkplain jakarta.validation.Validator#validateValue(Class, String, Object, Class[]) Validator#validateValue}.
+	 * @return a list of classes specifying the default group sequence. The same constraints to the redefined group list
+	 * apply as for lists defined via {@code GroupSequence}. In particular the list has to contain the type T.
+	 */
+	default List<Class<?>> getValidationGroups(Class<?> klass, T object) {
+		return getValidationGroups( object );
+	}
+
 	/**
 	 * This method returns the default group sequence for the given instance.
 	 * <p>
@@ -41,9 +58,12 @@ public interface DefaultGroupSequenceProvider<T> {
 	 *
 	 * @param object the instance being validated. This value can be {@code null} in case this method was called as part of
 	 * {@linkplain jakarta.validation.Validator#validateValue(Class, String, Object, Class[]) Validator#validateValue}.
-	 *
 	 * @return a list of classes specifying the default group sequence. The same constraints to the redefined group list
-	 *         apply as for lists defined via {@code GroupSequence}. In particular the list has to contain the type T.
+	 * apply as for lists defined via {@code GroupSequence}. In particular the list has to contain the type T.
+	 * @deprecated Use the {@link #getValidationGroups(Class, Object)} instead.
 	 */
-	List<Class<?>> getValidationGroups(T object);
+	@Deprecated(forRemoval = true, since = "9.0.0")
+	default List<Class<?>> getValidationGroups(T object) {
+		throw new AssertionError( "Unexpected call to get the validation group sequence. " + "The variant receiving the bean type must be used by Hibernate Validator" );
+	}
 }
diff --git a/engine/src/test/java/org/hibernate/validator/test/cfg/ConstraintMappingTest.java b/engine/src/test/java/org/hibernate/validator/test/cfg/ConstraintMappingTest.java
@@ -628,21 +628,21 @@ public String getLastName() {
 
 	public static class MarathonDefaultGroupSequenceProvider implements DefaultGroupSequenceProvider<Marathon> {
 		@Override
-		public List<Class<?>> getValidationGroups(Marathon object) {
+		public List<Class<?>> getValidationGroups(Class<?> klass, Marathon object) {
 			return Arrays.<Class<?>>asList( Foo.class, Marathon.class );
 		}
 	}
 
 	public static class BDefaultGroupSequenceProvider implements DefaultGroupSequenceProvider<B> {
 		@Override
-		public List<Class<?>> getValidationGroups(B object) {
+		public List<Class<?>> getValidationGroups(Class<?> klass, B object) {
 			return Arrays.<Class<?>>asList( Foo.class, B.class );
 		}
 	}
 
 	public static class ADefaultGroupSequenceProvider implements DefaultGroupSequenceProvider<A> {
 		@Override
-		public List<Class<?>> getValidationGroups(A object) {
+		public List<Class<?>> getValidationGroups(Class<?> klass, A object) {
 			return Arrays.<Class<?>>asList( Foo.class, A.class );
 		}
 	}
diff --git a/engine/src/test/java/org/hibernate/validator/test/cfg/MultipleConstraintMappingsTest.java b/engine/src/test/java/org/hibernate/validator/test/cfg/MultipleConstraintMappingsTest.java
@@ -178,7 +178,7 @@ private interface Foo {
 
 	public static class MarathonDefaultGroupSequenceProvider implements DefaultGroupSequenceProvider<Marathon> {
 		@Override
-		public List<Class<?>> getValidationGroups(Marathon object) {
+		public List<Class<?>> getValidationGroups(Class<?> klass, Marathon object) {
 			return Arrays.<Class<?>>asList( Foo.class, Marathon.class );
 		}
 	}
diff --git a/engine/src/test/java/org/hibernate/validator/test/internal/engine/groups/defaultgroupsequenceprovider/DefaultGroupSequenceProviderTest.java b/engine/src/test/java/org/hibernate/validator/test/internal/engine/groups/defaultgroupsequenceprovider/DefaultGroupSequenceProviderTest.java
diff --git a/engine/src/test/java/org/hibernate/validator/test/internal/engine/groups/defaultgroupsequenceprovider/DeprecatedDynamicGroupSequenceProvider.java b/engine/src/test/java/org/hibernate/validator/test/internal/engine/groups/defaultgroupsequenceprovider/DeprecatedDynamicGroupSequenceProvider.java
diff --git a/engine/src/test/java/org/hibernate/validator/test/internal/engine/groups/defaultgroupsequenceprovider/DeprecatedUser.java b/engine/src/test/java/org/hibernate/validator/test/internal/engine/groups/defaultgroupsequenceprovider/DeprecatedUser.java
diff --git a/engine/src/test/java/org/hibernate/validator/test/internal/engine/groups/defaultgroupsequenceprovider/DynamicGroupSequenceProvider.java b/engine/src/test/java/org/hibernate/validator/test/internal/engine/groups/defaultgroupsequenceprovider/DynamicGroupSequenceProvider.java

Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,5 @@`
`16`	`16`	`*/`
`17`	`17`	`public interface BazDefaultGroupSequenceProvider extends DefaultGroupSequenceProvider<Baz> {`
`18`	`18`	`@Override`
`19`		`- List<Class<?>> getValidationGroups(GroupSequenceProviderDefinition.Baz object);`
	`19`	`+ List<Class<?>> getValidationGroups(Class<?> klass, GroupSequenceProviderDefinition.Baz object);`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public FooBarBazDefaultGroupSequenceProvider(FooBarBaz fooBarBaz) {`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`@Override`
`23`		`- public List<Class<?>> getValidationGroups(FooBarBaz object) {`
	`23`	`+ public List<Class<?>> getValidationGroups(Class<?> klass, FooBarBaz object) {`
`24`	`24`	`return null;`
`25`	`25`	`}`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,5 +17,5 @@`
`17`	`17`	`public abstract class FooBarDefaultGroupSequenceProvider implements DefaultGroupSequenceProvider<FooBar> {`
`18`	`18`
`19`	`19`	`@Override`
`20`		`- public abstract List<Class<?>> getValidationGroups(FooBar object);`
	`20`	`+ public abstract List<Class<?>> getValidationGroups(Class<?> klass, FooBar object);`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`public class FooDefaultGroupSequenceProvider implements DefaultGroupSequenceProvider<Foo> {`
`18`	`18`
`19`	`19`	`@Override`
`20`		`- public List<Class<?>> getValidationGroups(Foo object) {`
	`20`	`+ public List<Class<?>> getValidationGroups(Class<?> klass, Foo object) {`
`21`	`21`	`return null;`
`22`	`22`	`}`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`public class RentalCarGroupSequenceProvider implements DefaultGroupSequenceProvider<RentalCar> {`
`8`	`8`	`@Override`
`9`		`- public List<Class<?>> getValidationGroups(RentalCar car) {`
	`9`	`+ public List<Class<?>> getValidationGroups(Class<?> klass, RentalCar car) {`
`10`	`10`	`return null;`
`11`	`11`	`}`
`12`	`12`	`}`