Package net.sf.ehcache.transaction.xa

Class EhcacheXAResourceImpl

java.lang.Object

net.sf.ehcache.transaction.xa.EhcacheXAResourceImpl

All Implemented Interfaces:

javax.transaction.xa.XAResource, EhcacheXAResource

public class EhcacheXAResourceImpl
extends java.lang.Object
implements EhcacheXAResource

The EhcacheXAResource implementation

Author:

Ludovic Orban

Field Summary

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

Description

EhcacheXAResourceImpl(Ehcache cache, Store underlyingStore, TransactionManagerLookup txnManagerLookup, SoftLockManager softLockManager, TransactionIDFactory transactionIDFactory, ElementValueComparator comparator, org.terracotta.statistics.observer.OperationObserver<XaCommitOutcome> commitObserver, org.terracotta.statistics.observer.OperationObserver<XaRollbackOutcome> rollbackObserver, org.terracotta.statistics.observer.OperationObserver<XaRecoveryOutcome> recoveryObserver)

Constructor

Method Summary

Modifier and Type	Method	Description
void	addTwoPcExecutionListener(XAExecutionListener listener)	Add a listener which will be called back according to the 2PC lifecycle
void	commit(javax.transaction.xa.Xid xid, boolean onePhase)
void	commitInternal(javax.transaction.xa.Xid xid, boolean onePhase)	The commit implementation
XATransactionContext	createTransactionContext()	Obtain the already associated XATransactionContext with the current Transaction, or create a new one should none be there yet.
void	end(javax.transaction.xa.Xid xid, int flag)
void	forget(javax.transaction.xa.Xid xid)
void	forgetInternal(javax.transaction.xa.Xid xid)	The forget implementation
java.lang.String	getCacheName()	Getter to the name of the cache wrapped by this XAResource
XATransactionContext	getCurrentTransactionContext()	Gets the current XATransactionContext associated with this resource
int	getTransactionTimeout()
boolean	isSameRM(javax.transaction.xa.XAResource xaResource)
int	prepare(javax.transaction.xa.Xid xid)
int	prepareInternal(javax.transaction.xa.Xid xid)	The prepare implementation
javax.transaction.xa.Xid[]	recover(int flags)
void	rollback(javax.transaction.xa.Xid xid)
void	rollbackInternal(javax.transaction.xa.Xid xid)	The rollback implementation
boolean	setTransactionTimeout(int timeout)
void	start(javax.transaction.xa.Xid xid, int flag)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EhcacheXAResourceImpl

public EhcacheXAResourceImpl(Ehcache cache,
                             Store underlyingStore,
                             TransactionManagerLookup txnManagerLookup,
                             SoftLockManager softLockManager,
                             TransactionIDFactory transactionIDFactory,
                             ElementValueComparator comparator,
                             org.terracotta.statistics.observer.OperationObserver<XaCommitOutcome> commitObserver,
                             org.terracotta.statistics.observer.OperationObserver<XaRollbackOutcome> rollbackObserver,
                             org.terracotta.statistics.observer.OperationObserver<XaRecoveryOutcome> recoveryObserver)

Constructor

Parameters:

cache - the cache

underlyingStore - the underlying store

txnManagerLookup - the transaction manager lookup

softLockManager - the soft lock manager

transactionIDFactory - the transaction ID factory

comparator - the element value comparator

Method Detail

start

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

Specified by:

start in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

end

public void end(javax.transaction.xa.Xid xid,
                int flag)
         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

forgetInternal

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

The forget implementation

Parameters:

xid - a XID

Throws:

javax.transaction.xa.XAException - when an error occurs

getTransactionTimeout

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

Specified by:

getTransactionTimeout in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

isSameRM

public boolean isSameRM(javax.transaction.xa.XAResource xaResource)
                 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

prepareInternal

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

The prepare implementation

Parameters:

xid - a XID

Returns:

XA_OK or XA_RDONLY

Throws:

javax.transaction.xa.XAException - when an error occurs

commit

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

Specified by:

commit in interface javax.transaction.xa.XAResource

Throws:

javax.transaction.xa.XAException

commitInternal

public void commitInternal(javax.transaction.xa.Xid xid,
                           boolean onePhase)
                    throws javax.transaction.xa.XAException

The commit implementation

Parameters:

xid - a XID

onePhase - true if onePhase, false otherwise

Throws:

javax.transaction.xa.XAException - when an error occurs

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

rollbackInternal

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

The rollback implementation

Parameters:

xid - a XID

Throws:

javax.transaction.xa.XAException - when an error occurs

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

addTwoPcExecutionListener

public void addTwoPcExecutionListener(XAExecutionListener listener)

Add a listener which will be called back according to the 2PC lifecycle

Specified by:

addTwoPcExecutionListener in interface EhcacheXAResource

Parameters:

listener - the XAExecutionListener

getCacheName

public java.lang.String getCacheName()

Getter to the name of the cache wrapped by this XAResource

Specified by:

getCacheName in interface EhcacheXAResource

Returns:

Ehcache.getName() value

createTransactionContext

public XATransactionContext createTransactionContext()
                                              throws javax.transaction.SystemException,
                                                     javax.transaction.RollbackException

Obtain the already associated XATransactionContext with the current Transaction, or create a new one should none be there yet.

Specified by:

createTransactionContext in interface EhcacheXAResource

Returns:

The associated Transaction associated XATransactionContext

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

public XATransactionContext getCurrentTransactionContext()

Gets the current XATransactionContext associated with this resource

Specified by:

getCurrentTransactionContext in interface EhcacheXAResource

Returns:

the current XATransactionContext, or null if none

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object