Made it possible to change hazelcast instance factory. Fixes #21. (#25)

* Made it possible to change hazelcast instance factory. Fixes #21. This is better because many third-party db libraries assume that properties in Properties are Strings, not objects.
hazelcast · Apr 10, 2017 · b57a0d5 · b57a0d5
1 parent 5d9da9b
commit b57a0d5
Show file tree

Hide file tree

Showing 7 changed files with 83 additions and 20 deletions.
diff --git a/...hibernate5/src/main/java/com/hazelcast/hibernate/AbstractHazelcastCacheRegionFactory.java b/...hibernate5/src/main/java/com/hazelcast/hibernate/AbstractHazelcastCacheRegionFactory.java
@@ -17,7 +17,8 @@
 package com.hazelcast.hibernate;
 
 import com.hazelcast.core.HazelcastInstance;
-import com.hazelcast.hibernate.instance.HazelcastInstanceFactory;
+import com.hazelcast.hibernate.instance.DefaultHazelcastInstanceFactory;
+import com.hazelcast.hibernate.instance.IHazelcastInstanceFactory;
 import com.hazelcast.hibernate.instance.IHazelcastInstanceLoader;
 import com.hazelcast.hibernate.local.CleanupService;
 import com.hazelcast.hibernate.region.HazelcastQueryResultsRegion;
