Translate Hibernate's GenericJDBCException using SQLErrorCodeSQLExceptionTranslator (by default) [SPR-3050]

[spring-projects-issues]

Matthew Sgarlata opened SPR-3050 and commented

org.hibernate.JDBCExceptions are simply wrapped as HibernateJdbcExceptions (in SessionFactoryUtils.convertHibernateAccessException), a subclass of UncategorizedDataAccessException. This behavior is IMO incorrect. Instead, I submit the JDBC Exception should be passed along to the JDBC exception translator to attempt to find the correct Spring exception.

I have an example which demonstrates an underlying problem acquiring locks in MySQL is incorrectly translated to an UncategorizedDataAccessException, despite the fact that the underlying error code is correctly mapped in sql-error-codes.xml. Here is the stack trace:

DEBUG [http-80-Processor22] (DispatcherServlet:processHandlerException) - Handler execution resulted in exception - forwarding to resolved error view: ModelAndView: reference to view with name 'errorView'; model is {exception=org.springframework.orm.hibernate3.HibernateJdbcException: JDBC exception on Hibernate data access; nested exception is org.hibernate.exception.GenericJDBCException: Could not execute JDBC batch update}
org.springframework.orm.hibernate3.HibernateJdbcException: JDBC exception on Hibernate data access; nested exception is org.hibernate.exception.GenericJDBCException: Could not execute JDBC batch update
Caused by:
org.hibernate.exception.GenericJDBCException: Could not execute JDBC batch update
at org.hibernate.exception.SQLStateConverter.handledNonSpecificException(SQLStateConverter.java:103)
at org.hibernate.exception.SQLStateConverter.convert(SQLStateConverter.java:91)
at org.hibernate.exception.JDBCExceptionHelper.convert(JDBCExceptionHelper.java:43)
at org.hibernate.jdbc.AbstractBatcher.executeBatch(AbstractBatcher.java:202)
at org.hibernate.engine.ActionQueue.executeActions(ActionQueue.java:235)
at org.hibernate.engine.ActionQueue.executeActions(ActionQueue.java:140)
at org.hibernate.event.def.AbstractFlushingEventListener.performExecutions(AbstractFlushingEventListener.java:297)
at org.hibernate.event.def.DefaultFlushEventListener.onFlush(DefaultFlushEventListener.java:27)
at org.hibernate.impl.SessionImpl.flush(SessionImpl.java:985)
at org.hibernate.impl.SessionImpl.managedFlush(SessionImpl.java:333)
at org.hibernate.transaction.JDBCTransaction.commit(JDBCTransaction.java:106)
at org.springframework.orm.hibernate3.HibernateTransactionManager.doCommit(HibernateTransactionManager.java:558)
at org.springframework.transaction.support.AbstractPlatformTransactionManager.processCommit(AbstractPlatformTransactionManager.java:540)
at org.springframework.transaction.support.AbstractPlatformTransactionManager.commit(AbstractPlatformTransactionManager.java:510)
at org.springframework.transaction.interceptor.TransactionAspectSupport.commitTransactionAfterReturning(TransactionAspectSupport.java:310)
at org.springframework.transaction.interceptor.TransactionInterceptor.invoke(TransactionInterceptor.java:117)
at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:185)
at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:209)
at $Proxy9.handleRequest(Unknown Source)
at org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter.handle(SimpleControllerHandlerAdapter.java:45)
at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:806)
at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:736)
at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:396)
at org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:360)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:709)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:802)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:252)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
at com.spider.cms.framework.gzipfilter.CompressionFilter.doFilter(CompressionFilter.java:148)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
at com.spider.cms.framework.ContentTypeFilter.doFilterInternal(ContentTypeFilter.java:125)
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:77)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
at net.sf.morph.web.MorphFilter.doFilter(MorphFilter.java:43)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
at com.spider.cms.framework.springx.AvailableResourceFilter.doFilterInternal(AvailableResourceFilter.java:110)
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:77)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
at com.spider.cms.framework.RequestLogFilter.doFilter(RequestLogFilter.java:42)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:213)
at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:178)
at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:126)
at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:105)
at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:107)
at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:148)
at org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:869)
at org.apache.coyote.http11.Http11BaseProtocol$Http11ConnectionHandler.processConnection(Http11BaseProtocol.java:664)
at org.apache.tomcat.util.net.PoolTcpEndpoint.processSocket(PoolTcpEndpoint.java:527)
at org.apache.tomcat.util.net.LeaderFollowerWorkerThread.runIt(LeaderFollowerWorkerThread.java:80)
at org.apache.tomcat.util.threads.ThreadPool$ControlRunnable.run(ThreadPool.java:684)
at java.lang.Thread.run(Thread.java:619)
Caused by: java.sql.BatchUpdateException: Lock wait timeout exceeded; try restarting transaction
at com.mysql.jdbc.ServerPreparedStatement.executeBatch(ServerPreparedStatement.java:647)
at org.apache.commons.dbcp.DelegatingStatement.executeBatch(DelegatingStatement.java:294)
at org.hibernate.jdbc.BatchingBatcher.doExecuteBatch(BatchingBatcher.java:58)
at org.hibernate.jdbc.AbstractBatcher.executeBatch(AbstractBatcher.java:195)
... 53 more

