com.sleepycat.je

Class XAEnvironment

java.lang.Object

com.sleepycat.je.Environment

com.sleepycat.je.XAEnvironment

All Implemented Interfaces:

javax.transaction.xa.XAResource

public class XAEnvironment
extends Environment
implements javax.transaction.xa.XAResource

An Environment that implements XAResource. If JE is used in an XA environment, this class should be used instead of Environment so that appropriate XA functions are available.

Field Summary

Fields inherited from class com.sleepycat.je.Environment

CHECKPOINTER_NAME, CLEANER_NAME, envImpl, INCOMP_NAME

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

Constructors

Constructor and Description
XAEnvironment(java.io.File envHome, EnvironmentConfig configuration) Create a database environment handle.

Method Summary

Methods

Modifier and Type	Method and Description
void	commit(javax.transaction.xa.Xid xid, boolean ignore)
void	end(javax.transaction.xa.Xid xid, int flags)
void	forget(javax.transaction.xa.Xid xid)
int	getTransactionTimeout()
Transaction	getXATransaction(javax.transaction.xa.Xid xid) Used to get the Transaction object given an XA Xid.
boolean	isSameRM(javax.transaction.xa.XAResource rm)
int	prepare(javax.transaction.xa.Xid xid)
javax.transaction.xa.Xid[]	recover(int flags)
void	rollback(javax.transaction.xa.Xid xid)
boolean	setTransactionTimeout(int timeout)
void	setXATransaction(javax.transaction.xa.Xid xid, Transaction txn) Used to set the Transaction object for an XA Xid.
void	start(javax.transaction.xa.Xid xid, int flags)

Methods inherited from class com.sleepycat.je.Environment

addReferringHandle, addReferringHandle, beginTransaction, checkEnv, checkHandleIsValid, checkpoint, cleanLog, close, compress, evictMemory, getConfig, getDatabaseNames, getDefaultTxnConfig, getEnvironmentImpl, getHome, getLockStats, getMemoryUsage, getMutableConfig, getStats, getThreadTransaction, getTransactionStats, openDatabase, openLocalInternalDatabase, openSecondaryDatabase, removeDatabase, removeDatabaseInternal, removeReferringHandle, removeReferringHandle, renameDatabase, scanLog, setMutableConfig, setThreadTransaction, sync, truncateDatabase, truncateDatabaseInternal, upgrade, verify

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XAEnvironment

public XAEnvironment(java.io.File envHome,
             EnvironmentConfig configuration)
              throws DatabaseException

Create a database environment handle.

Parameters:

envHome - The database environment's home directory.

configuration - The database environment attributes. If null, default attributes are used.

Throws:

DatabaseException

Method Detail

getXATransaction

public Transaction getXATransaction(javax.transaction.xa.Xid xid)
                             throws DatabaseException

Used to get the Transaction object given an XA Xid.

Throws:

DatabaseException

setXATransaction

public void setXATransaction(javax.transaction.xa.Xid xid,
                    Transaction txn)
                      throws DatabaseException

Used to set the Transaction object for an XA Xid. Public for tests.

Throws:

DatabaseException

commit

public void commit(javax.transaction.xa.Xid xid,
          boolean ignore)
            throws javax.transaction.xa.XAException

Specified by:

commit in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

end

public void end(javax.transaction.xa.Xid xid,
       int flags)
         throws javax.transaction.xa.XAException

Specified by:

end in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

forget

public void forget(javax.transaction.xa.Xid xid)
            throws javax.transaction.xa.XAException

Specified by:

forget in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

isSameRM

public boolean isSameRM(javax.transaction.xa.XAResource rm)
                 throws javax.transaction.xa.XAException

Specified by:

isSameRM in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

prepare

public int prepare(javax.transaction.xa.Xid xid)
            throws javax.transaction.xa.XAException

Specified by:

prepare in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

recover

public javax.transaction.xa.Xid[] recover(int flags)
                                   throws javax.transaction.xa.XAException

Specified by:

recover in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

rollback

public void rollback(javax.transaction.xa.Xid xid)
              throws javax.transaction.xa.XAException

Specified by:

rollback in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

getTransactionTimeout

public int getTransactionTimeout()
                          throws javax.transaction.xa.XAException

Specified by:

getTransactionTimeout in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

setTransactionTimeout

public boolean setTransactionTimeout(int timeout)
                              throws javax.transaction.xa.XAException

Specified by:

setTransactionTimeout in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

start

public void start(javax.transaction.xa.Xid xid,
         int flags)
           throws javax.transaction.xa.XAException

Specified by:

start in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException