public class DefaultJdoDialect extends java.lang.Object implements JdoDialect, PersistenceExceptionTranslator
JdoDialect
interface.
Updated to build on JDO 2.0 or higher, as of Spring 2.5.
Used as default dialect by JdoAccessor
and JdoTransactionManager
.
Simply begins a standard JDO transaction in beginTransaction
.
Returns a handle for a JDO2 DataStoreConnection on getJdbcConnection
.
Calls the corresponding JDO2 PersistenceManager operation on flush
Ignores a given query timeout in applyQueryTimeout
.
Uses a Spring SQLExceptionTranslator for exception translation, if applicable.
Note that, even with JDO2, vendor-specific subclasses are still necessary
for special transaction semantics and more sophisticated exception translation.
Furthermore, vendor-specific subclasses are encouraged to expose the native JDBC
Connection on getJdbcConnection
, rather than JDO2's wrapper handle.
This class also implements the PersistenceExceptionTranslator interface, as autodetected by Spring's PersistenceExceptionTranslationPostProcessor, for AOP-based translation of native exceptions to Spring DataAccessExceptions. Hence, the presence of a standard DefaultJdoDialect bean automatically enables a PersistenceExceptionTranslationPostProcessor to translate JDO exceptions.
setJdbcExceptionTranslator(org.springframework.jdbc.support.SQLExceptionTranslator)
,
JdoAccessor.setJdoDialect(org.springframework.orm.jdo.JdoDialect)
,
JdoTransactionManager.setJdoDialect(org.springframework.orm.jdo.JdoDialect)
,
PersistenceExceptionTranslationPostProcessor
Modifier and Type | Class and Description |
---|---|
private static class |
DefaultJdoDialect.DataStoreConnectionHandle
ConnectionHandle implementation that fetches a new JDO2 DataStoreConnection
for every
getConnection call and closes the Connection on
releaseConnection . |
Modifier and Type | Field and Description |
---|---|
private SQLExceptionTranslator |
jdbcExceptionTranslator |
protected Log |
logger |
private static java.lang.reflect.Method |
setTimeoutMillisMethod |
Constructor and Description |
---|
DefaultJdoDialect()
Create a new DefaultJdoDialect.
|
DefaultJdoDialect(java.lang.Object connectionFactory)
Create a new DefaultJdoDialect.
|
Modifier and Type | Method and Description |
---|---|
void |
applyQueryTimeout(Query query,
int remainingTimeInSeconds)
This implementation applies a JDO 3.0 query timeout, if available.
|
java.lang.Object |
beginTransaction(Transaction transaction,
TransactionDefinition definition)
This implementation invokes the standard JDO
Transaction.begin
method. |
void |
cleanupTransaction(java.lang.Object transactionData)
This implementation does nothing, as the default beginTransaction implementation
does not require any cleanup.
|
protected java.lang.String |
extractSqlStringFromException(JDOException ex)
Template method for extracting a SQL String from the given exception.
|
ConnectionHandle |
getJdbcConnection(PersistenceManager pm,
boolean readOnly)
This implementation returns a DataStoreConnectionHandle for JDO2,
which will also work on JDO1 until actually accessing the JDBC Connection.
|
SQLExceptionTranslator |
getJdbcExceptionTranslator()
Return the JDBC exception translator for this dialect, if any.
|
void |
releaseJdbcConnection(ConnectionHandle conHandle,
PersistenceManager pm)
This implementation does nothing, assuming that the Connection
will implicitly be closed with the PersistenceManager.
|
void |
setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator)
Set the JDBC exception translator for this dialect.
|
DataAccessException |
translateException(JDOException ex)
This implementation delegates to PersistenceManagerFactoryUtils.
|
DataAccessException |
translateExceptionIfPossible(java.lang.RuntimeException ex)
Implementation of the PersistenceExceptionTranslator interface,
as autodetected by Spring's PersistenceExceptionTranslationPostProcessor.
|
private static final java.lang.reflect.Method setTimeoutMillisMethod
protected final Log logger
private SQLExceptionTranslator jdbcExceptionTranslator
public DefaultJdoDialect()
public DefaultJdoDialect(java.lang.Object connectionFactory)
connectionFactory
- the connection factory of the JDO PersistenceManagerFactory,
which is used to initialize the default JDBC exception translatorjavax.jdo.PersistenceManagerFactory#getConnectionFactory()
,
PersistenceManagerFactoryUtils.newJdbcExceptionTranslator(Object)
public void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator)
Applied to any SQLException root cause of a JDOException, if specified. The default is to rely on the JDO provider's native exception translation.
jdbcExceptionTranslator
- exception translatorSQLException
,
javax.jdo.JDOException#getCause()
,
SQLErrorCodeSQLExceptionTranslator
,
SQLStateSQLExceptionTranslator
public SQLExceptionTranslator getJdbcExceptionTranslator()
public java.lang.Object beginTransaction(Transaction transaction, TransactionDefinition definition) throws JDOException, java.sql.SQLException, TransactionException
Transaction.begin
method. Throws an InvalidIsolationLevelException if a non-default isolation
level is set.beginTransaction
in interface JdoDialect
transaction
- the JDO transaction to begindefinition
- the Spring transaction definition that defines semanticsJDOException
- if thrown by JDO methodsjava.sql.SQLException
- if thrown by JDBC methodsTransactionException
- in case of invalid argumentsjavax.jdo.Transaction#begin
,
InvalidIsolationLevelException
public void cleanupTransaction(java.lang.Object transactionData)
cleanupTransaction
in interface JdoDialect
transactionData
- arbitrary object that holds transaction data, if any
(as returned by beginTransaction)beginTransaction(Transaction, org.springframework.transaction.TransactionDefinition)
public ConnectionHandle getJdbcConnection(PersistenceManager pm, boolean readOnly) throws JDOException, java.sql.SQLException
For pre-JDO2 implementations, override this method to return the
Connection through the corresponding vendor-specific mechanism, or null
if the Connection is not retrievable.
NOTE: A JDO2 DataStoreConnection is always a wrapper, never the native JDBC Connection. If you need access to the native JDBC Connection (or the connection pool handle, to be unwrapped via a Spring NativeJdbcExtractor), override this method to return the native Connection through the corresponding vendor-specific mechanism.
A JDO2 DataStoreConnection is only "borrowed" from the PersistenceManager:
it needs to be returned as early as possible. Effectively, JDO2 requires the
fetched Connection to be closed before continuing PersistenceManager work.
For this reason, the exposed ConnectionHandle eagerly releases its JDBC
Connection at the end of each JDBC data access operation (that is, on
DataSourceUtils.releaseConnection
).
getJdbcConnection
in interface JdoDialect
pm
- the current JDO PersistenceManagerreadOnly
- whether the Connection is only needed for read-only purposesreleaseJdbcConnection
, or null
if no JDBC Connection can be retrievedJDOException
- if thrown by JDO methodsjava.sql.SQLException
- if thrown by JDBC methodsjavax.jdo.PersistenceManager#getDataStoreConnection()
,
NativeJdbcExtractor
,
DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource)
public void releaseJdbcConnection(ConnectionHandle conHandle, PersistenceManager pm) throws JDOException, java.sql.SQLException
If the JDO provider returns a Connection handle that it
expects the application to close, the dialect needs to invoke
Connection.close
here.
releaseJdbcConnection
in interface JdoDialect
conHandle
- the JDBC Connection handle to releasepm
- the current JDO PersistenceManagerJDOException
- if thrown by JDO methodsjava.sql.SQLException
- if thrown by JDBC methodsConnection.close()
public void applyQueryTimeout(Query query, int remainingTimeInSeconds) throws JDOException
applyQueryTimeout
in interface JdoDialect
query
- the JDO query object to apply the timeout toremainingTimeInSeconds
- the timeout value (seconds) to applyJDOException
- if thrown by JDO methodsJdoTemplate.prepareQuery(Query)
public DataAccessException translateExceptionIfPossible(java.lang.RuntimeException ex)
Converts the exception if it is a JDOException, using this JdoDialect.
Else returns null
to indicate an unknown exception.
translateExceptionIfPossible
in interface PersistenceExceptionTranslator
ex
- a RuntimeException thrownnull
if the
exception could not be translated, as in this case it may result from
user code rather than an actual persistence problem)PersistenceExceptionTranslationPostProcessor
,
translateException(JDOException)
public DataAccessException translateException(JDOException ex)
translateException
in interface JdoDialect
ex
- the JDOException thrownnull
)PersistenceManagerFactoryUtils.convertJdoAccessException(JDOException)
protected java.lang.String extractSqlStringFromException(JDOException ex)
Default implementation always returns null
. Can be overridden in
subclasses to extract SQL Strings for vendor-specific exception classes.
ex
- the JDOException, containing a SQLExceptionnull
if none found