HHH-19743 Deprecate explicit use of JBossStandAloneJtaPlatform

Author: yrodiere

documentation/src/main/asciidoc/userguide/chapters/transactions/Transactions.adoc

@@ -77,7 +77,7 @@ If that resolution does not work, or if you wish to provide a custom implementat
 Hibernate provides many implementations of the `JtaPlatform` contract, all with short names:
 
 `JBossAS`:: `JtaPlatform` for Arjuna/JBossTransactions/Narayana when used within the JBoss/WildFly Application Server.
-`JBossTS`:: `JtaPlatform` for Arjuna/JBossTransactions/Narayana when used standalone.
+`JBossTS`:: **deprecated**, use `Narayana` or `WildFlyStandAlone` instead.
 `Atomikos`:: `JtaPlatform` for Atomikos.
 `GlassFish`, `Payara`:: `JtaPlatform` for GlassFish or Payara.
 `Resin`:: `JtaPlatform` for the Resin Application Server.

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

@@ -4,8 +4,10 @@
  */
 package org.hibernate.boot.registry.selector.internal;
 
+import java.util.List;
 import java.util.Objects;
 
+import org.hibernate.cfg.AvailableSettings;
 import org.hibernate.engine.transaction.jta.platform.internal.AtomikosJtaPlatform;
 import org.hibernate.engine.transaction.jta.platform.internal.JBossAppServerJtaPlatform;
 import org.hibernate.engine.transaction.jta.platform.internal.JBossStandAloneJtaPlatform;
@@ -16,6 +18,7 @@
 import org.hibernate.engine.transaction.jta.platform.internal.WeblogicJtaPlatform;
 import org.hibernate.engine.transaction.jta.platform.internal.WildFlyStandAloneJtaPlatform;
 import org.hibernate.engine.transaction.jta.platform.spi.JtaPlatform;
+import org.hibernate.internal.log.DeprecationLogger;
 
 public class DefaultJtaPlatformSelector implements LazyServiceResolver<JtaPlatform> {
 
@@ -31,7 +34,11 @@ else if ( name.startsWith( "org." ) ) {
 		else {
 			return switch ( name ) {
 				case "JBossAS" -> JBossAppServerJtaPlatform.class;
-				case "JBossTS" -> JBossStandAloneJtaPlatform.class;
+				case "JBossTS" -> {
+					DeprecationLogger.DEPRECATION_LOGGER.logDeprecatedJtaPlatformSetting(
+							AvailableSettings.JTA_PLATFORM, name, List.of( "Narayana", "WildFlyStandadlone" ) );
+					yield JBossStandAloneJtaPlatform.class;
+				}
 				case "Weblogic" -> WeblogicJtaPlatform.class;
 				case "WebSphere", "WebSphereLiberty" -> WebSphereLibertyJtaPlatform.class;
 				case "Atomikos" -> AtomikosJtaPlatform.class;
@@ -59,6 +66,8 @@ private static Class<? extends JtaPlatform> legacy(
 				return JBossAppServerJtaPlatform.class;
 			}
 			case "org.hibernate.service.jta.platform.internal.JBossStandAloneJtaPlatform" -> {
+				DeprecationLogger.DEPRECATION_LOGGER.logDeprecatedJtaPlatformSetting(
+						AvailableSettings.JTA_PLATFORM, name, List.of( "Narayana", "WildFlyStandadlone" ) );
 				return JBossStandAloneJtaPlatform.class;
 			}
 			case "org.hibernate.engine.transaction.jta.platform.internal.NarayanaJtaPlatform" -> {

hibernate-core/src/main/java/org/hibernate/engine/transaction/jta/platform/internal/JBossStandAloneJtaPlatform.java

@@ -16,7 +16,9 @@
  *
  * @author Emmanuel Bernard
  * @author Steve Ebersole
+ * @deprecated Use {@link WildFlyStandAloneJtaPlatform} or {@link NarayanaJtaPlatform} instead.
  */
+@Deprecated
 public class JBossStandAloneJtaPlatform extends AbstractJtaPlatform {
 
 	public static final String JBOSS_TM_CLASS_NAME = "com.arjuna.ats.jta.TransactionManager";

hibernate-core/src/main/java/org/hibernate/internal/log/DeprecationLogger.java

@@ -6,6 +6,7 @@
 
 import java.lang.annotation.Annotation;
 import java.lang.invoke.MethodHandles;
+import java.util.List;
 
 import org.hibernate.Internal;
 import org.hibernate.boot.jaxb.SourceType;
@@ -226,4 +227,11 @@ void recognizedObsoleteHibernateNamespace(
 			value = "Encountered deprecated hint [%s], use [%s] instead"
 	)
 	void deprecatedHint(String deprecatedHint, String replacementHint);
+
+	@LogMessage(level = WARN)
+	@Message(
+			id = 90000038,
+			value = "Encountered deprecated value for JtaPlatform setting [%s]: [%s]; use a non-deprecated value among %s instead"
+	)
+	void logDeprecatedJtaPlatformSetting(String settingName, String deprecatedValue, List<String> replacements);
 }