Support for Hibernate ORM 5.0 Beta 2

Issue: SPR-11694

Author: jhoeller

build.gradle

@@ -827,6 +827,21 @@ project("spring-orm-hibernate4") {
 	}
 }
 
+project("spring-orm-hibernate5") {
+	description = "Spring Object/Relational Mapping - Hibernate 5 support"
+	merge.into = project(":spring-orm")
+
+	dependencies {
+		provided(project(":spring-jdbc"))
+		provided(project(":spring-tx"))
+		optional(project(":spring-web"))
+		optional("org.hibernate:hibernate-core:5.0.0.Beta2")
+		optional("org.hibernate:hibernate-entitymanager:5.0.0.Beta2")
+		optional("javax.servlet:javax.servlet-api:3.0.1")
+		optional("aopalliance:aopalliance:1.0")
+	}
+}
+
 project("spring-webmvc") {
 	description = "Spring Web MVC"
 

settings.gradle

@@ -15,6 +15,7 @@ include "spring-jms"
 include "spring-messaging"
 include "spring-orm"
 include "spring-orm-hibernate4"
+include "spring-orm-hibernate5"
 include "spring-oxm"
 include "spring-test"
 include "spring-tx"

spring-orm-hibernate4/src/main/java/org/springframework/orm/jpa/vendor/SpringHibernateJpaPersistenceProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,8 @@
 
 package org.springframework.orm.jpa.vendor;
 
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
 import javax.persistence.EntityManagerFactory;
 import javax.persistence.spi.PersistenceUnitInfo;
@@ -24,7 +26,6 @@
 import org.hibernate.jpa.HibernatePersistenceProvider;
 import org.hibernate.jpa.boot.internal.EntityManagerFactoryBuilderImpl;
 import org.hibernate.jpa.boot.internal.PersistenceUnitInfoDescriptor;
-import org.hibernate.service.ServiceRegistry;
 
 import org.springframework.orm.jpa.persistenceunit.SmartPersistenceUnitInfo;
 
@@ -33,7 +34,7 @@
  * from the {@code org.hibernate.jpa} package, adding support for
  * {@link SmartPersistenceUnitInfo#getManagedPackages()}.
  *
- * <p>Compatible with Hibernate 4.3. {@link SpringHibernateEjbPersistenceProvider}
+ * <p>Compatible with Hibernate 4.3-5.0. {@link SpringHibernateEjbPersistenceProvider}
  * is an alternative for compatibility with earlier Hibernate versions (3.6-4.2).
  *
  * @author Juergen Hoeller
@@ -45,19 +46,18 @@ class SpringHibernateJpaPersistenceProvider extends HibernatePersistenceProvider
 
 	@Override
 	@SuppressWarnings("rawtypes")
-	public EntityManagerFactory createContainerEntityManagerFactory(final PersistenceUnitInfo info, Map properties) {
-		return new EntityManagerFactoryBuilderImpl(new PersistenceUnitInfoDescriptor(info), properties) {
-			@Override
-			public Configuration buildHibernateConfiguration(ServiceRegistry serviceRegistry) {
-				Configuration configuration = super.buildHibernateConfiguration(serviceRegistry);
-				if (info instanceof SmartPersistenceUnitInfo) {
-					for (String managedPackage : ((SmartPersistenceUnitInfo) info).getManagedPackages()) {
-						configuration.addPackage(managedPackage);
+	public EntityManagerFactory createContainerEntityManagerFactory(PersistenceUnitInfo info, Map properties) {
+		final List<String> mergedClassesAndPackages = new ArrayList<String>(info.getManagedClassNames());
+		if (info instanceof SmartPersistenceUnitInfo) {
+			mergedClassesAndPackages.addAll(((SmartPersistenceUnitInfo) info).getManagedPackages());
+		}
+		return new EntityManagerFactoryBuilderImpl(
+				new PersistenceUnitInfoDescriptor(info) {
+					@Override
+					public List<String> getManagedClassNames() {
+						return mergedClassesAndPackages;
 					}
-				}
-				return configuration;
-			}
-		}.build();
+				}, properties).build();
 	}
 
 }

spring-orm-hibernate5/src/main/java/org/springframework/orm/hibernate5/ConfigurableJtaPlatform.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright 2002-2015 the original author or authors.
+ *
+ * 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 org.springframework.orm.hibernate5;
+
+import javax.transaction.Status;
+import javax.transaction.Synchronization;
+import javax.transaction.SystemException;
+import javax.transaction.Transaction;
+import javax.transaction.TransactionManager;
+import javax.transaction.TransactionSynchronizationRegistry;
+import javax.transaction.UserTransaction;
+
+import org.hibernate.TransactionException;
+import org.hibernate.engine.transaction.jta.platform.spi.JtaPlatform;
+
+import org.springframework.transaction.jta.UserTransactionAdapter;
+import org.springframework.util.Assert;
+
+/**
+ * Implementation of Hibernate 4's JtaPlatform SPI, exposing passed-in {@link TransactionManager},
+ * {@link UserTransaction} and {@link TransactionSynchronizationRegistry} references.
+ *
+ * @author Juergen Hoeller
+ * @since 4.2
+ */
+@SuppressWarnings("serial")
+class ConfigurableJtaPlatform implements JtaPlatform {
+
+	private final TransactionManager transactionManager;
+
+	private final UserTransaction userTransaction;
+
+	private final TransactionSynchronizationRegistry transactionSynchronizationRegistry;
+
+
+	/**
+	 * Create a new ConfigurableJtaPlatform instance with the given
+	 * JTA TransactionManager and optionally a given UserTransaction.
+	 * @param tm the JTA TransactionManager reference (required)
+	 * @param ut the JTA UserTransaction reference (optional)
+	 * @param tsr the JTA 1.1 TransactionSynchronizationRegistry (optional)
+	 */
+	public ConfigurableJtaPlatform(TransactionManager tm, UserTransaction ut, TransactionSynchronizationRegistry tsr) {
+		Assert.notNull(tm, "TransactionManager reference must not be null");
+		this.transactionManager = tm;
+		this.userTransaction = (ut != null ? ut : new UserTransactionAdapter(tm));
+		this.transactionSynchronizationRegistry = tsr;
+	}
+
+
+	@Override
+	public TransactionManager retrieveTransactionManager() {
+		return this.transactionManager;
+	}
+
+	@Override
+	public UserTransaction retrieveUserTransaction() {
+		return this.userTransaction;
+	}
+
+	@Override
+	public Object getTransactionIdentifier(Transaction transaction) {
+		return transaction;
+	}
+
+	@Override
+	public boolean canRegisterSynchronization() {
+		try {
+			return (this.transactionManager.getStatus() == Status.STATUS_ACTIVE);
+		}
+		catch (SystemException ex) {
+			throw new TransactionException("Could not determine JTA transaction status", ex);
+		}
+	}
+
+	@Override
+	public void registerSynchronization(Synchronization synchronization) {
+		if (this.transactionSynchronizationRegistry != null) {
+			this.transactionSynchronizationRegistry.registerInterposedSynchronization(synchronization);
+		}
+		else {
+			try {
+				this.transactionManager.getTransaction().registerSynchronization(synchronization);
+			}
+			catch (Exception ex) {
+				throw new TransactionException("Could not access JTA Transaction to register synchronization", ex);
+			}
+		}
+	}
+
+	@Override
+	public int getCurrentStatus() throws SystemException {
+		return this.transactionManager.getStatus();
+	}
+
+}

spring-orm-hibernate5/src/main/java/org/springframework/orm/hibernate5/HibernateCallback.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2002-2015 the original author or authors.
+ *
+ * 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 org.springframework.orm.hibernate5;
+
+import org.hibernate.HibernateException;
+import org.hibernate.Session;
+
+/**
+ * Callback interface for Hibernate code. To be used with {@link HibernateTemplate}'s
+ * execution methods, often as anonymous classes within a method implementation.
+ * A typical implementation will call {@code Session.load/find/update} to perform
+ * some operations on persistent objects.
+ *
+ * @author Juergen Hoeller
+ * @since 4.2
+ * @see HibernateTemplate
+ * @see HibernateTransactionManager
+ */
+public interface HibernateCallback<T> {
+
+	/**
+	 * Gets called by {@code HibernateTemplate.execute} with an active
+	 * Hibernate {@code Session}. Does not need to care about activating
+	 * or closing the {@code Session}, or handling transactions.
+	 *
+	 * <p>Allows for returning a result object created within the callback,
+	 * i.e. a domain object or a collection of domain objects.
+	 * A thrown custom RuntimeException is treated as an application exception:
+	 * It gets propagated to the caller of the template.
+	 *
+	 * @param session active Hibernate session
+	 * @return a result object, or {@code null} if none
+	 * @throws HibernateException if thrown by the Hibernate API
+	 * @see HibernateTemplate#execute
+	 */
+	T doInHibernate(Session session) throws HibernateException;
+
+}

spring-orm-hibernate5/src/main/java/org/springframework/orm/hibernate5/HibernateExceptionTranslator.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2002-2015 the original author or authors.
+ *
+ * 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 org.springframework.orm.hibernate5;
+
+import org.hibernate.HibernateException;
+
+import org.springframework.dao.DataAccessException;
+import org.springframework.dao.support.PersistenceExceptionTranslator;
+
+/**
+ * {@link PersistenceExceptionTranslator} capable of translating {@link HibernateException}
+ * instances to Spring's {@link DataAccessException} hierarchy.
+ *
+ * <p>Extended by {@link LocalSessionFactoryBean}, so there is no need to declare this
+ * translator in addition to a {@code LocalSessionFactoryBean}.
+ *
+ * <p>When configuring the container with {@code @Configuration} classes, a {@code @Bean}
+ * of this type must be registered manually.
+ *
+ * @author Juergen Hoeller
+ * @since 4.2
+ * @see org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor
+ * @see SessionFactoryUtils#convertHibernateAccessException(HibernateException)
+ */
+public class HibernateExceptionTranslator implements PersistenceExceptionTranslator {
+
+	@Override
+	public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
+		if (ex instanceof HibernateException) {
+			return convertHibernateAccessException((HibernateException) ex);
+		}
+		return null;
+	}
+
+	/**
+	 * Convert the given HibernateException to an appropriate exception from the
+	 * {@code org.springframework.dao} hierarchy.
+	 * @param ex HibernateException that occured
+	 * @return a corresponding DataAccessException
+	 * @see SessionFactoryUtils#convertHibernateAccessException
+	 */
+	protected DataAccessException convertHibernateAccessException(HibernateException ex) {
+		return SessionFactoryUtils.convertHibernateAccessException(ex);
+	}
+
+}

spring-orm-hibernate5/src/main/java/org/springframework/orm/hibernate5/HibernateJdbcException.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2002-2015 the original author or authors.
+ *
+ * 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 org.springframework.orm.hibernate5;
+
+import java.sql.SQLException;
+
+import org.hibernate.JDBCException;
+
+import org.springframework.dao.UncategorizedDataAccessException;
+
+/**
+ * Hibernate-specific subclass of UncategorizedDataAccessException,
+ * for JDBC exceptions that Hibernate wrapped.
+ *
+ * @author Juergen Hoeller
+ * @since 4.2
+ * @see SessionFactoryUtils#convertHibernateAccessException
+ */
+@SuppressWarnings("serial")
+public class HibernateJdbcException extends UncategorizedDataAccessException {
+
+	public HibernateJdbcException(JDBCException ex) {
+		super("JDBC exception on Hibernate data access: SQLException for SQL [" + ex.getSQL() + "]; SQL state [" +
+				ex.getSQLState() + "]; error code [" + ex.getErrorCode() + "]; " + ex.getMessage(), ex);
+	}
+
+	/**
+	 * Return the underlying SQLException.
+	 */
+	public SQLException getSQLException() {
+		return ((JDBCException) getCause()).getSQLException();
+	}
+
+	/**
+	 * Return the SQL that led to the problem.
+	 */
+	public String getSql() {
+		return ((JDBCException) getCause()).getSQL();
+	}
+
+}