public class

DefaultJpaDialect

extends Object
implements Serializable JpaDialect
java.lang.Object
   ↳ org.springframework.orm.jpa.DefaultJpaDialect
Known Direct Subclasses

Class Overview

Default implementation of the JpaDialect interface. Used as default dialect by JpaAccessor and JpaTransactionManager.

Simply begins a standard JPA transaction in beginTransaction(EntityManager, TransactionDefinition) and performs standard exception translation through EntityManagerFactoryUtils.

See Also

Summary

Public Constructors
DefaultJpaDialect()
Public Methods
Object beginTransaction(EntityManager entityManager, TransactionDefinition definition)
This implementation invokes the standard JPA Transaction.begin method.
void cleanupTransaction(Object transactionData)
This implementation does nothing, since the default beginTransaction implementation does not require any cleanup.
EntityManagerFactoryPlusOperations getEntityManagerFactoryPlusOperations(EntityManagerFactory rawEntityManager)
Return an EntityManagerFactoryPlusOperations implementation for the given raw EntityManagerFactory.
EntityManagerPlusOperations getEntityManagerPlusOperations(EntityManager rawEntityManager)
Return an EntityManagerPlusOperations implementation for the given raw EntityManager.
ConnectionHandle getJdbcConnection(EntityManager entityManager, boolean readOnly)
This implementation always returns null, indicating that no JDBC Connection can be provided.
Object prepareTransaction(EntityManager entityManager, boolean readOnly, String name)
Prepare a JPA transaction, applying the specified semantics.
void releaseJdbcConnection(ConnectionHandle conHandle, EntityManager em)
This implementation does nothing, assuming that the Connection will implicitly be closed with the EntityManager.
boolean supportsEntityManagerFactoryPlusOperations()
Return whether the EntityManagerFactoryPlus(Operations) interface is supported by this provider.
boolean supportsEntityManagerPlusOperations()
Return whether the EntityManagerPlus(Operations) interface is supported by this provider.
DataAccessException translateExceptionIfPossible(RuntimeException ex)
This implementation delegates to EntityManagerFactoryUtils.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.dao.support.PersistenceExceptionTranslator
From interface org.springframework.orm.jpa.JpaDialect

Public Constructors

public DefaultJpaDialect ()

Public Methods

public Object beginTransaction (EntityManager entityManager, TransactionDefinition definition)

This implementation invokes the standard JPA Transaction.begin method. Throws an InvalidIsolationLevelException if a non-default isolation level is set.

This implementation does not return any transaction data Object, since there is no state to be kept for a standard JPA transaction. Hence, subclasses do not have to care about the return value (null) of this implementation and are free to return their own transaction data Object.

Parameters
entityManager the EntityManager to begin a JPA transaction on
definition the Spring transaction definition that defines semantics
Returns
Throws
PersistenceException
SQLException
TransactionException
See Also

public void cleanupTransaction (Object transactionData)

This implementation does nothing, since the default beginTransaction implementation does not require any cleanup.

Parameters
transactionData arbitrary object that holds transaction data, if any (as returned by beginTransaction or prepareTransaction)
See Also

public EntityManagerFactoryPlusOperations getEntityManagerFactoryPlusOperations (EntityManagerFactory rawEntityManager)

Return an EntityManagerFactoryPlusOperations implementation for the given raw EntityManagerFactory. This operations object can be used to serve the additional operations behind a proxy that implements the EntityManagerFactoryPlus interface.

Parameters
rawEntityManager the raw provider-specific EntityManagerFactory
Returns
  • the EntityManagerFactoryPlusOperations implementation

public EntityManagerPlusOperations getEntityManagerPlusOperations (EntityManager rawEntityManager)

Return an EntityManagerPlusOperations implementation for the given raw EntityManager. This operations object can be used to serve the additional operations behind a proxy that implements the EntityManagerPlus interface.

Parameters
rawEntityManager the raw provider-specific EntityManagerFactory
Returns
  • the EntityManagerFactoryPlusOperations implementation

public ConnectionHandle getJdbcConnection (EntityManager entityManager, boolean readOnly)

This implementation always returns null, indicating that no JDBC Connection can be provided.

Parameters
entityManager the current JPA EntityManager
readOnly whether the Connection is only needed for read-only purposes
Returns
  • a handle for the JDBC Connection, to be passed into releaseJdbcConnection, or null if no JDBC Connection can be retrieved
Throws
PersistenceException
SQLException

public Object prepareTransaction (EntityManager entityManager, boolean readOnly, String name)

Prepare a JPA transaction, applying the specified semantics. Called by EntityManagerFactoryUtils when enlisting an EntityManager in a JTA transaction.

An implementation can apply the read-only flag as flush mode. In that case, a transaction data object can be returned that holds the previous flush mode (and possibly other data), to be reset in cleanupTransaction.

Implementations can also use the Spring transaction name, as exposed by the passed-in TransactionDefinition, to optimize for specific data access use cases (effectively using the current transaction name as use case identifier).

Parameters
entityManager the EntityManager to begin a JPA transaction on
readOnly whether the transaction is supposed to be read-only
name the name of the transaction (if any)
Returns
  • an arbitrary object that holds transaction data, if any (to be passed into cleanupTransaction)
Throws
PersistenceException

public void releaseJdbcConnection (ConnectionHandle conHandle, EntityManager em)

This implementation does nothing, assuming that the Connection will implicitly be closed with the EntityManager.

If the JPA implementation returns a Connection handle that it expects the application to close after use, the dialect implementation needs to invoke Connection.close() (or some other method with similar effect) here.

Parameters
conHandle the JDBC Connection handle to release
em the current JPA EntityManager
Throws
PersistenceException
SQLException
See Also

public boolean supportsEntityManagerFactoryPlusOperations ()

Return whether the EntityManagerFactoryPlus(Operations) interface is supported by this provider.

public boolean supportsEntityManagerPlusOperations ()

Return whether the EntityManagerPlus(Operations) interface is supported by this provider.

public DataAccessException translateExceptionIfPossible (RuntimeException ex)

This implementation delegates to EntityManagerFactoryUtils.

Parameters
ex a RuntimeException thrown
Returns
  • the corresponding DataAccessException (or null if the exception could not be translated, as in this case it may result from user code rather than an actual persistence problem)
See Also