Fix for http://code.google.com/p/mybatis/issues/detail?id=573 . Un resolved session handling in cachingexecutor when autocommit is on

Author: emacarron

src/main/java/org/apache/ibatis/cache/TransactionalCacheManager.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2009-2011 The MyBatis Team
+ *    Copyright 2009-2012 The MyBatis Team
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -23,13 +23,24 @@
 public class TransactionalCacheManager {
 
   private Map<Cache, TransactionalCache> transactionalCaches = new HashMap<Cache, TransactionalCache>();
-
+  private boolean autoCommit; // issue #573. No need to call commit() on autoCommit sessions
+  
+  public TransactionalCacheManager(){
+    this(false);
+  }
+  
+  public TransactionalCacheManager(boolean autoCommit) {
+    this.autoCommit = autoCommit;
+  }
+  
   public void clear(Cache cache) {
     getTransactionalCache(cache).clear();
+    if (autoCommit) commit();
   }
 
   public void putObject(Cache cache, CacheKey key, Object value) {
     getTransactionalCache(cache).putObject(key, value);
+    if (autoCommit) commit();
   }
 
   public void commit() {

src/main/java/org/apache/ibatis/executor/CachingExecutor.java

@@ -34,12 +34,19 @@
 public class CachingExecutor implements Executor {
 
   private Executor delegate;
-  private TransactionalCacheManager tcm = new TransactionalCacheManager();
+  private boolean autoCommit; // issue #573. No need to call commit() on autoCommit sessions
+  private TransactionalCacheManager tcm;
 
   private boolean dirty;
 
   public CachingExecutor(Executor delegate) {
+    this(delegate, false);
+  }
+
+  public CachingExecutor(Executor delegate, boolean autoCommit) {
     this.delegate = delegate;
+    this.autoCommit = autoCommit;
+    this.tcm = new TransactionalCacheManager(autoCommit);
   }
 
   public Transaction getTransaction() {
@@ -48,7 +55,7 @@ public Transaction getTransaction() {
 
   public void close(boolean forceRollback) {
     try {
-      if (dirty) { //issue #499. Unresolved session handling (no commit/rollback)
+      if (dirty) { //issue #499. Unresolved session handling
         tcm.rollback();
       } else {
         tcm.commit();
@@ -147,11 +154,9 @@ public void clearLocalCache() {
 
   private void flushCacheIfRequired(MappedStatement ms) {
     Cache cache = ms.getCache();
-    if (cache != null) {
-      if (ms.isFlushCacheRequired()) {
-        dirty = true; // issue #524. Disable using cached data for this session
-        tcm.clear(cache);
-      }
+    if (cache != null && ms.isFlushCacheRequired()) {
+      tcm.clear(cache);
+      if (!autoCommit) dirty = true; // issue #524. Disable using cached data for this session because data may have changed
     }
   }
 

src/main/java/org/apache/ibatis/session/Configuration.java

@@ -141,7 +141,6 @@ public Configuration() {
     typeAliasRegistry.registerAlias("WEAK", WeakCache.class.getName());
 
     typeAliasRegistry.registerAlias("VENDOR", VendorDatabaseIdProvider.class.getName());
-
   }
 
   public String getDatabaseId() {
@@ -356,6 +355,10 @@ public Executor newExecutor(Transaction transaction) {
   }
 
   public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
+    return newExecutor(transaction, defaultExecutorType, false);
+  }
+    
+  public Executor newExecutor(Transaction transaction, ExecutorType executorType, boolean autoCommit) {
     executorType = executorType == null ? defaultExecutorType : executorType;
     executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
     Executor executor;
@@ -367,7 +370,7 @@ public Executor newExecutor(Transaction transaction, ExecutorType executorType)
       executor = new SimpleExecutor(this, transaction);
     }
     if (cacheEnabled) {
-      executor = new CachingExecutor(executor);
+      executor = new CachingExecutor(executor, autoCommit);
     }
     executor = (Executor) interceptorChain.pluginAll(executor);
     return executor;

src/main/java/org/apache/ibatis/session/defaults/DefaultSqlSessionFactory.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2009-2011 The MyBatis Team
+ *    Copyright 2009-2012 The MyBatis Team
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -34,11 +34,9 @@
 public class DefaultSqlSessionFactory implements SqlSessionFactory {
 
   private final Configuration configuration;
-  private final TransactionFactory managedTransactionFactory;
 
   public DefaultSqlSessionFactory(Configuration configuration) {
     this.configuration = configuration;
-    this.managedTransactionFactory = new ManagedTransactionFactory();
   }
 
   public SqlSession openSession() {
@@ -83,7 +81,7 @@ private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionI
       final Environment environment = configuration.getEnvironment();
       final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
       tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
-      final Executor executor = configuration.newExecutor(tx, execType);
+      final Executor executor = configuration.newExecutor(tx, execType, autoCommit);
       return new DefaultSqlSession(configuration, executor);
     } catch (Exception e) {
       closeTransaction(tx); // may have fetched a connection so lets call close()
@@ -98,7 +96,7 @@ private SqlSession openSessionFromConnection(ExecutorType execType, Connection c
       final Environment environment = configuration.getEnvironment();
       final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
       final Transaction tx = transactionFactory.newTransaction(connection);
-      final Executor executor = configuration.newExecutor(tx, execType);
+      final Executor executor = configuration.newExecutor(tx, execType, connection.getAutoCommit());
       return new DefaultSqlSession(configuration, executor);
     } catch (Exception e) {
       throw ExceptionFactory.wrapException("Error opening session.  Cause: " + e, e);
@@ -109,7 +107,7 @@ private SqlSession openSessionFromConnection(ExecutorType execType, Connection c
 
   private TransactionFactory getTransactionFactoryFromEnvironment(Environment environment) {
     if (environment == null || environment.getTransactionFactory() == null) {
-      return managedTransactionFactory;
+      return new ManagedTransactionFactory();
     }
     return environment.getTransactionFactory();
   }
@@ -125,4 +123,3 @@ private void closeTransaction(Transaction tx) {
   }
 
 }
-