tx-control-providers/jpa/tx-control-provider-jpa-xa-plugin-openjpa/src/main/java/org/apache/aries/tx/control/jpa/xa/plugin/openjpa/impl/OpenJPATxControlPlatform.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 WARRANTIESOR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.aries.tx.control.jpa.xa.plugin.openjpa.impl;

import static javax.transaction.Status.STATUS_ACTIVE;
import static javax.transaction.Status.STATUS_COMMITTED;
import static javax.transaction.Status.STATUS_COMMITTING;
import static javax.transaction.Status.STATUS_MARKED_ROLLBACK;
import static javax.transaction.Status.STATUS_NO_TRANSACTION;
import static javax.transaction.Status.STATUS_PREPARING;
import static javax.transaction.Status.STATUS_ROLLEDBACK;
import static javax.transaction.Status.STATUS_ROLLING_BACK;
import static javax.transaction.Status.STATUS_UNKNOWN;

import javax.transaction.HeuristicMixedException;
import javax.transaction.HeuristicRollbackException;
import javax.transaction.InvalidTransactionException;
import javax.transaction.NotSupportedException;
import javax.transaction.RollbackException;
import javax.transaction.Status;
import javax.transaction.Synchronization;
import javax.transaction.SystemException;
import javax.transaction.Transaction;
import javax.transaction.TransactionManager;
import javax.transaction.xa.XAResource;

import org.apache.openjpa.ee.ManagedRuntime;
import org.osgi.service.transaction.control.TransactionContext;
import org.osgi.service.transaction.control.TransactionControl;
import org.osgi.service.transaction.control.TransactionException;
import org.osgi.service.transaction.control.TransactionStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class OpenJPATxControlPlatform implements ManagedRuntime, 
	TransactionManager, Transaction {

	private static final Logger LOGGER = LoggerFactory.getLogger(OpenJPATxControlPlatform.class);
	
	private final ThreadLocal<TransactionControl> txControlToUse;
	
	public OpenJPATxControlPlatform(ThreadLocal<TransactionControl> txControlToUse) {
		this.txControlToUse = txControlToUse;
	}
	
	public TransactionControl getTxControl() {
		TransactionControl transactionControl = txControlToUse.get();
		if(transactionControl == null) {
			throw new TransactionException("A No Transaction Context could not be created because there is no associated Transaction Control");
		}
		return transactionControl;
	}


	@Override
	public void doNonTransactionalWork(Runnable arg0) throws NotSupportedException {
		
		TransactionControl transactionControl = getTxControl();
		boolean activeTransaction = transactionControl.activeTransaction();
		if(activeTransaction) {
			LOGGER.debug("Suspending the active transaction to perform a non-transactional query");
		}
		transactionControl.notSupported(() -> {
			arg0.run();
			return null;
		});
		if(activeTransaction) {
			LOGGER.debug("Resumed the transaction");
		}
	}

	@Override
	public Throwable getRollbackCause() throws Exception {
		return null;
	}

	@Override
	public Object getTransactionKey() throws Exception, SystemException {
		return getTxControl().getCurrentContext().getTransactionKey();
	}

	@Override
	public TransactionManager getTransactionManager() throws Exception {
		return this;
	}

	@Override
	public void setRollbackOnly(Throwable arg0) throws Exception {
		LOGGER.debug("Marking rollback for the transaction due to an exception", arg0);
		getTxControl().setRollbackOnly();
	}

	@Override
	public void setRollbackOnly() throws IllegalStateException, SystemException {
		LOGGER.debug("Marking rollback for the transaction");
		getTxControl().setRollbackOnly();
	}

	@Override
	public int getStatus() throws SystemException {
		TransactionContext currentContext = getTxControl().getCurrentContext();
		if(currentContext != null) {
			return toIntStatus(currentContext.getTransactionStatus());
		}
		return STATUS_NO_TRANSACTION;
	}

	private int toIntStatus(TransactionStatus status) {
		switch(status) {
			case NO_TRANSACTION:
				return STATUS_NO_TRANSACTION;
			case ACTIVE:
				return STATUS_ACTIVE;
			case PREPARING:
				return STATUS_PREPARING;
			case PREPARED:
				return Status.STATUS_PREPARED;
			case COMMITTING:
				return STATUS_COMMITTING;
			case COMMITTED:
				return STATUS_COMMITTED;
			case MARKED_ROLLBACK:
				return STATUS_MARKED_ROLLBACK;
			case ROLLING_BACK:
				return STATUS_ROLLING_BACK;
			case ROLLED_BACK:
				return STATUS_ROLLEDBACK;
			default:
				return STATUS_UNKNOWN;
		}
	}

	@Override
	public Transaction getTransaction() throws SystemException {
		return this;
	}

	@Override
	public boolean delistResource(XAResource xaRes, int flag) throws IllegalStateException, SystemException {
		return false;
	}

	@Override
	public boolean enlistResource(XAResource xaRes) throws IllegalStateException, RollbackException, SystemException {
		getTxControl().getCurrentContext().registerXAResource(xaRes, null);
		return true;
	}

	@Override
	public void registerSynchronization(Synchronization synch)
			throws IllegalStateException, RollbackException, SystemException {
		LOGGER.debug("Registering a synchronization with the current transaction");
		TransactionContext currentContext = getTxControl().getCurrentContext();
		currentContext.preCompletion(synch::beforeCompletion);
		currentContext.postCompletion(status -> synch.afterCompletion(toIntStatus(status)));
	}

	@Override
	public void begin() throws NotSupportedException, SystemException {
		throw new NotSupportedException("The Transaction contol service does not support open scoped work");
	}

	@Override
	public void commit() throws HeuristicMixedException, HeuristicRollbackException, IllegalStateException,
			RollbackException, SecurityException, SystemException {
		throw new SystemException("The Transaction contol service does not support open scoped work");
	}

	@Override
	public void resume(Transaction tobj) throws IllegalStateException, InvalidTransactionException, SystemException {
		throw new SystemException("The Transaction contol service does not support open scoped work");
	}

	@Override
	public void rollback() throws IllegalStateException, SecurityException, SystemException {
		throw new SystemException("The Transaction contol service does not support open scoped work");
	}

	@Override
	public void setTransactionTimeout(int seconds) throws SystemException {
		throw new SystemException("The Transaction contol service does not support open scoped work");
	}

	@Override
	public Transaction suspend() throws SystemException {
		throw new SystemException("The Transaction contol service does not support open scoped work");
	}

}