HHH-10287 - Cache keys no longer include the entity type

Author: sebersole

hibernate-core/src/main/java/org/hibernate/boot/registry/selector/internal/StrategySelectorImpl.java

@@ -13,6 +13,7 @@
 
 import org.hibernate.boot.registry.classloading.spi.ClassLoaderService;
 import org.hibernate.boot.registry.classloading.spi.ClassLoadingException;
+import org.hibernate.boot.registry.selector.spi.StrategyCreator;
 import org.hibernate.boot.registry.selector.spi.StrategySelectionException;
 import org.hibernate.boot.registry.selector.spi.StrategySelector;
 
@@ -26,8 +27,20 @@
 public class StrategySelectorImpl implements StrategySelector {
 	private static final Logger log = Logger.getLogger( StrategySelectorImpl.class );
 
-	private final Map<Class,Map<String,Class>> namedStrategyImplementorByStrategyMap
-			= new ConcurrentHashMap<Class, Map<String, Class>>();
+
+	public static StrategyCreator STANDARD_STRATEGY_CREATOR = strategyClass -> {
+		try {
+			return strategyClass.newInstance();
+		}
+		catch (Exception e) {
+			throw new StrategySelectionException(
+					String.format( "Could not instantiate named strategy class [%s]", strategyClass.getName() ),
+					e
+			);
+		}
+	};
+
+	private final Map<Class,Map<String,Class>> namedStrategyImplementorByStrategyMap = new ConcurrentHashMap<>();
 
 	private final ClassLoaderService classLoaderService;
 
@@ -44,7 +57,7 @@ public StrategySelectorImpl(ClassLoaderService classLoaderService) {
 	public <T> void registerStrategyImplementor(Class<T> strategy, String name, Class<? extends T> implementation) {
 		Map<String,Class> namedStrategyImplementorMap = namedStrategyImplementorByStrategyMap.get( strategy );
 		if ( namedStrategyImplementorMap == null ) {
-			namedStrategyImplementorMap = new ConcurrentHashMap<String, Class>();
+			namedStrategyImplementorMap = new ConcurrentHashMap<>();
 			namedStrategyImplementorByStrategyMap.put( strategy, namedStrategyImplementorMap );
 		}
 
@@ -126,12 +139,7 @@ public <T> T resolveDefaultableStrategy(Class<T> strategy, Object strategyRefere
 		return resolveDefaultableStrategy(
 				strategy,
 				strategyReference,
-				new Callable<T>() {
-					@Override
-					public T call() {
-						return defaultValue;
-					}
-				}
+				(Callable<T>) () -> defaultValue
 		);
 	}
 
@@ -141,6 +149,30 @@ public <T> T resolveDefaultableStrategy(
 			Class<T> strategy,
 			Object strategyReference,
 			Callable<T> defaultResolver) {
+		return (T) resolveStrategy( strategy, strategyReference, defaultResolver, STANDARD_STRATEGY_CREATOR );
+	}
+
+	@Override
+	public <T> T resolveStrategy(
+			Class<T> strategy,
+			Object strategyReference,
+			T defaultValue,
+			StrategyCreator<T> creator) {
+		return resolveStrategy(
+				strategy,
+				strategyReference,
+				(Callable<T>) () -> defaultValue,
+				creator
+		);
+	}
+
+	@SuppressWarnings("unchecked")
+	@Override
+	public <T> T resolveStrategy(
+			Class<T> strategy,
+			Object strategyReference,
+			Callable<T> defaultResolver,
+			StrategyCreator<T> creator) {
 		if ( strategyReference == null ) {
 			try {
 				return defaultResolver.call();
@@ -163,7 +195,7 @@ public <T> T resolveDefaultableStrategy(
 		}
 
 		try {
-			return implementationClass.newInstance();
+			return creator.create( implementationClass );
 		}
 		catch (Exception e) {
 			throw new StrategySelectionException(

hibernate-core/src/main/java/org/hibernate/boot/registry/selector/spi/StrategyCreator.java

@@ -0,0 +1,14 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.boot.registry.selector.spi;
+
+/**
+ * @author Steve Ebersole
+ */
+public interface StrategyCreator<T> {
+	T create(Class<? extends T> strategyClass);
+}

hibernate-core/src/main/java/org/hibernate/boot/registry/selector/spi/StrategySelector.java

@@ -19,9 +19,9 @@
  * StrategySelector manages resolution of particular implementation by (possibly short) name via the
  * {@link #selectStrategyImplementor} method, which is the main contract here.  As indicated in the docs of that
  * method the given name might be either a short registered name or the implementation FQN.  As an example, consider
- * resolving the {@link org.hibernate.engine.transaction.spi.TransactionFactory} implementation to use.  To use the
- * JDBC-based TransactionFactory the passed name might be either {@code "jdbc"} or
- * {@code "org.hibernate.engine.transaction.internal.jdbc.JdbcTransactionFactory"} (which is the FQN).
+ * resolving the {@link org.hibernate.resource.transaction.spi.TransactionCoordinatorBuilder} implementation to use.  To use the
+ * JDBC-based TransactionCoordinatorBuilder the passed name might be either {@code "jdbc"} or
+ * {@code "org.hibernate.resource.transaction.backend.jdbc.internal.JdbcResourceLocalTransactionCoordinatorBuilderImpl"} (which is the FQN).
  * <p/>
  * Strategy implementations can be managed by {@link #registerStrategyImplementor} and
  * {@link #unRegisterStrategyImplementor}.  Originally designed to help the OSGi use case, though no longer used there.
@@ -135,4 +135,8 @@ public interface StrategySelector extends Service {
 	 * @return The strategy instance
 	 */
 	<T> T resolveDefaultableStrategy(Class<T> strategy, Object strategyReference, Callable<T> defaultResolver);
+
+	<T> T resolveStrategy(Class<T> strategy, Object strategyReference, Callable<T> defaultResolver, StrategyCreator<T> creator);
+
+	<T> T resolveStrategy(Class<T> strategy, Object strategyReference, T defaultValue, StrategyCreator<T> creator);
 }

hibernate-core/src/main/java/org/hibernate/boot/spi/SessionFactoryOptions.java

@@ -19,6 +19,7 @@
 import org.hibernate.boot.SchemaAutoTooling;
 import org.hibernate.boot.TempTableDdlTransactionHandling;
 import org.hibernate.boot.registry.StandardServiceRegistry;
+import org.hibernate.cache.spi.CacheKeysFactory;
 import org.hibernate.cache.spi.QueryCacheFactory;
 import org.hibernate.cfg.BaselineSessionEventsListenerBuilder;
 import org.hibernate.context.spi.CurrentTenantIdentifierResolver;

hibernate-core/src/main/java/org/hibernate/cache/internal/RegionFactoryInitiator.java

@@ -9,27 +9,24 @@
 import java.util.Map;
 import java.util.Properties;
 
-import org.hibernate.HibernateException;
 import org.hibernate.boot.registry.StandardServiceInitiator;
+import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
 import org.hibernate.boot.registry.selector.spi.StrategySelector;
 import org.hibernate.cache.spi.RegionFactory;
 import org.hibernate.cfg.AvailableSettings;
+import org.hibernate.internal.CoreLogging;
 import org.hibernate.internal.CoreMessageLogger;
 import org.hibernate.internal.util.config.ConfigurationHelper;
 import org.hibernate.service.spi.ServiceRegistryImplementor;
 
-import org.jboss.logging.Logger;
-
 /**
  * Initiator for the {@link RegionFactory} service.
  * 
  * @author Hardy Ferentschik
  * @author Brett Meyer
  */
 public class RegionFactoryInitiator implements StandardServiceInitiator<RegionFactory> {
-
-	private static final CoreMessageLogger LOG = Logger.getMessageLogger( CoreMessageLogger.class,
-			RegionFactoryInitiator.class.getName() );
+	private static final CoreMessageLogger LOG = CoreLogging.messageLogger( RegionFactoryInitiator.class );
 
 	/**
 	 * Singleton access
@@ -63,26 +60,16 @@ public RegionFactory initiateService(Map configurationValues, ServiceRegistryImp
 
 		// The cache provider is needed when we either have second-level cache enabled
 		// or query cache enabled.  Note that useSecondLevelCache is enabled by default
-		final String setting = ConfigurationHelper.getString( AvailableSettings.CACHE_REGION_FACTORY,
-				configurationValues, null );
-		if ( ( useSecondLevelCache || useQueryCache ) && setting != null ) {
-			try {
-				final Class<? extends RegionFactory> regionFactoryClass = registry.getService( StrategySelector.class )
-						.selectStrategyImplementor( RegionFactory.class, setting );
-				try {
-					regionFactory = regionFactoryClass.getConstructor( Properties.class ).newInstance( p );
-				}
-				catch ( NoSuchMethodException e ) {
-					// no constructor accepting Properties found, try no arg constructor
-					LOG.debugf(
-							"%s did not provide constructor accepting java.util.Properties; attempting no-arg constructor.",
-							regionFactoryClass.getSimpleName() );
-					regionFactory = regionFactoryClass.getConstructor().newInstance();
-				}
-			}
-			catch ( Exception e ) {
-				throw new HibernateException( "could not instantiate RegionFactory [" + setting + "]", e );
-			}
+		if ( useSecondLevelCache || useQueryCache ) {
+			final Object setting = configurationValues != null
+					? configurationValues.get( AvailableSettings.CACHE_REGION_FACTORY )
+					: null;
+			regionFactory = registry.getService( StrategySelector.class ).resolveStrategy(
+					RegionFactory.class,
+					setting,
+					NoCachingRegionFactory.INSTANCE,
+					new StrategyCreatorRegionFactoryImpl( p )
+			);
 		}
 
 		LOG.debugf( "Cache region factory : %s", regionFactory.getClass().getName() );

hibernate-core/src/main/java/org/hibernate/cache/internal/StrategyCreatorRegionFactoryImpl.java

@@ -0,0 +1,68 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.cache.internal;
+
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+import java.util.Map;
+import java.util.Properties;
+
+import org.hibernate.boot.registry.selector.spi.StrategyCreator;
+import org.hibernate.cache.spi.RegionFactory;
+import org.hibernate.service.spi.ServiceException;
+
+import org.jboss.logging.Logger;
+
+/**
+ * @author Steve Ebersole
+ */
+public class StrategyCreatorRegionFactoryImpl implements StrategyCreator<RegionFactory> {
+	private static final Logger log = Logger.getLogger( StrategyCreatorRegionFactoryImpl.class );
+
+	private final Properties properties;
+
+	public StrategyCreatorRegionFactoryImpl(Properties properties) {
+		this.properties = properties;
+	}
+
+	@Override
+	public RegionFactory create(Class<? extends RegionFactory> strategyClass) {
+		assert RegionFactory.class.isAssignableFrom( strategyClass );
+
+		// first look for a constructor accepting Properties
+		try {
+			final Constructor<? extends RegionFactory> ctor = strategyClass.getConstructor( Properties.class );
+			return ctor.newInstance( properties );
+		}
+		catch ( NoSuchMethodException e ) {
+			log.debugf( "RegionFactory impl [%s] did not provide constructor accepting Properties", strategyClass.getName() );
+		}
+		catch (IllegalAccessException | InstantiationException | InvocationTargetException e) {
+			throw new ServiceException( "Unable to call constructor of RegionFactory impl [" + strategyClass.getName() + "]", e );
+		}
+
+		// next try Map
+		try {
+			final Constructor<? extends RegionFactory> ctor = strategyClass.getConstructor( Map.class );
+			return ctor.newInstance( properties );
+		}
+		catch ( NoSuchMethodException e ) {
+			log.debugf( "RegionFactory impl [%s] did not provide constructor accepting Properties", strategyClass.getName() );
+		}
+		catch (IllegalAccessException | InstantiationException | InvocationTargetException e) {
+			throw new ServiceException( "Unable to call constructor of RegionFactory impl [" + strategyClass.getName() + "]", e );
+		}
+
+		// finally try no-arg
+		try {
+			return strategyClass.newInstance();
+		}
+		catch (IllegalAccessException | InstantiationException e) {
+			throw new ServiceException( "Unable to call constructor of RegionFactory impl [" + strategyClass.getName() + "]", e );
+		}
+	}
+}

hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java

@@ -891,14 +891,31 @@ public interface AvailableSettings {
 	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 	/**
-	 * The {@link org.hibernate.cache.spi.RegionFactory} implementation class
+	 * The {@link org.hibernate.cache.spi.RegionFactory} implementation.  Can refer to:<ul>
+	 *     <li>an Object implementing {@link org.hibernate.cache.spi.RegionFactory}</li>
+	 *     <li>a Class implementing {@link org.hibernate.cache.spi.RegionFactory}</li>
+	 *     <li>FQN of a Class implementing {@link org.hibernate.cache.spi.RegionFactory}</li>
+	 * </ul>
 	 */
 	String CACHE_REGION_FACTORY = "hibernate.cache.region.factory_class";
 
+	/**
+	 * Allow control to specify the {@link org.hibernate.cache.spi.CacheKeysFactory} impl to use.
+	 * Can refer to:<ul>
+	 *     <li>an Object implementing {@link org.hibernate.cache.spi.CacheKeysFactory}</li>
+	 *     <li>a Class implementing {@link org.hibernate.cache.spi.CacheKeysFactory}</li>
+	 *     <li>FQN of a Class implementing {@link org.hibernate.cache.spi.CacheKeysFactory}</li>
+	 * </ul>
+	 *
+	 * @since 5.2 - note that currently this is only honored for hibernate-infinispan
+	 */
+	String CACHE_KEYS_FACTORY = "hibernate.cache.keys_factory";
+
 	/**
 	 * The <tt>CacheProvider</tt> implementation class
 	 */
 	String CACHE_PROVIDER_CONFIG = "hibernate.cache.provider_configuration_file_resource_path";
+
 	/**
 	 * Enable the second-level cache (enabled by default)
 	 */
@@ -1474,5 +1491,4 @@ public interface AvailableSettings {
 	 * The default behavior is to allow access unless the session is bootstrapped via JPA.
 	 */
 	String ALLOW_JTA_TRANSACTION_ACCESS = "hibernate.jta.allowTransactionAccess";
-
 }