HV-1657 Make the “propertyPath” available via the HibernateMessageInterpolatorContext

Author: sjaakd

engine/src/main/java/org/hibernate/validator/internal/engine/MessageInterpolatorContext.java

@@ -11,6 +11,7 @@
 import java.lang.invoke.MethodHandles;
 import java.util.Map;
 
+import javax.validation.Path;
 import javax.validation.metadata.ConstraintDescriptor;
 
 import org.hibernate.validator.internal.util.logging.Log;
@@ -33,19 +34,22 @@ public class MessageInterpolatorContext implements HibernateMessageInterpolatorC
 	private final ConstraintDescriptor<?> constraintDescriptor;
 	private final Object validatedValue;
 	private final Class<?> rootBeanType;
+	private final Path propertyPath;
 	@Immutable
 	private final Map<String, Object> messageParameters;
 	@Immutable
 	private final Map<String, Object> expressionVariables;
 
 	public MessageInterpolatorContext(ConstraintDescriptor<?> constraintDescriptor,
-			Object validatedValue,
-			Class<?> rootBeanType,
-			Map<String, Object> messageParameters,
-			Map<String, Object> expressionVariables) {
+					Object validatedValue,
+					Class<?> rootBeanType,
+					Path propertyPath,
+					Map<String, Object> messageParameters,
+					Map<String, Object> expressionVariables) {
 		this.constraintDescriptor = constraintDescriptor;
 		this.validatedValue = validatedValue;
 		this.rootBeanType = rootBeanType;
+		this.propertyPath = propertyPath;
 		this.messageParameters = toImmutableMap( messageParameters );
 		this.expressionVariables = toImmutableMap( expressionVariables );
 	}
@@ -75,6 +79,11 @@ public Map<String, Object> getExpressionVariables() {
 		return expressionVariables;
 	}
 
+	@Override
+	public Path getPropertyPath() {
+		return propertyPath;
+	}
+
 	@Override
 	public <T> T unwrap(Class<T> type) {
 		//allow unwrapping into public super types
@@ -122,6 +131,8 @@ public String toString() {
 		sb.append( "MessageInterpolatorContext" );
 		sb.append( "{constraintDescriptor=" ).append( constraintDescriptor );
 		sb.append( ", validatedValue=" ).append( validatedValue );
+		sb.append( ", rootBeanType=" ).append( rootBeanType.getName() );
+		sb.append( ", propertyPath=" ).append( propertyPath );
 		sb.append( ", messageParameters=" ).append( messageParameters );
 		sb.append( ", expressionVariables=" ).append( expressionVariables );
 		sb.append( '}' );

engine/src/main/java/org/hibernate/validator/internal/engine/validationcontext/AbstractValidationContext.java

@@ -228,6 +228,7 @@ public void addConstraintFailure(
 				messageTemplate,
 				valueContext.getCurrentValidatedValue(),
 				descriptor,
+				constraintViolationCreationContext.getPath(),
 				constraintViolationCreationContext.getMessageParameters(),
 				constraintViolationCreationContext.getExpressionVariables()
 		);
@@ -293,12 +294,14 @@ private String interpolate(
 			String messageTemplate,
 			Object validatedValue,
 			ConstraintDescriptor<?> descriptor,
+			Path path,
 			Map<String, Object> messageParameters,
 			Map<String, Object> expressionVariables) {
 		MessageInterpolatorContext context = new MessageInterpolatorContext(
 				descriptor,
 				validatedValue,
 				getRootBeanClass(),
+				path,
 				messageParameters,
 				expressionVariables
 		);

engine/src/main/java/org/hibernate/validator/messageinterpolation/HibernateMessageInterpolatorContext.java

@@ -9,6 +9,7 @@
 import java.util.Map;
 
 import javax.validation.MessageInterpolator;
+import javax.validation.Path;
 
 /**
  * Extension to {@code MessageInterpolator.Context} which provides functionality
@@ -40,4 +41,11 @@ public interface HibernateMessageInterpolatorContext extends MessageInterpolator
 	 * @since 5.4.1
 	 */
 	Map<String, Object> getExpressionVariables();
+
+	/**
+	 * @return the path to the validated constraint starting from the root bean
+	 *
+	 * @since 6.1
+	 */
+	Path getPropertyPath();
 }

engine/src/test/java/org/hibernate/validator/test/internal/engine/messageinterpolation/ExpressionLanguageMessageInterpolationTest.java

@@ -67,9 +67,9 @@ public void testExpressionLanguageGraphNavigation() {
 				notNullDescriptor,
 				user,
 				null,
+				null,
 				Collections.<String, Object>emptyMap(),
-				Collections.<String, Object>emptyMap()
-		);
+				Collections.<String, Object>emptyMap() );
 
 		String expected = "18";
 		String actual = interpolatorUnderTest.interpolate( "${validatedValue.age}", context );
@@ -82,9 +82,9 @@ public void testUnknownPropertyInExpressionLanguageGraphNavigation() {
 				notNullDescriptor,
 				new User(),
 				null,
+				null,
 				Collections.<String, Object>emptyMap(),
-				Collections.<String, Object>emptyMap()
-		);
+				Collections.<String, Object>emptyMap() );
 
 		String expected = "${validatedValue.foo}";
 		String actual = interpolatorUnderTest.interpolate( "${validatedValue.foo}", context );
@@ -172,9 +172,9 @@ public void testLocaleBasedFormatting() {
 				notNullDescriptor,
 				42.00000d,
 				null,
+				null,
 				Collections.<String, Object>emptyMap(),
-				Collections.<String, Object>emptyMap()
-		);
+				Collections.<String, Object>emptyMap() );
 
 		// german locale
 		String expected = "42,00";
@@ -232,9 +232,9 @@ public void testCallingWrongFormatterMethod() {
 				notNullDescriptor,
 				42.00000d,
 				null,
+				null,
 				Collections.<String, Object>emptyMap(),
-				Collections.<String, Object>emptyMap()
-		);
+				Collections.<String, Object>emptyMap() );
 
 		String expected = "${formatter.foo('%1$.2f', validatedValue)}";
 		String actual = interpolatorUnderTest.interpolate(
@@ -308,8 +308,8 @@ private MessageInterpolatorContext createMessageInterpolatorContext(ConstraintDe
 				descriptor,
 				null,
 				null,
+				null,
 				Collections.<String, Object>emptyMap(),
-				Collections.<String, Object>emptyMap()
-		);
+				Collections.<String, Object>emptyMap() );
 	}
 }