/**
*
* Copyright 2004 The Apache Software Foundation
*
* 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.
*/
package org.apache.geronimo.transaction.context;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import javax.resource.spi.XATerminator;
import javax.transaction.InvalidTransactionException;
import javax.transaction.NotSupportedException;
import javax.transaction.Status;
import javax.transaction.SystemException;
import javax.transaction.Transaction;
import javax.transaction.TransactionManager;
import javax.transaction.xa.XAException;
import javax.transaction.xa.XAResource;
import javax.transaction.xa.Xid;
import org.apache.geronimo.gbean.GBeanInfo;
import org.apache.geronimo.gbean.GBeanInfoBuilder;
import org.apache.geronimo.j2ee.j2eeobjectnames.NameFactory;
import org.apache.geronimo.transaction.ExtendedTransactionManager;
import org.apache.geronimo.transaction.ImportedTransactionActiveException;
import org.apache.geronimo.transaction.XAWork;
import org.apache.geronimo.transaction.manager.XidImporter;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* @version $Rev: 156292 $ $Date: 2005-03-05 18:48:02 -0800 (Sat, 05 Mar 2005) $
*/
public class TransactionContextManager implements XATerminator, XAWork {
private static final Log log = LogFactory.getLog(TransactionContextManager.class);
private static final boolean NOT_IN_RECOVERY = false;
private static final boolean IN_RECOVERY = true;
private ThreadLocal CONTEXT = new ThreadLocal();
private final ExtendedTransactionManager transactionManager;
private final XidImporter importer;
private final Map importedTransactions = new HashMap();
private boolean recoveryState = NOT_IN_RECOVERY;
//use as reference endpoint.
public TransactionContextManager() {
this(null, null);
}
public TransactionContextManager(ExtendedTransactionManager transactionManager, XidImporter importer) {
this.transactionManager = transactionManager;
this.importer = importer;
}
public TransactionManager getTransactionManager() {
return transactionManager;
}
public void setTransactionTimeout(int timeoutSeconds) throws SystemException {
transactionManager.setTransactionTimeout(timeoutSeconds);
}
public TransactionContext getContext() {
return (TransactionContext) CONTEXT.get();
}
public void setContext(TransactionContext transactionContext) {
CONTEXT.set(transactionContext);
}
public TransactionContext newContainerTransactionContext() throws NotSupportedException, SystemException {
ContainerTransactionContext transactionContext = new ContainerTransactionContext(transactionManager);
setContext(transactionContext);
return transactionContext;
}
public TransactionContext newBeanTransactionContext(long transactionTimeoutMilliseconds) throws NotSupportedException, SystemException {
TransactionContext ctx = getContext();
if (ctx instanceof UnspecifiedTransactionContext == false) {
throw new NotSupportedException("Previous Transaction has not been committed");
}
UnspecifiedTransactionContext oldContext = (UnspecifiedTransactionContext) ctx;
BeanTransactionContext transactionContext = new BeanTransactionContext(transactionManager, oldContext);
oldContext.suspend();
try {
transactionContext.begin(transactionTimeoutMilliseconds);
} catch (SystemException e) {
oldContext.resume();
throw e;
} catch (NotSupportedException e) {
oldContext.resume();
throw e;
}
setContext(transactionContext);
return transactionContext;
}
public TransactionContext newUnspecifiedTransactionContext() {
UnspecifiedTransactionContext transactionContext = new UnspecifiedTransactionContext();
setContext(transactionContext);
return transactionContext;
}
public TransactionContext suspendBeanTransactionContext() throws SystemException {
// suspend the exisiting unspecified transaction context
TransactionContext callerContext = getContext();
if (!(callerContext instanceof BeanTransactionContext)) {
throw new SystemException("Caller context is not a bean managed transaction context");
}
BeanTransactionContext beanContext = ((BeanTransactionContext) callerContext);
// update the old context in the bean context
UnspecifiedTransactionContext oldContext = beanContext.getOldContext();
beanContext.setOldContext(null);
// suspend the bean context
try {
beanContext.suspend();
return beanContext;
} catch (SystemException e) {
if (beanContext.isActive()) {
try {
beanContext.rollback();
} catch (SystemException e1) {
log.warn("Unable to rollback transaction", e);
}
}
throw e;
} finally {
// always resume the old transaction
setContext(oldContext);
oldContext.resume();
setContext(oldContext);
}
}
public void resumeBeanTransactionContext(TransactionContext context) throws SystemException, InvalidTransactionException {
if (!(context instanceof BeanTransactionContext)) {
throw new InvalidTransactionException("Context is not a bean managed transaction context");
}
if (!context.isActive()) {
throw new InvalidTransactionException("Context is not active");
}
BeanTransactionContext beanContext = ((BeanTransactionContext) context);
// suspend the exisiting unspecified transaction context
TransactionContext callerContext = getContext();
if (!(callerContext instanceof UnspecifiedTransactionContext)) {
throw new InvalidTransactionException("Caller context is not an unspecified transaction context");
}
callerContext.suspend();
try {
beanContext.setOldContext((UnspecifiedTransactionContext) callerContext);
context.resume();
setContext(context);
} catch (SystemException e) {
if (beanContext.isActive()) {
try {
beanContext.rollback();
} catch (SystemException e1) {
log.warn("Unable to rollback transaction", e);
}
}
beanContext.setOldContext(null);
callerContext.resume();
throw e;
} catch (InvalidTransactionException e) {
if (beanContext.isActive()) {
try {
beanContext.rollback();
} catch (SystemException e1) {
log.warn("Unable to rollback transaction", e);
}
}
beanContext.setOldContext(null);
callerContext.resume();
throw e;
}
}
public int getStatus() throws SystemException {
return transactionManager.getStatus();
}
public void setRollbackOnly() throws SystemException {
transactionManager.setRollbackOnly();
}
/**
* @see javax.resource.spi.XATerminator#commit(javax.transaction.xa.Xid, boolean)
*/
public void commit(Xid xid, boolean onePhase) throws XAException {
ContainerTransactionContext containerTransactionContext;
synchronized (importedTransactions) {
containerTransactionContext = (ContainerTransactionContext) importedTransactions.remove(xid);
}
if (containerTransactionContext == null) {
throw new XAException("No imported transaction for xid: " + xid);
}
try {
int status = containerTransactionContext.getTransaction().getStatus();
assert status == Status.STATUS_ACTIVE || status == Status.STATUS_PREPARED: "invalid status: " + status;
} catch (SystemException e) {
throw new XAException();
}
importer.commit(containerTransactionContext.getTransaction(), onePhase);
}
/**
* @see javax.resource.spi.XATerminator#forget(javax.transaction.xa.Xid)
*/
public void forget(Xid xid) throws XAException {
ContainerTransactionContext containerTransactionContext;
synchronized (importedTransactions) {
containerTransactionContext = (ContainerTransactionContext) importedTransactions.remove(xid);
}
if (containerTransactionContext == null) {
throw new XAException("No imported transaction for xid: " + xid);
}
//todo is there a correct status test here?
// try {
// int status = tx.getStatus();
// assert status == Status.STATUS_ACTIVE || status == Status.STATUS_PREPARED;
// } catch (SystemException e) {
// throw new XAException();
// }
importer.forget(containerTransactionContext.getTransaction());
}
/**
* @see javax.resource.spi.XATerminator#prepare(javax.transaction.xa.Xid)
*/
public int prepare(Xid xid) throws XAException {
ContainerTransactionContext containerTransactionContext;
synchronized (importedTransactions) {
containerTransactionContext = (ContainerTransactionContext) importedTransactions.get(xid);
}
if (containerTransactionContext == null) {
throw new XAException("No imported transaction for xid: " + xid);
}
Transaction tx = containerTransactionContext.getTransaction();
try {
int status = tx.getStatus();
assert status == Status.STATUS_ACTIVE;
} catch (SystemException e) {
throw new XAException();
}
return importer.prepare(tx);
}
/**
* @see javax.resource.spi.XATerminator#recover(int)
*/
public Xid[] recover(int flag) throws XAException {
if (recoveryState == NOT_IN_RECOVERY) {
if ((flag & XAResource.TMSTARTRSCAN) == 0) {
throw new XAException(XAException.XAER_PROTO);
}
recoveryState = IN_RECOVERY;
}
if ((flag & XAResource.TMENDRSCAN) != 0) {
recoveryState = NOT_IN_RECOVERY;
}
//we always return all xids in first call.
//calling "startrscan" repeatedly starts at beginning of list again.
if ((flag & XAResource.TMSTARTRSCAN) != 0) {
Map recoveredXidMap = transactionManager.getExternalXids();
Xid[] recoveredXids = new Xid[recoveredXidMap.size()];
int i = 0;
synchronized (importedTransactions) {
for (Iterator iterator = recoveredXidMap.entrySet().iterator(); iterator.hasNext();) {
Map.Entry entry = (Map.Entry) iterator.next();
Xid xid = (Xid) entry.getKey();
recoveredXids[i++] = xid;
ContainerTransactionContext containerTransactionContext = new ContainerTransactionContext(transactionManager, (Transaction) entry.getValue());
importedTransactions.put(xid, containerTransactionContext);
}
}
return recoveredXids;
} else {
return new Xid[0];
}
}
/**
* @see javax.resource.spi.XATerminator#rollback(javax.transaction.xa.Xid)
*/
public void rollback(Xid xid) throws XAException {
ContainerTransactionContext containerTransactionContext;
synchronized (importedTransactions) {
containerTransactionContext = (ContainerTransactionContext) importedTransactions.remove(xid);
}
if (containerTransactionContext == null) {
throw new XAException("No imported transaction for xid: " + xid);
}
Transaction tx = containerTransactionContext.getTransaction();
try {
int status = tx.getStatus();
assert status == Status.STATUS_ACTIVE || status == Status.STATUS_PREPARED;
} catch (SystemException e) {
throw new XAException();
}
importer.rollback(tx);
}
//XAWork implementation
public void begin(Xid xid, long txTimeoutMillis) throws XAException, InvalidTransactionException, SystemException, ImportedTransactionActiveException {
ContainerTransactionContext containerTransactionContext;
synchronized (importedTransactions) {
containerTransactionContext = (ContainerTransactionContext) importedTransactions.get(xid);
if (containerTransactionContext == null) {
//this does not associate tx with current thread.
Transaction transaction = importer.importXid(xid, txTimeoutMillis);
containerTransactionContext = new ContainerTransactionContext(transactionManager, transaction);
importedTransactions.put(xid, containerTransactionContext);
} else {
if (containerTransactionContext.isThreadAssociated()) {
throw new ImportedTransactionActiveException(xid);
}
}
containerTransactionContext.resume();
}
setContext(containerTransactionContext);
}
public void end(Xid xid) throws XAException, SystemException {
setContext(null);
synchronized (importedTransactions) {
ContainerTransactionContext containerTransactionContext = (ContainerTransactionContext) importedTransactions.get(xid);
if (containerTransactionContext == null) {
throw new XAException("No imported transaction for xid: " + xid);
}
if (!containerTransactionContext.isThreadAssociated()) {
throw new XAException("tx not active for containerTransactionContext: " + containerTransactionContext + ", xid: " + xid);
}
containerTransactionContext.suspend();
}
}
public static final GBeanInfo GBEAN_INFO;
static {
GBeanInfoBuilder infoFactory = new GBeanInfoBuilder(TransactionContextManager.class, NameFactory.JTA_RESOURCE);
infoFactory.addOperation("getTransactionManager");
infoFactory.addOperation("getContext");
infoFactory.addOperation("setContext", new Class[]{TransactionContext.class});
infoFactory.addOperation("newContainerTransactionContext");
infoFactory.addOperation("newBeanTransactionContext", new Class[] {long.class});
infoFactory.addOperation("newUnspecifiedTransactionContext");
infoFactory.addOperation("resumeBeanTransactionContext", new Class[] {TransactionContext.class});
infoFactory.addOperation("suspendBeanTransactionContext");
infoFactory.addOperation("getStatus");
infoFactory.addOperation("setRollbackOnly");
infoFactory.addOperation("setTransactionTimeout", new Class[] {int.class});
infoFactory.addReference("TransactionManager", ExtendedTransactionManager.class, NameFactory.JTA_RESOURCE);
infoFactory.addReference("XidImporter", XidImporter.class, NameFactory.JTA_RESOURCE);
infoFactory.addInterface(XATerminator.class);
infoFactory.addInterface(XAWork.class);
infoFactory.setConstructor(new String[]{"TransactionManager", "XidImporter"});
GBEAN_INFO = infoFactory.getBeanInfo();
}
public static GBeanInfo getGBeanInfo() {
return GBEAN_INFO;
}
}