Revise PersistenceUnitInfo management for compatibility with JPA 3.2/4.0

Closes gh-35622

Author: jhoeller

spring-orm/src/main/java/org/springframework/orm/jpa/ExtendedEntityManagerCreator.java

@@ -30,14 +30,14 @@
 import jakarta.persistence.EntityTransaction;
 import jakarta.persistence.TransactionRequiredException;
 import jakarta.persistence.spi.PersistenceUnitInfo;
-import jakarta.persistence.spi.PersistenceUnitTransactionType;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.jspecify.annotations.Nullable;
 
 import org.springframework.core.Ordered;
 import org.springframework.dao.DataAccessException;
 import org.springframework.dao.support.PersistenceExceptionTranslator;
+import org.springframework.orm.jpa.persistenceunit.SmartPersistenceUnitInfo;
 import org.springframework.transaction.support.ResourceHolderSynchronization;
 import org.springframework.transaction.support.TransactionSynchronizationManager;
 import org.springframework.util.Assert;
@@ -192,14 +192,13 @@ public static EntityManager createContainerManagedEntityManager(
 	 * transactions (according to the JPA 2.1 SynchronizationType rules)
 	 * @return the EntityManager proxy
 	 */
-	@SuppressWarnings("removal")
 	private static EntityManager createProxy(EntityManager rawEntityManager,
 			EntityManagerFactoryInfo emfInfo, boolean containerManaged, boolean synchronizedWithTransaction) {
 
 		Assert.notNull(emfInfo, "EntityManagerFactoryInfo must not be null");
 		JpaDialect jpaDialect = emfInfo.getJpaDialect();
 		PersistenceUnitInfo pui = emfInfo.getPersistenceUnitInfo();
-		Boolean jta = (pui != null ? pui.getTransactionType() == PersistenceUnitTransactionType.JTA : null);
+		Boolean jta = (pui instanceof SmartPersistenceUnitInfo spui ? spui.isConfiguredForJta() : null);
 		return createProxy(rawEntityManager, emfInfo.getEntityManagerInterface(),
 				emfInfo.getBeanClassLoader(), jpaDialect, jta, containerManaged, synchronizedWithTransaction);
 	}

spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/DefaultPersistenceUnitManager.java

@@ -134,7 +134,7 @@ public class DefaultPersistenceUnitManager
 
 	private final Set<String> persistenceUnitInfoNames = new HashSet<>();
 
-	private final Map<String, PersistenceUnitInfo> persistenceUnitInfos = new HashMap<>();
+	private final Map<String, SpringPersistenceUnitInfo> persistenceUnitInfos = new HashMap<>();
 
 
 	/**
@@ -620,26 +620,25 @@ private void applyManagedTypes(SpringPersistenceUnitInfo scannedUnit, Persistenc
 
 
 	/**
-	 * Return the specified PersistenceUnitInfo from this manager's cache
-	 * of processed persistence units, keeping it in the cache (i.e. not
-	 * 'obtaining' it for use but rather just accessing it for post-processing).
+	 * Return the specified {@link MutablePersistenceUnitInfo} from this manager's cache
+	 * of processed persistence units, keeping it in the cache (i.e. not 'obtaining' it
+	 * for use but rather just accessing it for post-processing).
 	 * <p>This can be used in {@link #postProcessPersistenceUnitInfo} implementations,
 	 * detecting existing persistence units of the same name and potentially merging them.
 	 * @param persistenceUnitName the name of the desired persistence unit
 	 * @return the PersistenceUnitInfo in mutable form, or {@code null} if not available
 	 */
 	protected final @Nullable MutablePersistenceUnitInfo getPersistenceUnitInfo(String persistenceUnitName) {
-		PersistenceUnitInfo pui = this.persistenceUnitInfos.get(persistenceUnitName);
-		return (MutablePersistenceUnitInfo) pui;
+		return this.persistenceUnitInfos.get(persistenceUnitName);
 	}
 
 	/**
-	 * Hook method allowing subclasses to customize each PersistenceUnitInfo.
+	 * Hook method allowing subclasses to customize each {@link MutablePersistenceUnitInfo}.
 	 * <p>The default implementation delegates to all registered PersistenceUnitPostProcessors.
 	 * It is usually preferable to register further entity classes, jar files etc there
 	 * rather than in a subclass of this manager, to be able to reuse the post-processors.
-	 * @param pui the chosen PersistenceUnitInfo, as read from {@code persistence.xml}.
-	 * Passed in as MutablePersistenceUnitInfo.
+	 * @param pui the chosen persistence unit configuration, as read from
+	 * {@code persistence.xml}. Passed in as MutablePersistenceUnitInfo.
 	 * @see #setPersistenceUnitPostProcessors
 	 */
 	protected void postProcessPersistenceUnitInfo(MutablePersistenceUnitInfo pui) {
@@ -674,14 +673,14 @@ public PersistenceUnitInfo obtainDefaultPersistenceUnitInfo() {
 		if (this.persistenceUnitInfos.size() > 1 && this.defaultPersistenceUnitName != null) {
 			return obtainPersistenceUnitInfo(this.defaultPersistenceUnitName);
 		}
-		PersistenceUnitInfo pui = this.persistenceUnitInfos.values().iterator().next();
+		SpringPersistenceUnitInfo pui = this.persistenceUnitInfos.values().iterator().next();
 		this.persistenceUnitInfos.clear();
-		return pui;
+		return pui.toSmartPersistenceUnitInfo();
 	}
 
 	@Override
 	public PersistenceUnitInfo obtainPersistenceUnitInfo(String persistenceUnitName) {
-		PersistenceUnitInfo pui = this.persistenceUnitInfos.remove(persistenceUnitName);
+		SpringPersistenceUnitInfo pui = this.persistenceUnitInfos.remove(persistenceUnitName);
 		if (pui == null) {
 			if (!this.persistenceUnitInfoNames.contains(persistenceUnitName)) {
 				throw new IllegalArgumentException(
@@ -692,7 +691,7 @@ public PersistenceUnitInfo obtainPersistenceUnitInfo(String persistenceUnitName)
 						"Persistence unit with name '" + persistenceUnitName + "' already obtained");
 			}
 		}
-		return pui;
+		return pui.toSmartPersistenceUnitInfo();
 	}
 
 }

spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/MutablePersistenceUnitInfo.java

@@ -23,30 +23,31 @@
 
 import javax.sql.DataSource;
 
+import jakarta.persistence.PersistenceUnitTransactionType;
 import jakarta.persistence.SharedCacheMode;
 import jakarta.persistence.ValidationMode;
-import jakarta.persistence.spi.ClassTransformer;
-import jakarta.persistence.spi.PersistenceUnitTransactionType;
 import org.jspecify.annotations.Nullable;
 
 import org.springframework.util.Assert;
-import org.springframework.util.ClassUtils;
 
 /**
- * Spring's base implementation of the JPA
+ * Spring's mutable equivalent of the JPA
  * {@link jakarta.persistence.spi.PersistenceUnitInfo} interface,
  * used to bootstrap an {@code EntityManagerFactory} in a container.
  *
  * <p>This implementation is largely a JavaBean, offering mutators
  * for all standard {@code PersistenceUnitInfo} properties.
+ * As of 7.0, it does <i>not</i> implement {@code PersistenceUnitInfo} but
+ * rather serves as the state behind a runtime {@code PersistenceUnitInfo}
+ * (for achieving compatibility between JPA 3.2 and 4.0 and for preventing
+ * late mutation attempts through {@code PersistenceUnitInfo} downcasts).
  *
  * @author Rod Johnson
  * @author Juergen Hoeller
  * @author Costin Leau
  * @since 2.0
  */
-@SuppressWarnings("removal")
-public class MutablePersistenceUnitInfo implements SmartPersistenceUnitInfo {
+public class MutablePersistenceUnitInfo {
 
 	private @Nullable String persistenceUnitName;
 
@@ -89,7 +90,6 @@ public void setPersistenceUnitName(@Nullable String persistenceUnitName) {
 		this.persistenceUnitName = persistenceUnitName;
 	}
 
-	@Override
 	public @Nullable String getPersistenceUnitName() {
 		return this.persistenceUnitName;
 	}
@@ -98,7 +98,6 @@ public void setPersistenceProviderClassName(@Nullable String persistenceProvider
 		this.persistenceProviderClassName = persistenceProviderClassName;
 	}
 
-	@Override
 	public @Nullable String getPersistenceProviderClassName() {
 		return this.persistenceProviderClassName;
 	}
@@ -107,7 +106,6 @@ public void setScopeAnnotationName(@Nullable String scopeAnnotationName) {
 		this.scopeAnnotationName = scopeAnnotationName;
 	}
 
-	@Override
 	public @Nullable String getScopeAnnotationName() {
 		return this.scopeAnnotationName;
 	}
@@ -116,7 +114,6 @@ public void addQualifierAnnotationName(String qualifierAnnotationName) {
 		this.qualifierAnnotationNames.add(qualifierAnnotationName);
 	}
 
-	@Override
 	public List<String> getQualifierAnnotationNames() {
 		return this.qualifierAnnotationNames;
 	}
@@ -125,7 +122,6 @@ public void setTransactionType(PersistenceUnitTransactionType transactionType) {
 		this.transactionType = transactionType;
 	}
 
-	@Override
 	public PersistenceUnitTransactionType getTransactionType() {
 		if (this.transactionType != null) {
 			return this.transactionType;
@@ -140,7 +136,6 @@ public void setJtaDataSource(@Nullable DataSource jtaDataSource) {
 		this.jtaDataSource = jtaDataSource;
 	}
 
-	@Override
 	public @Nullable DataSource getJtaDataSource() {
 		return this.jtaDataSource;
 	}
@@ -149,7 +144,6 @@ public void setNonJtaDataSource(@Nullable DataSource nonJtaDataSource) {
 		this.nonJtaDataSource = nonJtaDataSource;
 	}
 
-	@Override
 	public @Nullable DataSource getNonJtaDataSource() {
 		return this.nonJtaDataSource;
 	}
@@ -158,7 +152,6 @@ public void addMappingFileName(String mappingFileName) {
 		this.mappingFileNames.add(mappingFileName);
 	}
 
-	@Override
 	public List<String> getMappingFileNames() {
 		return this.mappingFileNames;
 	}
@@ -167,7 +160,6 @@ public void addJarFileUrl(URL jarFileUrl) {
 		this.jarFileUrls.add(jarFileUrl);
 	}
 
-	@Override
 	public List<URL> getJarFileUrls() {
 		return this.jarFileUrls;
 	}
@@ -176,7 +168,6 @@ public void setPersistenceUnitRootUrl(@Nullable URL persistenceUnitRootUrl) {
 		this.persistenceUnitRootUrl = persistenceUnitRootUrl;
 	}
 
-	@Override
 	public @Nullable URL getPersistenceUnitRootUrl() {
 		return this.persistenceUnitRootUrl;
 	}
@@ -190,7 +181,6 @@ public void addManagedClassName(String managedClassName) {
 		this.managedClassNames.add(managedClassName);
 	}
 
-	@Override
 	public List<String> getManagedClassNames() {
 		return this.managedClassNames;
 	}
@@ -208,7 +198,6 @@ public void addManagedPackage(String packageName) {
 		this.managedPackages.add(packageName);
 	}
 
-	@Override
 	public List<String> getManagedPackages() {
 		return this.managedPackages;
 	}
@@ -217,7 +206,6 @@ public void setExcludeUnlistedClasses(boolean excludeUnlistedClasses) {
 		this.excludeUnlistedClasses = excludeUnlistedClasses;
 	}
 
-	@Override
 	public boolean excludeUnlistedClasses() {
 		return this.excludeUnlistedClasses;
 	}
@@ -226,7 +214,6 @@ public void setSharedCacheMode(SharedCacheMode sharedCacheMode) {
 		this.sharedCacheMode = sharedCacheMode;
 	}
 
-	@Override
 	public SharedCacheMode getSharedCacheMode() {
 		return this.sharedCacheMode;
 	}
@@ -235,7 +222,6 @@ public void setValidationMode(ValidationMode validationMode) {
 		this.validationMode = validationMode;
 	}
 
-	@Override
 	public ValidationMode getValidationMode() {
 		return this.validationMode;
 	}
@@ -249,7 +235,6 @@ public void setProperties(Properties properties) {
 		this.properties = properties;
 	}
 
-	@Override
 	public Properties getProperties() {
 		return this.properties;
 	}
@@ -258,12 +243,10 @@ public void setPersistenceXMLSchemaVersion(String persistenceXMLSchemaVersion) {
 		this.persistenceXMLSchemaVersion = persistenceXMLSchemaVersion;
 	}
 
-	@Override
 	public String getPersistenceXMLSchemaVersion() {
 		return this.persistenceXMLSchemaVersion;
 	}
 
-	@Override
 	public void setPersistenceProviderPackageName(@Nullable String persistenceProviderPackageName) {
 		this.persistenceProviderPackageName = persistenceProviderPackageName;
 	}
@@ -273,32 +256,6 @@ public void setPersistenceProviderPackageName(@Nullable String persistenceProvid
 	}
 
 
-	/**
-	 * This implementation returns the default ClassLoader.
-	 * @see org.springframework.util.ClassUtils#getDefaultClassLoader()
-	 */
-	@Override
-	public @Nullable ClassLoader getClassLoader() {
-		return ClassUtils.getDefaultClassLoader();
-	}
-
-	/**
-	 * This implementation throws an UnsupportedOperationException.
-	 */
-	@Override
-	public void addTransformer(ClassTransformer classTransformer) {
-		throw new UnsupportedOperationException("addTransformer not supported");
-	}
-
-	/**
-	 * This implementation throws an UnsupportedOperationException.
-	 */
-	@Override
-	public ClassLoader getNewTempClassLoader() {
-		throw new UnsupportedOperationException("getNewTempClassLoader not supported");
-	}
-
-
 	@Override
 	public String toString() {
 		return "PersistenceUnitInfo: name '" + this.persistenceUnitName +

spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/PersistenceUnitPostProcessor.java

@@ -17,9 +17,11 @@
 package org.springframework.orm.jpa.persistenceunit;
 
 /**
- * Callback interface for post-processing a JPA PersistenceUnitInfo.
- * Implementations can be registered with a DefaultPersistenceUnitManager
- * or via a LocalContainerEntityManagerFactoryBean.
+ * Callback interface for post-processing a {@link MutablePersistenceUnitInfo}
+ * configuration that Spring prepares for JPA persistence unit bootstrapping.
+ *
+ * <p>Implementations can be registered with a {@link DefaultPersistenceUnitManager}
+ * or via a {@link org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean}.
  *
  * @author Juergen Hoeller
  * @since 2.0
@@ -29,10 +31,10 @@
 public interface PersistenceUnitPostProcessor {
 
 	/**
-	 * Post-process the given PersistenceUnitInfo, for example registering
-	 * further entity classes and jar files.
-	 * @param pui the chosen PersistenceUnitInfo, as read from {@code persistence.xml}.
-	 * Passed in as MutablePersistenceUnitInfo.
+	 * Post-process the given {@link MutablePersistenceUnitInfo},
+	 * for example registering further entity classes and jar files.
+	 * @param pui the chosen persistence unit configuration, as read from
+	 * {@code persistence.xml}. Passed in as MutablePersistenceUnitInfo.
 	 */
 	void postProcessPersistenceUnitInfo(MutablePersistenceUnitInfo pui);
 

spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/PersistenceUnitReader.java

@@ -26,9 +26,9 @@
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
 
+import jakarta.persistence.PersistenceUnitTransactionType;
 import jakarta.persistence.SharedCacheMode;
 import jakarta.persistence.ValidationMode;
-import jakarta.persistence.spi.PersistenceUnitTransactionType;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.jspecify.annotations.Nullable;
@@ -189,7 +189,6 @@ void parseDocument(Resource resource, Document document, List<SpringPersistenceU
 	/**
 	 * Parse the unit info DOM element.
 	 */
-	@SuppressWarnings("removal")
 	SpringPersistenceUnitInfo parsePersistenceUnitInfo(
 			Element persistenceUnit, String version, @Nullable URL rootUrl) throws IOException {
 

spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/SmartPersistenceUnitInfo.java

@@ -47,4 +47,13 @@ public interface SmartPersistenceUnitInfo extends PersistenceUnitInfo {
 	 */
 	void setPersistenceProviderPackageName(String persistenceProviderPackageName);
 
+	/**
+	 * Determine whether this persistence unit is configured for JTA transactions.
+	 * <p>This allows for a quick check without referring to the JPA transaction type enum
+	 * (primarily for achieving compatibility between JPA 3.2 and 4.0).
+	 * @since 7.0
+	 * @see jakarta.persistence.PersistenceUnitTransactionType#JTA
+	 */
+	boolean isConfiguredForJta();
+
 }