org.hibernate.validator.messageinterpolation.ResourceBundleMessageInterpolator Maven / Gradle / Ivy
/*
* Hibernate Validator, declare and validate application constraints
*
* License: Apache License, Version 2.0
* See the license.txt file in the root directory or .
*/
package org.hibernate.validator.messageinterpolation;
import java.lang.invoke.MethodHandles;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.Collections;
import java.util.Locale;
import java.util.Set;
import jakarta.el.ELManager;
import jakarta.el.ExpressionFactory;
import org.hibernate.validator.Incubating;
import org.hibernate.validator.internal.engine.messageinterpolation.DefaultLocaleResolver;
import org.hibernate.validator.internal.engine.messageinterpolation.InterpolationTerm;
import org.hibernate.validator.internal.util.logging.Log;
import org.hibernate.validator.internal.util.logging.LoggerFactory;
import org.hibernate.validator.internal.util.privilegedactions.GetClassLoader;
import org.hibernate.validator.internal.util.privilegedactions.SetContextClassLoader;
import org.hibernate.validator.spi.messageinterpolation.LocaleResolver;
import org.hibernate.validator.spi.resourceloading.ResourceBundleLocator;
/**
* Resource bundle backed message interpolator.
*
* @author Emmanuel Bernard
* @author Hardy Ferentschik
* @author Gunnar Morling
* @author Kevin Pollet <[email protected]> (C) 2011 SERLI
* @author Adam Stawicki
* @author Guillaume Smet
*/
public class ResourceBundleMessageInterpolator extends AbstractMessageInterpolator {
private static final Log LOG = LoggerFactory.make( MethodHandles.lookup() );
private final ExpressionFactory expressionFactory;
public ResourceBundleMessageInterpolator() {
this( Collections.emptySet(), Locale.getDefault(), new DefaultLocaleResolver(), false );
}
public ResourceBundleMessageInterpolator(ResourceBundleLocator userResourceBundleLocator) {
this( userResourceBundleLocator, Collections.emptySet(), Locale.getDefault(), new DefaultLocaleResolver(), false );
}
public ResourceBundleMessageInterpolator(ResourceBundleLocator userResourceBundleLocator,
ResourceBundleLocator contributorResourceBundleLocator) {
this( userResourceBundleLocator, contributorResourceBundleLocator, Collections.emptySet(), Locale.getDefault(), new DefaultLocaleResolver(), false );
}
public ResourceBundleMessageInterpolator(ResourceBundleLocator userResourceBundleLocator,
ResourceBundleLocator contributorResourceBundleLocator,
boolean cachingEnabled) {
this( userResourceBundleLocator, contributorResourceBundleLocator, Collections.emptySet(), Locale.getDefault(), new DefaultLocaleResolver(),
false, cachingEnabled );
}
public ResourceBundleMessageInterpolator(ResourceBundleLocator userResourceBundleLocator, boolean cachingEnabled) {
this( userResourceBundleLocator, null, Collections.emptySet(), Locale.getDefault(), new DefaultLocaleResolver(), false, cachingEnabled );
}
public ResourceBundleMessageInterpolator(ResourceBundleLocator userResourceBundleLocator,
boolean cachingEnabled,
ExpressionFactory expressionFactory) {
this( userResourceBundleLocator, null, Collections.emptySet(), Locale.getDefault(), new DefaultLocaleResolver(), false, cachingEnabled );
}
/**
* @since 6.1.1
*/
@Incubating
public ResourceBundleMessageInterpolator(Set locales, Locale defaultLocale, LocaleResolver localeResolver, boolean preloadResourceBundles) {
super( locales, defaultLocale, localeResolver, preloadResourceBundles );
this.expressionFactory = buildExpressionFactory();
}
/**
* @since 6.1.1
*/
@Incubating
public ResourceBundleMessageInterpolator(ResourceBundleLocator userResourceBundleLocator,
Set locales,
Locale defaultLocale,
LocaleResolver localeResolver,
boolean preloadResourceBundles) {
super( userResourceBundleLocator, locales, defaultLocale, localeResolver, preloadResourceBundles );
this.expressionFactory = buildExpressionFactory();
}
/**
* @since 6.1.1
*/
@Incubating
public ResourceBundleMessageInterpolator(ResourceBundleLocator userResourceBundleLocator,
ResourceBundleLocator contributorResourceBundleLocator,
Set locales,
Locale defaultLocale,
LocaleResolver localeResolver,
boolean preloadResourceBundles) {
super( userResourceBundleLocator, contributorResourceBundleLocator, locales, defaultLocale, localeResolver, preloadResourceBundles );
this.expressionFactory = buildExpressionFactory();
}
/**
* @since 6.1.1
*/
@Incubating
public ResourceBundleMessageInterpolator(ResourceBundleLocator userResourceBundleLocator,
ResourceBundleLocator contributorResourceBundleLocator,
Set locales,
Locale defaultLocale,
LocaleResolver localeResolver,
boolean preloadResourceBundles,
boolean cachingEnabled) {
super( userResourceBundleLocator, contributorResourceBundleLocator, locales, defaultLocale, localeResolver, preloadResourceBundles,
cachingEnabled );
this.expressionFactory = buildExpressionFactory();
}
/**
* @since 6.1.1
*/
@Incubating
public ResourceBundleMessageInterpolator(ResourceBundleLocator userResourceBundleLocator,
Set locales,
Locale defaultLocale,
LocaleResolver localeResolver,
boolean preloadResourceBundles,
boolean cachingEnabled) {
super( userResourceBundleLocator, null, locales, defaultLocale, localeResolver, preloadResourceBundles, cachingEnabled );
this.expressionFactory = buildExpressionFactory();
}
/**
* @since 6.1.1
*/
@Incubating
public ResourceBundleMessageInterpolator(ResourceBundleLocator userResourceBundleLocator,
Set locales,
Locale defaultLocale,
LocaleResolver localeResolver,
boolean preloadResourceBundles,
boolean cachingEnabled,
ExpressionFactory expressionFactory) {
super( userResourceBundleLocator, null, locales, defaultLocale, localeResolver, preloadResourceBundles, cachingEnabled );
this.expressionFactory = expressionFactory;
}
@Override
public String interpolate(Context context, Locale locale, String term) {
InterpolationTerm expression = new InterpolationTerm( term, locale, expressionFactory );
return expression.interpolate( context );
}
/**
* The jakarta.el FactoryFinder uses the TCCL to load the {@link ExpressionFactory} implementation so we need to be
* extra careful when initializing it.
*
* @return the {@link ExpressionFactory}
*/
private static ExpressionFactory buildExpressionFactory() {
// First, we try to load the instance from the original TCCL.
if ( canLoadExpressionFactory() ) {
ExpressionFactory expressionFactory = ELManager.getExpressionFactory();
LOG.debug( "Loaded expression factory via original TCCL" );
return expressionFactory;
}
final ClassLoader originalContextClassLoader = run( GetClassLoader.fromContext() );
try {
// Then we try the Hibernate Validator class loader. In a fully-functional modular environment such as
// WildFly or Jigsaw, it is the way to go.
run( SetContextClassLoader.action( ResourceBundleMessageInterpolator.class.getClassLoader() ) );
if ( canLoadExpressionFactory() ) {
ExpressionFactory expressionFactory = ELManager.getExpressionFactory();
LOG.debug( "Loaded expression factory via HV classloader" );
return expressionFactory;
}
// Finally we try the CL of the EL module itself; the EL RI uses the TCCL to load the implementation from
// its own module, so this should work
run( SetContextClassLoader.action( ELManager.class.getClassLoader() ) );
if ( canLoadExpressionFactory() ) {
ExpressionFactory expressionFactory = ELManager.getExpressionFactory();
LOG.debug( "Loaded expression factory via EL classloader" );
return expressionFactory;
}
}
catch (Throwable e) {
throw LOG.getUnableToInitializeELExpressionFactoryException( e );
}
finally {
run( SetContextClassLoader.action( originalContextClassLoader ) );
}
// HV-793 - We fail eagerly in case we have no EL dependencies on the classpath
throw LOG.getUnableToInitializeELExpressionFactoryException( null );
}
/**
* Instead of testing the different class loaders via {@link ELManager}, we directly access the
* {@link ExpressionFactory}. This avoids issues with loading the {@code ELUtil} class (used by {@code ELManager})
* after a failed attempt.
*/
private static boolean canLoadExpressionFactory() {
try {
ExpressionFactory.newInstance();
return true;
}
catch (Throwable e) {
LOG.debugv( e, "Failed to load expression factory via classloader {0}",
run( GetClassLoader.fromContext() ) );
return false;
}
}
/**
* Runs the given privileged action, using a privileged block if required.
*
* NOTE: This must never be changed into a publicly available method to avoid execution of arbitrary
* privileged actions within HV's protection domain.
*/
private static T run(PrivilegedAction action) {
return System.getSecurityManager() != null ? AccessController.doPrivileged( action ) : action.run();
}
}