From 350d3301592a7f7c39b26f2e80a76c509c2a9c07 Mon Sep 17 00:00:00 2001
From: Steve Ebersole <steve@hibernate.org>
Date: Fri, 4 May 2018 11:22:21 -0500
Subject: [PATCH] HHH-12544 - Add jipijapa hook to plug in specialized caching
 and transaction services

---
 .../internal/RegionFactoryInitiator.java      | 10 +++++++
 .../internal/JtaPlatformInitiator.java        | 16 ++++++++++--
 .../service/spi/ServiceContributor.java       |  3 +++
 .../service/CustomJtaPlatformInitiator.java   | 26 +++++++++++++++++++
 .../service/CustomRegionFactoryInitiator.java | 24 +++++++++++++++++
 .../service/ServiceContributorImpl.java       | 23 ++++++++++++++++
 ...g.hibernate.service.spi.ServiceContributor |  7 +++++
 7 files changed, 107 insertions(+), 2 deletions(-)
 create mode 100644 hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/CustomJtaPlatformInitiator.java
 create mode 100644 hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/CustomRegionFactoryInitiator.java
 create mode 100644 hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/ServiceContributorImpl.java
 create mode 100644 hibernate-jipijapa/src/main/resources/META-INF/services/org.hibernate.service.spi.ServiceContributor

diff --git a/hibernate-core/src/main/java/org/hibernate/cache/internal/RegionFactoryInitiator.java b/hibernate-core/src/main/java/org/hibernate/cache/internal/RegionFactoryInitiator.java
index 9a437b7769..d2261b7330 100644
--- a/hibernate-core/src/main/java/org/hibernate/cache/internal/RegionFactoryInitiator.java
+++ b/hibernate-core/src/main/java/org/hibernate/cache/internal/RegionFactoryInitiator.java
@@ -102,6 +102,11 @@ public class RegionFactoryInitiator implements StandardServiceInitiator<RegionFa
 		}
 
 
+		final RegionFactory fallback = getFallback( configurationValues, registry );
+		if ( fallback != null ) {
+			return fallback;
+		}
+
 		if ( implementors.size() == 1 ) {
 			final RegionFactory registeredFactory = selector.resolveStrategy( RegionFactory.class, implementors.iterator().next() );
 			configurationValues.put( AvailableSettings.CACHE_REGION_FACTORY, registeredFactory );
@@ -118,4 +123,9 @@ public class RegionFactoryInitiator implements StandardServiceInitiator<RegionFa
 
 		return NoCachingRegionFactory.INSTANCE;
 	}
