[jOOQ#5377] Add alternative TransactionProvider that implements Threa…

…dLocal semantics

jOOQ/src/main/java/org/jooq/DSLContext.java

@@ -84,11 +84,13 @@
 import org.jooq.conf.ParamType;
 import org.jooq.conf.Settings;
 import org.jooq.conf.StatementType;
+import org.jooq.exception.ConfigurationException;
 import org.jooq.exception.DataAccessException;
 import org.jooq.exception.InvalidResultException;
 import org.jooq.exception.MappingException;
 import org.jooq.exception.TooManyRowsException;
 import org.jooq.impl.DSL;
+import org.jooq.impl.ThreadLocalTransactionProvider;
 import org.jooq.tools.jdbc.MockCallable;
 import org.jooq.tools.jdbc.MockDataProvider;
 import org.jooq.tools.jdbc.MockRunnable;
@@ -214,6 +216,18 @@ public interface DSLContext extends Scope , AutoCloseable  {
      */
     <T> T transactionResult(TransactionalCallable<T> transactional);
 
+    /**
+     * Run a {@link ThreadLocalTransactionalRunnable} in the context of this
+     * <code>DSLContext</code>'s underlying {@link #configuration()}'s
+     * {@link ThreadLocalTransactionProvider}.
+     *
+     * @param transactional The transactional code
+     * @throws ConfigurationException if the underlying
+     *             {@link Configuration#transactionProvider()} is not a
+     *             {@link ThreadLocalTransactionProvider}.
+     */
+    <T> T transactionResult(ThreadLocalTransactionalCallable<T> transactional) throws ConfigurationException;
+
     /**
      * Run a {@link TransactionalRunnable} in the context of this
      * <code>DSLContext</code>'s underlying {@link #configuration()}'s
@@ -223,6 +237,18 @@ public interface DSLContext extends Scope , AutoCloseable  {
      */
     void transaction(TransactionalRunnable transactional);
 
+    /**
+     * Run a {@link ThreadLocalTransactionalRunnable} in the context of this
+     * <code>DSLContext</code>'s underlying {@link #configuration()}'s
+     * {@link ThreadLocalTransactionProvider}.
+     *
+     * @param transactional The transactional code
+     * @throws ConfigurationException if the underlying
+     *             {@link Configuration#transactionProvider()} is not a
+     *             {@link ThreadLocalTransactionProvider}.
+     */
+    void transaction(ThreadLocalTransactionalRunnable transactional) throws ConfigurationException;
+
 
 
     /**
@@ -238,8 +264,9 @@ public interface DSLContext extends Scope , AutoCloseable  {
      *
      * @param transactional The transactional code
      * @return The transactional outcome
+     * @throws ConfigurationException If this is run with a {@link ThreadLocalTransactionProvider}.
      */
-    <T> CompletionStage<T> transactionResultAsync(TransactionalCallable<T> transactional);
+    <T> CompletionStage<T> transactionResultAsync(TransactionalCallable<T> transactional) throws ConfigurationException;
 
     /**
      * Run a {@link TransactionalRunnable} asynchronously.
@@ -253,8 +280,9 @@ public interface DSLContext extends Scope , AutoCloseable  {
      * {@link Configuration#executorProvider()}.
      *
      * @param transactional The transactional code
+     * @throws ConfigurationException If this is run with a {@link ThreadLocalTransactionProvider}.
      */
-    CompletionStage<Void> transactionAsync(TransactionalRunnable transactional);
+    CompletionStage<Void> transactionAsync(TransactionalRunnable transactional) throws ConfigurationException;
 
     /**
      * Run a {@link TransactionalCallable} asynchronously.
@@ -268,8 +296,9 @@ public interface DSLContext extends Scope , AutoCloseable  {
      *
      * @param transactional The transactional code
      * @return The transactional outcome
+     * @throws ConfigurationException If this is run with a {@link ThreadLocalTransactionProvider}.
      */
-    <T> CompletionStage<T> transactionResultAsync(Executor executor, TransactionalCallable<T> transactional);
+    <T> CompletionStage<T> transactionResultAsync(Executor executor, TransactionalCallable<T> transactional) throws ConfigurationException;
 
     /**
      * Run a {@link TransactionalRunnable} asynchronously.
@@ -282,8 +311,9 @@ public interface DSLContext extends Scope , AutoCloseable  {
      * {@link Executor}.
      *
      * @param transactional The transactional code
+     * @throws ConfigurationException If this is run with a {@link ThreadLocalTransactionProvider}.
      */
-    CompletionStage<Void> transactionAsync(Executor executor, TransactionalRunnable transactional);
+    CompletionStage<Void> transactionAsync(Executor executor, TransactionalRunnable transactional) throws ConfigurationException;
 
 
 

jOOQ/src/main/java/org/jooq/ThreadLocalTransactionalCallable.java

@@ -0,0 +1,69 @@
+/**
+ * Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Other licenses:
+ * -----------------------------------------------------------------------------
+ * Commercial licenses for this work are available. These replace the above
+ * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
+ * database integrations.
+ *
+ * For more information, please visit: http://www.jooq.org/licenses
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ */
+package org.jooq;
+
+/**
+ * An <code>FunctionalInterface</code> that wraps transactional code.
+ *
+ * @author Lukas Eder
+ */
+
+@FunctionalInterface
+
+public interface ThreadLocalTransactionalCallable<T> {
+
+    /**
+     * Run the transactional code.
+     * <p>
+     * If this method completes normally, and this is not a nested transaction,
+     * then the transaction will be committed. If this method completes with an
+     * exception, then the transaction is rolled back to the beginning of this
+     * <code>ThreadLocalTransactionalCallable</code>.
+     *
+     * @return The outcome of the transaction.
+     * @throws Exception Any exception that will cause a rollback of the code
+     *             contained in this transaction. If this is a nested
+     *             transaction, the rollback may be performed only to the state
+     *             before executing this
+     *             <code>ThreadLocalTransactionalCallable</code>.
+     */
+    T run() throws Exception;
+}

jOOQ/src/main/java/org/jooq/ThreadLocalTransactionalRunnable.java

@@ -0,0 +1,68 @@
+/**
+ * Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Other licenses:
+ * -----------------------------------------------------------------------------
+ * Commercial licenses for this work are available. These replace the above
+ * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
+ * database integrations.
+ *
+ * For more information, please visit: http://www.jooq.org/licenses
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ */
+package org.jooq;
+
+/**
+ * An <code>FunctionalInterface</code> that wraps transactional code.
+ *
+ * @author Lukas Eder
+ */
+
+@FunctionalInterface
+
+public interface ThreadLocalTransactionalRunnable {
+
+    /**
+     * Run the transactional code.
+     * <p>
+     * If this method completes normally, and this is not a nested transaction,
+     * then the transaction will be committed. If this method completes with an
+     * exception, then the transaction is rolled back to the beginning of this
+     * <code>ThreadLocalTransactionalRunnable</code>.
+     *
+     * @throws Exception Any exception that will cause a rollback of the code
+     *             contained in this transaction. If this is a nested
+     *             transaction, the rollback may be performed only to the state
+     *             before executing this
+     *             <code>ThreadLocalTransactionalRunnable</code>.
+     */
+    void run() throws Exception;
+}

jOOQ/src/main/java/org/jooq/exception/ConfigurationException.java

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
+ * All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Other licenses:
+ * -----------------------------------------------------------------------------
+ * Commercial licenses for this work are available. These replace the above
+ * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
+ * database integrations.
+ *
+ * For more information, please visit: http://www.jooq.org/licenses
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ */
+package org.jooq.exception;
+
+import org.jooq.Configuration;
+
+/**
+ * The {@link Configuration} was set up in a way that does not allow for a
+ * particular operation.
+ *
+ * @author Lukas Eder
+ */
+public class ConfigurationException extends DataAccessException {
+
+    /**
+     * Generated UID
+     */
+    private static final long serialVersionUID = -6460945824599280420L;
+
+    /**
+     * Constructor for ConfigurationException.
+     *
+     * @param message the detail message
+     */
+    public ConfigurationException(String message) {
+        super(message);
+    }
+}

jOOQ/src/main/java/org/jooq/impl/DefaultConfiguration.java

@@ -77,6 +77,7 @@
 import org.jooq.VisitListenerProvider;
 import org.jooq.conf.Settings;
 import org.jooq.conf.SettingsTools;
+import org.jooq.exception.ConfigurationException;
 
 /**
  * A default implementation for configurations within a {@link DSLContext}, if no
@@ -713,9 +714,16 @@ public final Configuration set(DataSource newDataSource) {
 
     @Override
     public final Configuration set(ConnectionProvider newConnectionProvider) {
-        this.connectionProvider = newConnectionProvider != null
-            ? newConnectionProvider
-            : new NoConnectionProvider();
+        if (newConnectionProvider != null) {
+            if (transactionProvider instanceof ThreadLocalTransactionProvider &&
+              !(newConnectionProvider instanceof ThreadLocalConnectionProvider))
+                throw new ConfigurationException("Cannot override ConnectionProvider when Configuration contains a ThreadLocalTransactionProvider");
+
+            this.connectionProvider = newConnectionProvider;
+        }
+        else {
+            this.connectionProvider = new NoConnectionProvider();
+        }
 
         return this;
     }
@@ -733,9 +741,15 @@ public final Configuration set(ExecutorProvider newExecutorProvider) {
 
     @Override
     public final Configuration set(TransactionProvider newTransactionProvider) {
-        this.transactionProvider = newTransactionProvider != null
-            ? newTransactionProvider
-            : new NoTransactionProvider();
+        if (newTransactionProvider != null) {
+            this.transactionProvider = newTransactionProvider;
+
+            if (newTransactionProvider instanceof ThreadLocalTransactionProvider)
+                this.connectionProvider = ((ThreadLocalTransactionProvider) newTransactionProvider).connection;
+        }
+        else {
+            this.transactionProvider = new NoTransactionProvider();
+        }
 
         return this;
     }
@@ -927,9 +941,13 @@ public final void setSettings(Settings newSettings) {
     @Override
     public final ConnectionProvider connectionProvider() {
 
-        // [#3229] If we're currently in a transaction, return that transaction's
+        // [#3229] [#5377] If we're currently in a transaction, return that transaction's
         // local DefaultConnectionProvider, not the one from this configuration
-        ConnectionProvider transactional = (ConnectionProvider) data(DATA_DEFAULT_TRANSACTION_PROVIDER_CONNECTION);
+        TransactionProvider tp = transactionProvider();
+        ConnectionProvider transactional = tp instanceof ThreadLocalTransactionProvider
+            ? ((ThreadLocalTransactionProvider) tp).connection
+            : (ConnectionProvider) data(DATA_DEFAULT_TRANSACTION_PROVIDER_CONNECTION);
+
         return transactional == null ? connectionProvider : transactional;
     }