com.ibm.fhir.persistence.jdbc.connection.FHIRTestTransactionAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fhir-persistence-jdbc Show documentation
There is a newer version: 4.11.1
Show newest version
/*
 * (C) Copyright IBM Corp. 2020
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package com.ibm.fhir.persistence.jdbc.connection;

import java.sql.Connection;
import java.util.logging.Level;
import java.util.logging.Logger;

import com.ibm.fhir.database.utils.api.IConnectionProvider;
import com.ibm.fhir.database.utils.api.ITransaction;
import com.ibm.fhir.database.utils.transaction.SimpleTransactionProvider;
import com.ibm.fhir.persistence.FHIRPersistenceTransaction;
import com.ibm.fhir.persistence.exception.FHIRPersistenceException;
import com.ibm.fhir.persistence.jdbc.exception.FHIRPersistenceDataAccessException;

/**
 * Hides the logic behind obtaining a JDBC {@link Connection} from the DAO code.
 * 
 * Use by unit tests or other scenarios where connections are obtained using an
 * IConnectionProvider implementation, outside the scope of a JEE container.
 * Transactions are managed with the help of the SimpleTransactionProvider and
 * wrapped by this class, meaning we have a uniform interface for handling
 * transactions across JEE and unit-test scenarios.
 * 
 */
public class FHIRTestTransactionAdapter implements FHIRPersistenceTransaction {
    private static final Logger log = Logger.getLogger(FHIRDbTestConnectionStrategy.class.getName());
    
    // Provides connections when outside of a container
    private final IConnectionProvider connectionProvider;
    
    // Support transactions for the persistence unit tests
    private final SimpleTransactionProvider transactionProvider;
    
    // Just in case we have nesting issues, use ThreadLocal to track the current tx
    private final ThreadLocal currentTransaction = new ThreadLocal<>();
    
    // Was this instance responsible for starting the transaction
    private boolean startedByThis;
    
    // support nesting by tracking the number of begin/end requests
    private int startCount;
        
    /**
     * Public constructor
     * @param cp
     */
    public FHIRTestTransactionAdapter(IConnectionProvider cp) {
        this.connectionProvider = cp;

        // provide transaction support for our tests
        this.transactionProvider = new SimpleTransactionProvider(this.connectionProvider);
    }

    @Override
    public void begin() throws FHIRPersistenceException {
        if (currentTransaction.get() == null) {
            // allocate a new transaction
            this.currentTransaction.set(this.transactionProvider.getTransaction());
            this.startedByThis = true;
        }
        
        // add to the start request counter every time. We only close when this
        // counter reaches 0.
        startCount++;
    }

    @Override
    public void end() throws FHIRPersistenceException {
        if (currentTransaction.get() == null) {
            throw new FHIRPersistenceDataAccessException("Transaction not started");
        }
        
        try {
            // only end it if we started it
            if (startedByThis && --startCount == 0) {
                this.currentTransaction.get().close();
            }
        } catch (Throwable x) {
            // translate to a FHIRPersistenceException
            FHIRPersistenceException fx = new FHIRPersistenceException("Unexpected error while committing a transaction.");
            log.log(Level.SEVERE, fx.getMessage(), x);
            throw fx;
        } finally {
            this.currentTransaction.set(null);
            this.startedByThis = false;
        }
    }

    @Override
    public void setRollbackOnly() throws FHIRPersistenceException {
        if (currentTransaction.get() == null) {
            throw new FHIRPersistenceDataAccessException("Transaction not started");
        }

        // always mark the transaction for rollback, even if not started by this
        this.currentTransaction.get().setRollbackOnly();
    }
}