+
+	@SuppressWarnings({"WeakerAccess", "unused"})
+	protected RegionFactory getFallback(Map configurationValues, ServiceRegistryImplementor registry) {
+		return null;
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/transaction/jta/platform/internal/JtaPlatformInitiator.java b/hibernate-core/src/main/java/org/hibernate/engine/transaction/jta/platform/internal/JtaPlatformInitiator.java
index 56e81d68f3..f570c88861 100644
--- a/hibernate-core/src/main/java/org/hibernate/engine/transaction/jta/platform/internal/JtaPlatformInitiator.java
+++ b/hibernate-core/src/main/java/org/hibernate/engine/transaction/jta/platform/internal/JtaPlatformInitiator.java
@@ -37,11 +37,23 @@ public class JtaPlatformInitiator implements StandardServiceInitiator<JtaPlatfor
 	@SuppressWarnings( {"unchecked"})
 	public JtaPlatform initiateService(Map configurationValues, ServiceRegistryImplementor registry) {
 		final Object setting = configurationValues.get( AvailableSettings.JTA_PLATFORM );
-		final JtaPlatform platform = registry.getService( StrategySelector.class ).resolveStrategy( JtaPlatform.class, setting );
+		JtaPlatform platform = registry.getService( StrategySelector.class ).resolveStrategy( JtaPlatform.class, setting );
+
 		if ( platform == null ) {
 			LOG.debugf( "No JtaPlatform was specified, checking resolver" );
-			return registry.getService( JtaPlatformResolver.class ).resolveJtaPlatform( configurationValues, registry );
+			platform = registry.getService( JtaPlatformResolver.class ).resolveJtaPlatform( configurationValues, registry );
 		}
+
+		if ( platform == null ) {
+			LOG.debugf( "No JtaPlatform was specified, checking resolver" );
+			platform = getFallbackProvider( configurationValues, registry );
+		}
+
 		return platform;
 	}
+
+	@SuppressWarnings({"WeakerAccess", "unused"})
+	protected JtaPlatform getFallbackProvider(Map configurationValues, ServiceRegistryImplementor registry) {
+		return null;
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/service/spi/ServiceContributor.java b/hibernate-core/src/main/java/org/hibernate/service/spi/ServiceContributor.java
index c86ef70a8e..fd0fe4aa79 100644
--- a/hibernate-core/src/main/java/org/hibernate/service/spi/ServiceContributor.java
+++ b/hibernate-core/src/main/java/org/hibernate/service/spi/ServiceContributor.java
@@ -11,6 +11,9 @@ import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
 /**
  * Contract for contributing services.
  *
+ * @implSpec Implementations can be auto-discovered via Java's {@link java.util.ServiceLoader}
+ * mechanism.
+ *
  * @author Steve Ebersole
  */
 public interface ServiceContributor {
diff --git a/hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/CustomJtaPlatformInitiator.java b/hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/CustomJtaPlatformInitiator.java
new file mode 100644
index 0000000000..9911d946ac
--- /dev/null
+++ b/hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/CustomJtaPlatformInitiator.java
@@ -0,0 +1,26 @@
+/*
+ * 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.jboss.as.jpa.hibernate5.service;
+
+import java.util.Map;
+
+import org.hibernate.engine.transaction.jta.platform.internal.JtaPlatformInitiator;
+import org.hibernate.engine.transaction.jta.platform.spi.JtaPlatform;
+import org.hibernate.service.spi.ServiceRegistryImplementor;
+
+/**
+ * Custom JtaPlatform initiator for use inside WildFly picking an appropriate
+ * fallback JtaPlatform.
+ *
+ * @author Steve Ebersole
+ */
+public class CustomJtaPlatformInitiator extends JtaPlatformInitiator {
+	@Override
+	protected JtaPlatform getFallbackProvider(Map configurationValues, ServiceRegistryImplementor registry) {
+		return new org.hibernate.engine.transaction.jta.platform.internal.JBossAppServerJtaPlatform();
+	}
+}
diff --git a/hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/CustomRegionFactoryInitiator.java b/hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/CustomRegionFactoryInitiator.java
new file mode 100644
index 0000000000..3a3d68909d
--- /dev/null
+++ b/hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/CustomRegionFactoryInitiator.java
@@ -0,0 +1,24 @@
+/*
+ * 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.jboss.as.jpa.hibernate5.service;
+
+import java.util.Map;
+
+import org.hibernate.cache.internal.NoCachingRegionFactory;
+import org.hibernate.cache.internal.RegionFactoryInitiator;
+import org.hibernate.cache.spi.RegionFactory;
+import org.hibernate.service.spi.ServiceRegistryImplementor;
+
+/**
+ * @author Steve Ebersole
+ */
+public class CustomRegionFactoryInitiator extends RegionFactoryInitiator {
+	@Override
+	protected RegionFactory getFallback(Map configurationValues, ServiceRegistryImplementor registry) {
+		return NoCachingRegionFactory.INSTANCE;
+	}
+}
diff --git a/hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/ServiceContributorImpl.java b/hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/ServiceContributorImpl.java
new file mode 100644
index 0000000000..8084a619d4
--- /dev/null
+++ b/hibernate-jipijapa/src/main/java/org/jboss/as/jpa/hibernate5/service/ServiceContributorImpl.java
@@ -0,0 +1,23 @@
+/*
+ * 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.jboss.as.jpa.hibernate5.service;
+
+import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
+import org.hibernate.service.spi.ServiceContributor;
+
+/**
+ * Contribute specialized Hibernate Service impls
+ *
+ * @author Steve Ebersole
+ */
+public class ServiceContributorImpl implements ServiceContributor {
+	@Override
+	public void contribute(StandardServiceRegistryBuilder serviceRegistryBuilder) {
+		serviceRegistryBuilder.addInitiator( new CustomJtaPlatformInitiator() );
+		serviceRegistryBuilder.addInitiator( new CustomRegionFactoryInitiator() );
+	}
+}
diff --git a/hibernate-jipijapa/src/main/resources/META-INF/services/org.hibernate.service.spi.ServiceContributor b/hibernate-jipijapa/src/main/resources/META-INF/services/org.hibernate.service.spi.ServiceContributor
new file mode 100644
index 0000000000..8d3e4cfc62
--- /dev/null
+++ b/hibernate-jipijapa/src/main/resources/META-INF/services/org.hibernate.service.spi.ServiceContributor
@@ -0,0 +1,7 @@
+#
+# 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
+
+org.jboss.as.jpa.hibernate5.service.ServiceContributorImpl
\ No newline at end of file