ehcache

net.sf.ehcache.transaction.xa
Interface EhcacheXAResource

All Superinterfaces:
javax.transaction.xa.XAResource
All Known Implementing Classes:
EhcacheXAResourceImpl

public interface EhcacheXAResource
extends javax.transaction.xa.XAResource

EhcacheXAResource represents an Ehcache instance. It will provide the interface between the TransactionManager and the XATransactionalStore instance backing the transactional cache.

Author:
Nabib El-Rahman, Alex Snaps

Field Summary
 
Fields inherited from interface javax.transaction.xa.XAResource
TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY
 
Method Summary
 void addTwoPcExecutionListener(TwoPcExecutionListener listener)
          Add a listener which will be called back according to the 2PC lifecycle
 TransactionContext createTransactionContext()
          Obtain the already associated TransactionContext with the current Transaction, or create a new one should none be there yet.
 java.lang.String getCacheName()
          Getter to the name of the cache wrapped by this XAResource
 TransactionContext getCurrentTransactionContext()
          Gets the current TransactionContext associated with this resource
 
Methods inherited from interface javax.transaction.xa.XAResource
commit, end, forget, getTransactionTimeout, isSameRM, prepare, recover, rollback, setTransactionTimeout, start
 

Method Detail

addTwoPcExecutionListener

void addTwoPcExecutionListener(TwoPcExecutionListener listener)
Add a listener which will be called back according to the 2PC lifecycle

Parameters:
listener - the TwoPcExecutionListener

getCacheName

java.lang.String getCacheName()
Getter to the name of the cache wrapped by this XAResource

Returns:
Ehcache.getName() value

createTransactionContext

TransactionContext createTransactionContext()
                                            throws javax.transaction.SystemException,
                                                   javax.transaction.RollbackException
Obtain the already associated TransactionContext with the current Transaction, or create a new one should none be there yet.

Returns:
The associated Transaction associated TransactionContext
Throws:
javax.transaction.SystemException - Thrown if the associated transaction manager encounters an unexpected error condition.
javax.transaction.RollbackException - Thrown if the resource has to be enlisted with the transaction, while it is marked for rollback only.

getCurrentTransactionContext

TransactionContext getCurrentTransactionContext()
Gets the current TransactionContext associated with this resource

Returns:
the current TransactionContext, or null if none

ehcache

true