org.jooq.impl.ThreadLocalTransactionProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation
There is a newer version: 3.19.9
/*
 * 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.impl;

import static org.jooq.impl.Tools.DataKey.DATA_DEFAULT_TRANSACTION_PROVIDER_CONNECTION;

import java.sql.Connection;
import java.sql.Savepoint;
import java.util.ArrayDeque;
import java.util.Deque;

import org.jooq.Configuration;
import org.jooq.ConnectionProvider;
import org.jooq.TransactionContext;
import org.jooq.TransactionProvider;

/**
 * A {@link TransactionProvider} that implements thread-bound transaction
 * semantics.
 * 
 * Use this TransactionProvider if your transactions are
 * thread-bound, meaning that a transaction and its underlying
 * {@link Connection} will never leave the thread that started the transaction.
 * 
 * When this TransactionProvider is used, users must pass their
 * custom {@link ConnectionProvider} implementations to this
 * TransactionProvider, instead of passing it to the
 * {@link Configuration}.
 *
 * @author Lukas Eder
 */
public class ThreadLocalTransactionProvider implements TransactionProvider {

    final DefaultTransactionProvider        delegateTransactionProvider;
    final ThreadLocalConnectionProvider     localConnectionProvider;
    final ThreadLocal           localTxConnection;
    final ThreadLocal> localConfigurations;

    public ThreadLocalTransactionProvider(ConnectionProvider provider) {
        this(provider, true);
    }

    /**
     * @param nested Whether nested transactions via {@link Savepoint}s are
     *            supported.
     */
    public ThreadLocalTransactionProvider(ConnectionProvider connectionProvider, boolean nested) {
        this.localConnectionProvider = new ThreadLocalConnectionProvider(connectionProvider);
        this.delegateTransactionProvider = new DefaultTransactionProvider(localConnectionProvider, nested);
        this.localConfigurations = new ThreadLocal>();
        this.localTxConnection = new ThreadLocal();
    }

    @Override
    public void begin(TransactionContext ctx) {
        delegateTransactionProvider.begin(ctx);
        configurations().push(ctx.configuration());
        if (delegateTransactionProvider.nestingLevel(ctx.configuration()) == 1)
            localTxConnection.set(((DefaultConnectionProvider) ctx.configuration().data(DATA_DEFAULT_TRANSACTION_PROVIDER_CONNECTION)).connection);
    }

    @Override
    public void commit(TransactionContext ctx) {
        if (delegateTransactionProvider.nestingLevel(ctx.configuration()) == 1)
            localTxConnection.remove();
        configurations().pop();
        delegateTransactionProvider.commit(ctx);
    }

    @Override
    public void rollback(TransactionContext ctx) {
        if (delegateTransactionProvider.nestingLevel(ctx.configuration()) == 1)
            localTxConnection.remove();
        configurations().pop();
        delegateTransactionProvider.rollback(ctx);
    }

    Configuration configuration(Configuration fallback) {
        Deque configurations = configurations();
        return configurations.isEmpty() ? fallback : configurations.peek();
    }

    private Deque configurations() {
        Deque result = localConfigurations.get();

        if (result == null) {
            result = new ArrayDeque();
            localConfigurations.set(result);
        }

        return result;
    }

    final class ThreadLocalConnectionProvider implements ConnectionProvider {

        final ConnectionProvider delegateConnectionProvider;

        public ThreadLocalConnectionProvider(ConnectionProvider delegate) {
            this.delegateConnectionProvider = delegate;
        }

        @Override
        public final Connection acquire() {
            Connection local = localTxConnection.get();

            if (local == null)
                return delegateConnectionProvider.acquire();
            else
                return local;
        }

        @Override
        public final void release(Connection connection) {
            Connection local = localTxConnection.get();

            if (local == null)
                delegateConnectionProvider.release(connection);
            else if (local != connection)
                throw new IllegalStateException(
                    "A different connection was released than the thread-bound one that was expected");
        }
    }
}