{"id":152,"date":"2010-10-02T17:26:40","date_gmt":"2010-10-02T16:26:40","guid":{"rendered":"http:\/\/sebthom.de\/?p=152"},"modified":"2010-10-02T17:48:19","modified_gmt":"2010-10-02T16:48:19","slug":"configuring-emf-teneo-hibernate-dbcp-spring-transactions-opensessioninviewfilter","status":"publish","type":"post","link":"https:\/\/sebthom.de\/de\/152-configuring-emf-teneo-hibernate-dbcp-spring-transactions-opensessioninviewfilter\/","title":{"rendered":"Configuring EMF Teneo with Hibernate, Commons DBCP, Spring Hibernate Transaction Manager, and the OpenSessionInViewFilter"},"content":{"rendered":"

While trying to get an application working with , Hibernate<\/a>, Commons DBCP<\/a>, Spring Hibernate Transaction Manager<\/a> and the OpenSessionInViewFilter<\/a> I encountered several unexpected issues. Here is an example of a working configuration for this software stack. Read the comments below the XML file for some explanations.<\/p>\n

HbDataStoreWithDataSource.java:<\/b><\/p>\n

\r\npackage de.sebthom.util;\r\n\r\nimport java.sql.*;\r\nimport java.util.Properties;\r\nimport javax.sql.DataSource;\r\nimport org.eclipse.emf.teneo.PersistenceOptions;\r\nimport org.eclipse.emf.teneo.hibernate.HbSessionDataStore;\r\nimport org.hibernate.HibernateException;\r\nimport org.hibernate.cfg.*;\r\nimport org.hibernate.connection.ConnectionProvider;\r\n\r\n\/**\r\n * @author Sebastian Thomschke\r\n *\/\r\npublic class HbDataStoreWithDataSource extends HbSessionDataStore {\r\n  public final static class CustomConnectionProvider implements ConnectionProvider {\r\n    private DataSource ds;\r\n\r\n    public void close() throws HibernateException { }\r\n\r\n    public void closeConnection(final Connection conn) throws SQLException {\r\n      conn.close();\r\n    }\r\n\r\n    public void configure(final Properties props) throws HibernateException {\r\n      ds = _CONFIG_TIME_DS_HOLDER.get();\r\n    }\r\n\r\n    public Connection getConnection() throws SQLException {\r\n      return ds.getConnection();\r\n    }\r\n\r\n   public boolean supportsAggressiveRelease() {\r\n     return false;\r\n   }\r\n  }\r\n\r\n  private static final long serialVersionUID = 1L;\r\n  private static HbDataStoreWithDataSource INSTANCE;\r\n\r\n  \/**\r\n   * the data source holder acts as a thread safe bridge between the DSConnectionProvider which is instantiated by Hibernate internally\r\n   * and the data source injected into the session factory during spring configuration time. \r\n   *\/\r\n  private static final ThreadLocal _CONFIG_TIME_DS_HOLDER = new ThreadLocal();\r\n\r\n  public static HbDataStoreWithDataSource getInstance() {\r\n\t\treturn INSTANCE;\r\n  }\r\n\r\n  private final Properties props = new Properties();\r\n\r\n  public HbDataStoreWithDataSource() {\r\n    INSTANCE = this;\r\n\r\n    props.setProperty(PersistenceOptions.ADD_INDEX_FOR_FOREIGN_KEY, \"true\");\r\n    props.setProperty(PersistenceOptions.FETCH_CONTAINMENT_EAGERLY, \"false\");\r\n    props.setProperty(PersistenceOptions.FETCH_ASSOCIATION_EXTRA_LAZY, \"false\");\r\n\r\n    \/\/ tell Teneo to not change the table names, we do this using Hibernate's ImprovedNamingStrategy\r\n    props.setProperty(PersistenceOptions.SQL_CASE_STRATEGY, \"none\");\r\n    props.setProperty(PersistenceOptions.MAXIMUM_SQL_NAME_LENGTH, \"-1\");\r\n  }\r\n\r\n  protected Configuration createConfiguration() {\r\n    Configuration cfg = super.createConfiguration();\r\n    cfg.setNamingStrategy(ImprovedNamingStrategy.INSTANCE);\r\n\r\n    \/\/ only if a DS is injected we register our connection provider\r\n    if (_CONFIG_TIME_DS_HOLDER.get() != null)\r\n      cfg.setProperty(Environment.CONNECTION_PROVIDER, CustomConnectionProvider.class.getName());\r\n    return cfg;\r\n  }\r\n\r\n  public void setDataSource(final DataSource ds) {\r\n    _CONFIG_TIME_DS_HOLDER.set(ds);\r\n  }\r\n\r\n  public final void setHibernateProperties(final Properties hibernateProperties) {\r\n    throw new UnsupportedOperationException();\r\n  }\r\n\r\n  public final void setPersistenceProperties(final Properties persistenceOptions) {\r\n    throw new UnsupportedOperationException();\r\n  }\r\n\r\n  public void setProperties(final Properties props) {\r\n    this.props.putAll(props);\r\n    super.setProperties(this.props);\r\n  }\r\n}\r\n<\/pre>\n
web.xml:<\/b><\/p>\n
\r\n\r\n  openSessionInViewFilter<\/filter-name>\r\n  org.springframework.orm.hibernate3.support.OpenSessionInViewFilter<\/filter-class>\r\n    \r\n      singleSession<\/param-name>\r\n      true<\/param-value>\r\n    <\/init-param>\r\n    \r\n      sessionFactoryBeanName<\/param-name>\r\n      realSessionFactory<\/param-value>\r\n    <\/init-param>\r\n<\/filter>\r\n\r\n  openSessionInViewFilter<\/filter-name>\r\n  \/*<\/url-pattern>\r\n  REQUEST<\/dispatcher>\r\n  ERROR<\/dispatcher>\r\n<\/filter-mapping>\r\n<\/pre>\n
applicationContext.xml:<\/b><\/p>\n
\r\n\r\n\r\n  <\/context:property-placeholder>\r\n\r\n  \r\n    \r\n      \r\n        ${jdbc.driverClassName}<\/property>\r\n        ${jdbc.url}<\/property>\r\n        ${jdbc.username}<\/property>\r\n        ${jdbc.password}<\/property>\r\n        false<\/property>\r\n        ${jdbc.maxConnections}<\/property>\r\n        ${jdbc.minConnections}<\/property>\r\n        10000<\/property>\r\n        ${jdbc.minConnections}<\/property>\r\n        ${jdbc.validationQuery}<\/property>\r\n        false<\/property>\r\n        true<\/property>\r\n        1200000<\/property>\r\n        1800000<\/property>\r\n        5<\/property>\r\n      <\/bean>\r\n    <\/property>\r\n  <\/bean>\r\n\r\n  \r\n    \r\n      hibernate.dialect=${hibernate.dialect}\r\n      hibernate.hbm2ddl.auto=${hibernate.hbm2ddl.auto}\r\n      hibernate.jdbc.batch_size=2000\r\n      hibernate.show_sql=${hibernate.show_sql}\r\n      hibernate.transaction.auto_close_session=false\r\n      hibernate.current_session_context_class=org.springframework.orm.hibernate3.SpringSessionContext\r\n      hibernate.transaction.factory_class=org.springframework.orm.hibernate3.SpringTransactionFactory\r\n    <\/value><\/property>\r\n    com.acme.ShopPackageImpl<\/value><\/list><\/property> \r\n  <\/bean>\r\n\r\n  <\/bean>\r\n\r\n  <\/bean>\r\n\r\n  <\/tx:annotation-driven>\r\n\r\n<\/beans>\r\n<\/pre>\n
Comments:<\/b><\/p>\n
    \n
  1. VERY IMPORTANT:<\/b>The HibernateTransactionManager<\/b> does NOT get the teneoSessionFactory(HbSessionDataStore) object passed in as sessionFactory, but the underlying Hibernate SessionFactory that can be retrieved from the HbSessionDataStore via the getSessionFactory() method. Not doing so will result in duplicate Hibernate Sessions completely breaking the transaction managment. This happens because in that case the TransactionSynchronizationManager will sometimes internally bind the hibernate session to the current thread based on different keys and thus does not find it again. Here are some stacktraces showing the problem:\n
    \r\nTransactionSynchronizationManager.bindResource(Object, Object) line: 170\t\r\nat OpenSessionInViewFilter.doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) line: 183\r\n=> results in TransactionSynchronizationManager.bindResource(HbSessionDataStore<\/b>, SessionHolder) => as key the Teneo SessionFactory<\/b> is used\r\n\r\nTransactionSynchronizationManager.bindResource(Object, Object) line: 170\t\r\nat SessionFactoryUtils.doGetSession(SessionFactory, Interceptor, SQLExceptionTranslator, boolean) line: 339\t\r\nat SessionFactoryUtils.doGetSession(SessionFactory, boolean) line: 256\t\r\nat SpringSessionContext.currentSession() line: 60\t\r\nat SessionFactoryImpl.getCurrentSession() line: 700\t\r\nat HbSessionDataStore(HbBaseSessionDataStore).getCurrentSession() line: 161\t\r\n=> results in TransactionSynchronizationManager.bindResource(SessionFactoryImpl<\/b>, SessionHolder) => as key the Hibernate SessionFactory<\/b> is used\r\n\r\nTransactionSynchronizationManager.bindResource(Object, Object) line: 170\t\r\nat HibernateTransactionManager.doBegin(Object, TransactionDefinition) line: 577\t\r\nat HibernateTransactionManager(AbstractPlatformTransactionManager).getTransaction(TransactionDefinition) line: 371\r\nat TransactionInterceptor(TransactionAspectSupport).createTransactionIfNecessary(PlatformTransactionManager, TransactionAttribute, String) line: 316\t\r\nat TransactionInterceptor.invoke(MethodInvocation) line: 105\t\r\nat ReflectiveMethodInvocation.proceed() line: 172\r\n=> results in TransactionSynchronizationManager.bindResource(HbSessionDataStore<\/b>, SessionHolder) => as key the Teneo SessionFactory<\/b> is used\r\n<\/pre>\n
  2. defaultAutoCommit<\/b> is set to false<\/b> to ensure that Spring has full control over the transaction and that the connection pool is not committing statements automatically based on it’s own strategies.\n
  3. The example uses an extended version of the org.eclipse.emf.teneo.hibernate.HbSessionDataStore<\/b> class that allows the usage of a DataSource object and that configures Teneo to not alter the table, column names but let’s Hibernate handle this via its ImprovedNamingStrategy.\n
  4. hibernate.transaction.auto_close_session<\/b> is set to false<\/b> to avoid “SessionException: Session is closed!” in conjunction with the OpenSessionInViewListener.\n
  5. hibernate.current_session_context_class<\/b> and hibernate.transaction.factory_class<\/b> are set to special Spring implementations to avoid “org.hibernate.HibernateException: No CurrentSessionContext configured!” when not using Spring Hibernate Template via HibernateDAOSupport. It is not recommended to use the Hibernate Template anymore, see http:\/\/blog.springsource.com\/2007\/06\/26\/so-should-you-still-use-springs-hibernatetemplate-andor-jpatemplate\/<\/a>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
    While trying to get an application working with<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[43],"tags":[96,88,93,30,97,94,92,95],"class_list":["post-152","post","type-post","status-publish","format-standard","hentry","category-java-coding","tag-dbcp","tag-emf","tag-hibernate","tag-java","tag-persistence","tag-spring","tag-teneo","tag-transaction"],"_links":{"self":[{"href":"https:\/\/sebthom.de\/de\/wp-json\/wp\/v2\/posts\/152","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sebthom.de\/de\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sebthom.de\/de\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sebthom.de\/de\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/sebthom.de\/de\/wp-json\/wp\/v2\/comments?post=152"}],"version-history":[{"count":0,"href":"https:\/\/sebthom.de\/de\/wp-json\/wp\/v2\/posts\/152\/revisions"}],"wp:attachment":[{"href":"https:\/\/sebthom.de\/de\/wp-json\/wp\/v2\/media?parent=152"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sebthom.de\/de\/wp-json\/wp\/v2\/categories?post=152"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sebthom.de\/de\/wp-json\/wp\/v2\/tags?post=152"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}