In the attached screenshot, I show all of the information regarding these exceptions as viewed through Eclipse. The exception thrown by Hibernate is a GenericJDBCException, which contains a nested reference to a java.sql.BatchException. The BatchException has vendorCode 1205, which in sql-error-codes.xml is correctly mapped as one of the CannotAcquireLockCodes.

---

Affects: 2.0 final

Attachments:

• screenshot-1.jpg (259.51 kB)

[spring-projects-issues]

Juergen Hoeller commented

I'm turning this into an improvement request, since there is actual translation going on: However, by default, HibernateTransactionManager's "convertHibernateAccessException" implementation relies on Hibernate's own JDBC exception translation (since Spring 2.0), as handled by "SessionFactoryUtils.convertHibernateAccessException" (which turns Hibernate's LockAcquisitionException into a Spring CannotAcquireLockException if it encounters one). The problem is that Hibernate does not seem to throw the correct exception in your case...

You can still enforce Spring's own SQLException translation: through specifying a SQLErrorCodeSQLExceptionTranslator instance on HibernateTransactionManager's "jdbcExceptionTranslator" property (typically as inner bean definition). This will bypass Hibernate's own exception translation, always translating Hibernate's JDBCException (and its subclasses) through the specified Spring SQLExceptionTranslator.

I guess we could consider having a SQLErrorCodeSQLExceptionTranslator as fallback even when relying on Hibernate's own exception translation, only kicking when Hibernate threw a GenericJDBCException (= was not able to determine a proper exception category itself).

Juergen

[spring-projects-issues]

Matthew Sgarlata commented

Thank you for the explanation regarding HibernateTransactionManager configuration and for looking into this in the next point release!

I really like the approach you detail in your final paragraph, which is to use "a SQLErrorCodeSQLExceptionTranslator as fallback even when relying on Hibernate's own exception translation, only kicking when Hibernate threw a GenericJDBCException (= was not able to determine a proper exception category itself)".

I'm not sure, but it may be more appropriate to key off JDBCException rather than GenericJDBCException. This is how it's currently working in SessionFactoryUtils:

if (ex instanceof JDBCException) {
     return new HibernateJdbcException((JDBCException) ex);
}

Matt

[spring-projects-issues]

Juergen Hoeller commented

I've added such fallback translation for GenericJDBCException, using a default SQLExceptionTranslator in that case. I've made sure that all pre-translated JDBCException subclasses are converted explicitly, so that only non-translated ones remain (as GenericJDBCException).

Juergen