@@ -79,7 +80,20 @@ public long nextTimestamp() {
     public void start(final SessionFactoryOptions options, final Properties properties) throws CacheException {
         log.info("Starting up " + getClass().getSimpleName());
         if (instance == null || !instance.getLifecycleService().isRunning()) {
-            instanceLoader = HazelcastInstanceFactory.createInstanceLoader(properties);
+            String defaultFactory = DefaultHazelcastInstanceFactory.class.getName();
+            String factoryName = properties.getProperty(CacheEnvironment.HAZELCAST_FACTORY, defaultFactory);
+            ClassLoader cl = Thread.currentThread().getContextClassLoader();
+            try {
+                Class<IHazelcastInstanceFactory> factory =
+                        (Class<IHazelcastInstanceFactory>) Class.forName(factoryName, true, cl);
+                instanceLoader = factory.newInstance().createInstanceLoader(properties);
+            } catch (ClassNotFoundException e) {
+                throw new CacheException("Failed to set up hazelcast instance factory", e);
+            } catch (InstantiationException e) {
+                throw new CacheException("Failed to set up hazelcast instance factory", e);
+            } catch (IllegalAccessException e) {
+                throw new CacheException("Failed to set up hazelcast instance factory", e);
+            }
             instance = instanceLoader.loadInstance();
         }
         cleanupService = new CleanupService(instance.getName());

diff --git a/hazelcast-hibernate5/src/main/java/com/hazelcast/hibernate/CacheEnvironment.java b/hazelcast-hibernate5/src/main/java/com/hazelcast/hibernate/CacheEnvironment.java
@@ -96,6 +96,13 @@ public final class CacheEnvironment {
      */
     public static final String HAZELCAST_SHUTDOWN_HOOK_ENABLED = "hazelcast.shutdownhook.enabled";
 
+    /**
+     * Property to configure which {@link com.hazelcast.hibernate.instance.IHazelcastInstanceFactory}
+     * that shall be used for creating
+     * {@link com.hazelcast.hibernate.instance.IHazelcastInstanceLoader hazelcast instance loaders}.
+     */
+    public static final String HAZELCAST_FACTORY = "hibernate.cache.hazelcast.factory";
+
     // milliseconds
     private static final int MAXIMUM_LOCK_TIMEOUT = 10000;
 

diff --git a/...te/instance/HazelcastInstanceFactory.java → ...ance/DefaultHazelcastInstanceFactory.java b/...te/instance/HazelcastInstanceFactory.java → ...ance/DefaultHazelcastInstanceFactory.java
@@ -22,27 +22,18 @@
 import java.util.Properties;
 
 /**
- * A factory class to build up implementations of {@link com.hazelcast.hibernate.instance.IHazelcastInstanceLoader}
- * that returns a {@link com.hazelcast.core.HazelcastInstance} depending on configuration either backed by Hazelcast
+ * A factory that returns a {@link com.hazelcast.core.HazelcastInstance} depending on configuration either backed by Hazelcast
  * client or node implementation.
  */
-public final class HazelcastInstanceFactory {
-
+public final class DefaultHazelcastInstanceFactory implements IHazelcastInstanceFactory
+{
     private static final String HZ_CLIENT_LOADER_CLASSNAME = "com.hazelcast.hibernate.instance.HazelcastClientLoader";
     private static final String HZ_INSTANCE_LOADER_CLASSNAME = "com.hazelcast.hibernate.instance.HazelcastInstanceLoader";
 
-    private HazelcastInstanceFactory() {
-    }
-
-    public static IHazelcastInstanceLoader createInstanceLoader(final Properties props) throws CacheException {
+    public IHazelcastInstanceLoader createInstanceLoader(final Properties props) throws CacheException {
         try {
-            IHazelcastInstanceLoader instanceLoader = (IHazelcastInstanceLoader) props.
-                    get("com.hazelcast.hibernate.instance.loader");
-            if (instanceLoader != null) {
-                return instanceLoader;
-            }
             Class loaderClass = getInstanceLoaderClass(props);
-            instanceLoader = (IHazelcastInstanceLoader) loaderClass.newInstance();
+            IHazelcastInstanceLoader instanceLoader = (IHazelcastInstanceLoader) loaderClass.newInstance();
             instanceLoader.configure(props);
             return instanceLoader;
         } catch (Exception e) {
@@ -51,7 +42,7 @@ public static IHazelcastInstanceLoader createInstanceLoader(final Properties pro
     }
 
     private static Class getInstanceLoaderClass(final Properties props) throws ClassNotFoundException {
-        ClassLoader cl = HazelcastInstanceFactory.class.getClassLoader();
+        ClassLoader cl = DefaultHazelcastInstanceFactory.class.getClassLoader();
         if (props != null && CacheEnvironment.isNativeClient(props)) {
             return cl.loadClass(HZ_CLIENT_LOADER_CLASSNAME);
         } else {

diff --git a/...st-hibernate5/src/main/java/com/hazelcast/hibernate/instance/HazelcastInstanceLoader.java b/...st-hibernate5/src/main/java/com/hazelcast/hibernate/instance/HazelcastInstanceLoader.java
@@ -36,7 +36,7 @@
  */
 class HazelcastInstanceLoader implements IHazelcastInstanceLoader {
 
-    private static final ILogger LOGGER = Logger.getLogger(HazelcastInstanceFactory.class);
+    private static final ILogger LOGGER = Logger.getLogger(IHazelcastInstanceFactory.class);
 
     private HazelcastInstance instance;
     private Config config;

diff --git a/...-hibernate5/src/main/java/com/hazelcast/hibernate/instance/IHazelcastInstanceFactory.java b/...-hibernate5/src/main/java/com/hazelcast/hibernate/instance/IHazelcastInstanceFactory.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2008-2016, Hazelcast, Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.hazelcast.hibernate.instance;
+
+import org.hibernate.cache.CacheException;
+
+import java.util.Properties;
+
+/**
+ * A hookable factory class to build up implementations of {@link com.hazelcast.hibernate.instance.IHazelcastInstanceLoader}
+ */
+public interface IHazelcastInstanceFactory {
+    IHazelcastInstanceLoader createInstanceLoader(final Properties props) throws CacheException;
+}
diff --git a/hazelcast-hibernate5/src/test/java/com/hazelcast/hibernate/HibernateTestSupport.java b/hazelcast-hibernate5/src/test/java/com/hazelcast/hibernate/HibernateTestSupport.java
@@ -20,6 +20,7 @@
 import com.hazelcast.core.HazelcastInstance;
 import com.hazelcast.hibernate.entity.AnnotatedEntity;
 import com.hazelcast.hibernate.instance.HazelcastAccessor;
+import com.hazelcast.hibernate.instance.HazelcastMockInstanceFactory;
 import com.hazelcast.hibernate.instance.IHazelcastInstanceLoader;
 import com.hazelcast.logging.ILogger;
 import com.hazelcast.logging.Logger;
@@ -76,10 +77,11 @@ protected SessionFactory createSessionFactory(final Properties props,
                                                   final IHazelcastInstanceLoader customInstanceLoader) {
         props.put(CacheEnvironment.EXPLICIT_VERSION_CHECK, "true");
         if (customInstanceLoader != null) {
-            props.put("com.hazelcast.hibernate.instance.loader", customInstanceLoader);
+            HazelcastMockInstanceFactory.setThreadLocalLoader(customInstanceLoader);
+            props.setProperty("hibernate.cache.hazelcast.factory", "com.hazelcast.hibernate.instance.HazelcastMockInstanceFactory");
             customInstanceLoader.configure(props);
         } else {
-            props.remove("com.hazelcast.hibernate.instance.loader");
+            props.remove("hibernate.cache.hazelcast.factory");
         }
 
         final Configuration conf = new Configuration();

diff --git a/...bernate5/src/test/java/com/hazelcast/hibernate/instance/HazelcastMockInstanceFactory.java b/...bernate5/src/test/java/com/hazelcast/hibernate/instance/HazelcastMockInstanceFactory.java
@@ -0,0 +1,21 @@
+package com.hazelcast.hibernate.instance;
+
+import org.hibernate.cache.CacheException;
+
+import java.util.Properties;
+
+public class HazelcastMockInstanceFactory implements IHazelcastInstanceFactory
+{
+	private static ThreadLocal<IHazelcastInstanceLoader> loaders = new ThreadLocal<IHazelcastInstanceLoader>();
+
+	public static void setThreadLocalLoader(IHazelcastInstanceLoader loader)
+	{
+		loaders.set(loader);
+	}
+
+	@Override
+	public IHazelcastInstanceLoader createInstanceLoader(Properties props) throws CacheException
+	{
+		return loaders.get();
+	}
+}