HV-1749 Introduce a LocaleResolver contract

Author: gsmet

engine/src/main/java/org/hibernate/validator/BaseHibernateValidatorConfiguration.java

@@ -22,6 +22,7 @@
 import org.hibernate.validator.cfg.ConstraintMapping;
 import org.hibernate.validator.constraints.ParameterScriptAssert;
 import org.hibernate.validator.constraints.ScriptAssert;
+import org.hibernate.validator.spi.messageinterpolation.LocaleResolver;
 import org.hibernate.validator.spi.nodenameprovider.PropertyNodeNameProvider;
 import org.hibernate.validator.spi.properties.GetterPropertySelectionStrategy;
 import org.hibernate.validator.spi.resourceloading.ResourceBundleLocator;
@@ -131,6 +132,15 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	@Incubating
 	String PROPERTY_NODE_NAME_PROVIDER_CLASSNAME = "hibernate.validator.property_node_name_provider";
 
+	/**
+	 * Property for configuring the locale resolver, allowing to select an implementation of {@link LocaleResolver}
+	 * which will be used for locale resolution when interpolating a message.
+	 *
+	 * @since 6.1.1
+	 */
+	@Incubating
+	String LOCALE_RESOLVER_CLASSNAME = "hibernate.validator.locale_resolver";
+
 	/**
 	 * <p>
 	 * Returns the {@link ResourceBundleLocator} used by the
@@ -371,4 +381,16 @@ public interface BaseHibernateValidatorConfiguration<S extends BaseHibernateVali
 	 */
 	@Incubating
 	S defaultLocale(Locale defaultLocale);
+
+	/**
+	 * Allows setting a locale resolver, defining how the locale will be resolved when interpolating the message of a constraint violation.
+	 *
+	 * @param localeResolver the {@link LocaleResolver} to be used
+	 *
+	 * @return {@code this} following the chaining method pattern
+	 *
+	 * @since 6.1.1
+	 */
+	@Incubating
+	S localeResolver(LocaleResolver localeResolver);
 }

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

@@ -57,6 +57,7 @@
 import org.hibernate.validator.internal.xml.config.ValidationXmlParser;
 import org.hibernate.validator.messageinterpolation.ResourceBundleMessageInterpolator;
 import org.hibernate.validator.resourceloading.PlatformResourceBundleLocator;
+import org.hibernate.validator.spi.messageinterpolation.LocaleResolver;
 import org.hibernate.validator.spi.nodenameprovider.PropertyNodeNameProvider;
 import org.hibernate.validator.spi.properties.GetterPropertySelectionStrategy;
 import org.hibernate.validator.spi.resourceloading.ResourceBundleLocator;
@@ -112,9 +113,8 @@ public abstract class AbstractConfigurationImpl<T extends BaseHibernateValidator
 	private Duration temporalValidationTolerance;
 	private Object constraintValidatorPayload;
 	private GetterPropertySelectionStrategy getterPropertySelectionStrategy;
-
-	// the default locale
 	private Locale defaultLocale = Locale.getDefault();
+	private LocaleResolver localeResolver;
 
 	protected AbstractConfigurationImpl(BootstrapState state) {
 		this();
@@ -235,6 +235,19 @@ public T propertyNodeNameProvider(PropertyNodeNameProvider propertyNodeNameProvi
 		return thisAsT();
 	}
 
+	@Override
+	public T localeResolver(LocaleResolver localeResolver) {
+		if ( LOG.isDebugEnabled() ) {
+			if ( localeResolver != null ) {
+				LOG.debug( "Setting custom LocaleResolver of type " + localeResolver.getClass()
+						.getName() );
+			}
+		}
+		this.localeResolver = localeResolver;
+
+		return thisAsT();
+	}
+
 	@Override
 	public T addValueExtractor(ValueExtractor<?> extractor) {
 		Contracts.assertNotNull( extractor, MESSAGES.parameterMustNotBeNull( "extractor" ) );
@@ -489,6 +502,10 @@ public PropertyNodeNameProvider getPropertyNodeNameProvider() {
 		return validationBootstrapParameters.getPropertyNodeNameProvider();
 	}
 
+	public LocaleResolver getLocaleResolver() {
+		return localeResolver;
+	}
+
 	public ScriptEvaluatorFactory getScriptEvaluatorFactory() {
 		return scriptEvaluatorFactory;
 	}
@@ -527,7 +544,7 @@ public ClassLoader getExternalClassLoader() {
 	public final MessageInterpolator getDefaultMessageInterpolator() {
 		if ( defaultMessageInterpolator == null ) {
 			defaultMessageInterpolator = new ResourceBundleMessageInterpolator( getDefaultResourceBundleLocator(), getAllLocalesToInitialize(),
-					defaultLocale );
+					defaultLocale, ValidatorFactoryConfigurationHelper.determineLocaleResolver( this, this.getProperties(), externalClassLoader ) );
 		}
 
 		return defaultMessageInterpolator;
@@ -717,7 +734,8 @@ private MessageInterpolator getDefaultMessageInterpolatorConfiguredWithClassLoad
 						userResourceBundleLocator,
 						contributorResourceBundleLocator,
 						getAllLocalesToInitialize(),
-						defaultLocale
+						defaultLocale,
+						ValidatorFactoryConfigurationHelper.determineLocaleResolver( this, this.getProperties(), externalClassLoader )
 				);
 			}
 			finally {

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

@@ -9,6 +9,7 @@
 import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.determineAllowMultipleCascadedValidationOnReturnValues;
 import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.determineAllowOverridingMethodAlterParameterConstraint;
 import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.determineAllowParallelMethodsDefineParameterConstraints;
+import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.determineBeanMetaDataClassNormalizer;
 import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.determineConstraintMappings;
 import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.determineConstraintValidatorPayload;
 import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.determineExternalClassLoader;
@@ -18,7 +19,6 @@
 import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.determineTraversableResolverResultCacheEnabled;
 import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.logValidatorFactoryScopedConfiguration;
 import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.registerCustomConstraintValidators;
-import static org.hibernate.validator.internal.engine.ValidatorFactoryConfigurationHelper.determineBeanMetaDataClassNormalizer;
 import static org.hibernate.validator.internal.util.CollectionHelper.newArrayList;
 
 import java.lang.invoke.MethodHandles;

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

@@ -25,6 +25,7 @@
 import org.hibernate.validator.cfg.ConstraintMapping;
 import org.hibernate.validator.internal.cfg.context.DefaultConstraintMapping;
 import org.hibernate.validator.internal.engine.constraintdefinition.ConstraintDefinitionContribution;
+import org.hibernate.validator.internal.engine.messageinterpolation.DefaultLocaleResolver;
 import org.hibernate.validator.internal.engine.scripting.DefaultScriptEvaluatorFactory;
 import org.hibernate.validator.internal.metadata.DefaultBeanMetaDataClassNormalizer;
 import org.hibernate.validator.internal.metadata.core.ConstraintHelper;
@@ -39,6 +40,7 @@
 import org.hibernate.validator.internal.util.privilegedactions.NewInstance;
 import org.hibernate.validator.metadata.BeanMetaDataClassNormalizer;
 import org.hibernate.validator.spi.cfg.ConstraintMappingContributor;
+import org.hibernate.validator.spi.messageinterpolation.LocaleResolver;
 import org.hibernate.validator.spi.nodenameprovider.PropertyNodeNameProvider;
 import org.hibernate.validator.spi.properties.GetterPropertySelectionStrategy;
 import org.hibernate.validator.spi.scripting.ScriptEvaluatorFactory;
@@ -318,6 +320,32 @@ static PropertyNodeNameProvider determinePropertyNodeNameProvider(AbstractConfig
 		return new DefaultPropertyNodeNameProvider();
 	}
 
+	static LocaleResolver determineLocaleResolver(AbstractConfigurationImpl<?> hibernateSpecificConfig, Map<String, String> properties,
+			ClassLoader externalClassLoader) {
+		if ( hibernateSpecificConfig.getLocaleResolver() != null ) {
+			LOG.usingLocaleResolver( hibernateSpecificConfig.getLocaleResolver().getClass() );
+
+			return hibernateSpecificConfig.getLocaleResolver();
+		}
+
+		String localeResolverFqcn = properties.get( HibernateValidatorConfiguration.LOCALE_RESOLVER_CLASSNAME );
+		if ( localeResolverFqcn != null ) {
+			try {
+				@SuppressWarnings("unchecked")
+				Class<? extends LocaleResolver> clazz = (Class<? extends LocaleResolver>) run( LoadClass.action( localeResolverFqcn, externalClassLoader ) );
+				LocaleResolver localeResolver = run( NewInstance.action( clazz, "locale resolver class" ) );
+				LOG.usingLocaleResolver( clazz );
+
+				return localeResolver;
+			}
+			catch (Exception e) {
+				throw LOG.getUnableToInstantiateLocaleResolverClassException( localeResolverFqcn, e );
+			}
+		}
+
+		return new DefaultLocaleResolver();
+	}
+
 	static void registerCustomConstraintValidators(Set<DefaultConstraintMapping> constraintMappings,
 			ConstraintHelper constraintHelper) {
 		Set<Class<?>> definedConstraints = newHashSet();

engine/src/main/java/org/hibernate/validator/internal/engine/messageinterpolation/DefaultLocaleResolver.java

@@ -0,0 +1,20 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator.internal.engine.messageinterpolation;
+
+import java.util.Locale;
+
+import org.hibernate.validator.spi.messageinterpolation.LocaleResolver;
+import org.hibernate.validator.spi.messageinterpolation.LocaleResolverContext;
+
+public class DefaultLocaleResolver implements LocaleResolver {
+
+	@Override
+	public Locale resolve(LocaleResolverContext context) {
+		return context.getDefaultLocale();
+	}
+}

engine/src/main/java/org/hibernate/validator/internal/engine/messageinterpolation/DefaultLocaleResolverContext.java

@@ -0,0 +1,34 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator.internal.engine.messageinterpolation;
+
+import java.util.Locale;
+import java.util.Set;
+
+import org.hibernate.validator.spi.messageinterpolation.LocaleResolverContext;
+
+public class DefaultLocaleResolverContext implements LocaleResolverContext {
+
+	private final Set<Locale> supportedLocales;
+
+	private final Locale defaultLocale;
+
+	public DefaultLocaleResolverContext(Set<Locale> supportedLocales, Locale defaultLocale) {
+		this.supportedLocales = supportedLocales;
+		this.defaultLocale = defaultLocale;
+	}
+
+	@Override
+	public Set<Locale> getSupportedLocales() {
+		return supportedLocales;
+	}
+
+	@Override
+	public Locale getDefaultLocale() {
+		return defaultLocale;
+	}
+}

engine/src/main/java/org/hibernate/validator/internal/util/logging/Log.java

@@ -63,6 +63,7 @@
 import org.hibernate.validator.internal.util.logging.formatter.ObjectArrayFormatter;
 import org.hibernate.validator.internal.util.logging.formatter.TypeFormatter;
 import org.hibernate.validator.internal.xml.mapping.ContainerElementTypePath;
+import org.hibernate.validator.spi.messageinterpolation.LocaleResolver;
 import org.hibernate.validator.spi.nodenameprovider.PropertyNodeNameProvider;
 import org.hibernate.validator.spi.properties.GetterPropertySelectionStrategy;
 import org.hibernate.validator.spi.scripting.ScriptEvaluationException;
@@ -900,4 +901,11 @@ ConstraintDefinitionException getConstraintValidatorDefinitionConstraintMismatch
 			+ " To solve this, compile your code with the '-parameters' flag."
 	)
 	void missingParameterMetadataWithSyntheticOrImplicitParameters(@FormatWith(ExecutableFormatter.class) Executable executable);
+
+	@LogMessage(level = DEBUG)
+	@Message(id = 255, value = "Using %s as locale resolver.")
+	void usingLocaleResolver(@FormatWith(ClassObjectFormatter.class) Class<? extends LocaleResolver> localeResolverClass);
+
+	@Message(id = 256, value = "Unable to instantiate locale resolver class %s.")
+	ValidationException getUnableToInstantiateLocaleResolverClassException(String localeResolverClassName, @Cause Exception e);
 }