public class DefaultJpaDialect extends Object implements JpaDialect, Serializable
JpaDialect
interface.
Used as default dialect by JpaTransactionManager
.
Simply begins a standard JPA transaction in beginTransaction(javax.persistence.EntityManager, org.springframework.transaction.TransactionDefinition)
and
performs standard exception translation through EntityManagerFactoryUtils
.
NOTE: Spring's JPA support requires JPA 2.1 or higher, as of Spring 5.0.
JpaTransactionManager.setJpaDialect(org.springframework.orm.jpa.JpaDialect)
,
Serialized FormConstructor and Description |
---|
DefaultJpaDialect() |
Modifier and Type | Method and Description |
---|---|
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. |
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.
|
DataAccessException |
translateExceptionIfPossible(RuntimeException ex)
This implementation delegates to EntityManagerFactoryUtils.
|
@Nullable public Object beginTransaction(EntityManager entityManager, TransactionDefinition definition) throws PersistenceException, SQLException, TransactionException
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.
beginTransaction
in interface JpaDialect
entityManager
- the EntityManager to begin a JPA transaction ondefinition
- the Spring transaction definition that defines semanticsJpaDialect.cleanupTransaction(java.lang.Object)
). May implement the
SavepointManager
interface.PersistenceException
- if thrown by JPA methodsSQLException
- if thrown by JDBC methodsTransactionException
- in case of invalid argumentsEntityTransaction.begin()
,
InvalidIsolationLevelException
,
cleanupTransaction(java.lang.Object)
@Nullable public Object prepareTransaction(EntityManager entityManager, boolean readOnly, @Nullable String name) throws PersistenceException
JpaDialect
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 to optimize for specific data access use cases (effectively using the current transaction name as use case identifier).
prepareTransaction
in interface JpaDialect
entityManager
- the EntityManager to begin a JPA transaction onreadOnly
- whether the transaction is supposed to be read-onlyname
- the name of the transaction (if any)PersistenceException
- if thrown by JPA methodsJpaDialect.cleanupTransaction(java.lang.Object)
public void cleanupTransaction(@Nullable Object transactionData)
beginTransaction
implementation does not require any cleanup.cleanupTransaction
in interface JpaDialect
transactionData
- arbitrary object that holds transaction data, if any
(as returned by beginTransaction or prepareTransaction)beginTransaction(javax.persistence.EntityManager, org.springframework.transaction.TransactionDefinition)
@Nullable public ConnectionHandle getJdbcConnection(EntityManager entityManager, boolean readOnly) throws PersistenceException, SQLException
null
,
indicating that no JDBC Connection can be provided.getJdbcConnection
in interface JpaDialect
entityManager
- the current JPA EntityManagerreadOnly
- whether the Connection is only needed for read-only purposesreleaseJdbcConnection
,
or null
if no JDBC Connection can be retrievedPersistenceException
- if thrown by JPA methodsSQLException
- if thrown by JDBC methodsJpaDialect.releaseJdbcConnection(org.springframework.jdbc.datasource.ConnectionHandle, javax.persistence.EntityManager)
,
ConnectionHandle.getConnection()
,
SimpleConnectionHandle
,
JpaTransactionManager.setDataSource(javax.sql.DataSource)
public void releaseJdbcConnection(ConnectionHandle conHandle, EntityManager em) throws PersistenceException, SQLException
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.
releaseJdbcConnection
in interface JpaDialect
conHandle
- the JDBC Connection handle to releaseem
- the current JPA EntityManagerPersistenceException
- if thrown by JPA methodsSQLException
- if thrown by JDBC methodsConnection.close()
@Nullable public DataAccessException translateExceptionIfPossible(RuntimeException ex)
translateExceptionIfPossible
in interface PersistenceExceptionTranslator
ex
- a RuntimeException to translatenull
if the
exception could not be translated, as in this case it may result from
user code rather than from an actual persistence problem)EntityManagerFactoryUtils.convertJpaAccessExceptionIfPossible(java.lang.RuntimeException)