com.sun.enterprise.transaction.jts

Class JavaEETransactionManagerJTSDelegate

java.lang.Object

com.sun.enterprise.transaction.jts.JavaEETransactionManagerJTSDelegate

All Implemented Interfaces:

JavaEETransactionManagerDelegate, org.glassfish.hk2.api.PostConstruct

@Service
public class JavaEETransactionManagerJTSDelegate
extends Object
implements JavaEETransactionManagerDelegate, org.glassfish.hk2.api.PostConstruct

Implementation of JavaEETransactionManagerDelegate that supports XA transactions with JTS.

Author:

Marina Vatkina

Constructor Summary

Constructors

Constructor and Description
JavaEETransactionManagerJTSDelegate()

Method Summary

Modifier and Type	Method and Description
void	acquireWriteLock() Allows the delegate to acquire a write lock.
void	beginJTS(int timeout)
void	commitDistributedTransaction() An XA transaction commit
boolean	enlistDistributedNonXAResource(Transaction tx, TransactionalResource h) Perform implementation specific steps to enlist a non-XA resource with a distribute transaction.
boolean	enlistLAOResource(Transaction tran, TransactionalResource h) Perform implementation specific steps to enlist resource as a LAO.
static JavaEETransactionManagerJTSDelegate	getInstance()
JavaEETransaction	getJavaEETransaction(Transaction t) Get local transaction object that corresponds to this transaction instance.
int	getOrder() The delegate with the largest order will be used.
Lock	getReadLock() Return the delegate specific read lock that implements Lock interface.
int	getStatus() Get implementation specific status of the transaction associated with the current thread.
Transaction	getTransaction() Get implementation specific transaction object that represents the transaction context of the calling thread.
TransactionAdminBean	getTransactionAdminBean(Transaction t) Return TransactionAdminBean with delegate specific implementation details of an active Transaction.
String	getTxLogLocation() Return location of transaction logs
XAResourceWrapper	getXAResourceWrapper(String clName) Returns an instance of an XAResourceWrapper if this delegate supports transaction recovery and there is a wrapper available for this class name.
javax.resource.spi.XATerminator	getXATerminator() This is used by importing transactions via the Connector contract.
void	handlePropertyUpdate(String name, Object value) Handle configuration change.
void	initRecovery(boolean force) Initialize recovery framework.
void	initTransactionProperties()
void	initXA()
boolean	isNullTransaction() Return true if a "null transaction context" was received from the client.
boolean	isWriteLocked() Return true if the delegate had its write lock acquired.
void	postConstruct()
void	recover(XAResource[] resourceList) Recover an array of XAResource objects for a failed XA transaction.
boolean	recoverIncompleteTx(boolean delegated, String logPath, XAResource[] xaresArray) Recover the populated array of XAResource if this delegate supports transaction recovery.
void	recreate(Xid xid, long timeout) Recreate a transaction based on the Xid.
void	registerRecoveryResourceHandler(XAResource xaResource) Allows an arbitrary XAResource to register for recovery
void	release(Xid xid) Release a transaction.
void	releaseWriteLock() Allows the delegate to release a write lock.
void	removeTransaction(Transaction tx) Remove the Transaction object from the cache.
void	resume(Transaction tx) Perform implementation specific steps to resume a Transaction.
void	rollbackDistributedTransaction() An XA transaction rollback
void	setRollbackOnlyDistributedTransaction() Perform implementation specific steps to set setRollbackOnly status for distributed transaction if there is any.
void	setTransactionManager(JavaEETransactionManager tm) Set the JavaEETransactionManager reference.
void	setUseLAO(boolean b) Reset LAO value.
TransactionInternal	startJTSTx(JavaEETransaction tran, boolean isAssociatedTimeout) Start new JTS transaction for the existing local transaction object.
boolean	supportsXAResource() Returns true if this delegate supports XA resources.
Transaction	suspend(JavaEETransaction tx) Perform implementation specific steps to suspend a JavaEETransaction.
boolean	useLAO() Returns true if this implementation supports last agent optimization.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaEETransactionManagerJTSDelegate

public JavaEETransactionManagerJTSDelegate()

Method Detail

postConstruct

public void postConstruct()

Specified by:

postConstruct in interface org.glassfish.hk2.api.PostConstruct

useLAO

public boolean useLAO()

Description copied from interface: JavaEETransactionManagerDelegate

Returns true if this implementation supports last agent optimization.

Specified by:

useLAO in interface JavaEETransactionManagerDelegate

setUseLAO

public void setUseLAO(boolean b)

Description copied from interface: JavaEETransactionManagerDelegate

Reset LAO value.

Specified by:

setUseLAO in interface JavaEETransactionManagerDelegate

Parameters:

b - the boolean value for the LAO flag.

commitDistributedTransaction

public void commitDistributedTransaction()
                                  throws RollbackException,
                                         HeuristicMixedException,
                                         HeuristicRollbackException,
                                         SecurityException,
                                         IllegalStateException,
                                         SystemException

An XA transaction commit

Specified by:

commitDistributedTransaction in interface JavaEETransactionManagerDelegate

Throws:

RollbackException

HeuristicMixedException

HeuristicRollbackException

SecurityException

IllegalStateException

SystemException

rollbackDistributedTransaction

public void rollbackDistributedTransaction()
                                    throws IllegalStateException,
                                           SecurityException,
                                           SystemException

An XA transaction rollback

Specified by:

rollbackDistributedTransaction in interface JavaEETransactionManagerDelegate

Throws:

IllegalStateException

SecurityException

SystemException

getStatus

public int getStatus()
              throws SystemException

Description copied from interface: JavaEETransactionManagerDelegate

Get implementation specific status of the transaction associated with the current thread.

Specified by:

getStatus in interface JavaEETransactionManagerDelegate

Returns:

the status value as an int.

Throws:

SystemException

getTransaction

public Transaction getTransaction()
                           throws SystemException

Description copied from interface: JavaEETransactionManagerDelegate

Get implementation specific transaction object that represents the transaction context of the calling thread.

Specified by:

getTransaction in interface JavaEETransactionManagerDelegate

Returns:

the transaction object.

Throws:

SystemException

getJavaEETransaction

public JavaEETransaction getJavaEETransaction(Transaction t)

Description copied from interface: JavaEETransactionManagerDelegate

Get local transaction object that corresponds to this transaction instance.

Specified by:

getJavaEETransaction in interface JavaEETransactionManagerDelegate

Returns:

the transaction object.

enlistDistributedNonXAResource

public boolean enlistDistributedNonXAResource(Transaction tx,
                                              TransactionalResource h)
                                       throws RollbackException,
                                              IllegalStateException,
                                              SystemException

Description copied from interface: JavaEETransactionManagerDelegate

Perform implementation specific steps to enlist a non-XA resource with a distribute transaction.

Specified by:

enlistDistributedNonXAResource in interface JavaEETransactionManagerDelegate

Parameters:

tx - the Transaction object to be used to enlist the resource.

h - the TransactionalResource object to be enlisted.

Returns:

true if the resource was enlisted successfully.

Throws:

RollbackException

IllegalStateException

SystemException

enlistLAOResource

public boolean enlistLAOResource(Transaction tran,
                                 TransactionalResource h)
                          throws RollbackException,
                                 IllegalStateException,
                                 SystemException

Description copied from interface: JavaEETransactionManagerDelegate

Perform implementation specific steps to enlist resource as a LAO.

Specified by:

enlistLAOResource in interface JavaEETransactionManagerDelegate

Parameters:

tran - the Transaction object to be used to enlist the resource.

h - the TransactionalResource object to be enlisted.

Returns:

true if the resource was enlisted successfully.

Throws:

RollbackException

IllegalStateException

SystemException

setRollbackOnlyDistributedTransaction

public void setRollbackOnlyDistributedTransaction()
                                           throws IllegalStateException,
                                                  SystemException

Description copied from interface: JavaEETransactionManagerDelegate

Perform implementation specific steps to set setRollbackOnly status for distributed transaction if there is any.

Specified by:

setRollbackOnlyDistributedTransaction in interface JavaEETransactionManagerDelegate

Throws:

IllegalStateException

SystemException

suspend

public Transaction suspend(JavaEETransaction tx)
                    throws SystemException

Description copied from interface: JavaEETransactionManagerDelegate

Perform implementation specific steps to suspend a JavaEETransaction.

Specified by:

suspend in interface JavaEETransactionManagerDelegate

Parameters:

tx - the JavaEETransaction object to be suspend.

Returns:

Transaction object representing the suspended transaction.

Throws:

SystemException

resume

public void resume(Transaction tx)
            throws InvalidTransactionException,
                   IllegalStateException,
                   SystemException

Description copied from interface: JavaEETransactionManagerDelegate

Perform implementation specific steps to resume a Transaction.

Specified by:

resume in interface JavaEETransactionManagerDelegate

Parameters:

tx - the Transaction object that represents the transaction to be resumed.

Throws:

InvalidTransactionException

IllegalStateException

SystemException

removeTransaction

public void removeTransaction(Transaction tx)

Description copied from interface: JavaEETransactionManagerDelegate

Remove the Transaction object from the cache.

Specified by:

removeTransaction in interface JavaEETransactionManagerDelegate

Parameters:

tx - the Transaction object to be removed.

getOrder

public int getOrder()

Description copied from interface: JavaEETransactionManagerDelegate

The delegate with the largest order will be used.

Specified by:

getOrder in interface JavaEETransactionManagerDelegate

Returns:

the order in which this delegate should be used.

setTransactionManager

public void setTransactionManager(JavaEETransactionManager tm)

Description copied from interface: JavaEETransactionManagerDelegate

Set the JavaEETransactionManager reference.

Specified by:

setTransactionManager in interface JavaEETransactionManagerDelegate

Parameters:

tm - the JavaEETransactionManager object.

startJTSTx

public TransactionInternal startJTSTx(JavaEETransaction tran,
                                      boolean isAssociatedTimeout)
                               throws RollbackException,
                                      IllegalStateException,
                                      SystemException

Description copied from interface: JavaEETransactionManagerDelegate

Start new JTS transaction for the existing local transaction object.

Specified by:

startJTSTx in interface JavaEETransactionManagerDelegate

Parameters:

tran - the JavaEETransaction object.

isAssociatedTimeout - true if transaction has a timeout associated with it.

Returns:

the new JTS Transaction instance.

Throws:

RollbackException

IllegalStateException

SystemException

initRecovery

public void initRecovery(boolean force)

Description copied from interface: JavaEETransactionManagerDelegate

Initialize recovery framework. Is a no-op if a delegate doesn't support this functionality.

Specified by:

initRecovery in interface JavaEETransactionManagerDelegate

recover

public void recover(XAResource[] resourceList)

Description copied from interface: JavaEETransactionManagerDelegate

Recover an array of XAResource objects for a failed XA transaction.

Specified by:

recover in interface JavaEETransactionManagerDelegate

Parameters:

resourceList - the array of XAResource objects to recover.

release

public void release(Xid xid)
             throws javax.resource.spi.work.WorkException

Description copied from interface: JavaEETransactionManagerDelegate

Release a transaction. This call causes the calling thread to be dissociated from the specified transaction.

This is used by importing transactions via the Connector contract.

Specified by:

release in interface JavaEETransactionManagerDelegate

Parameters:

xid - the Xid object representing a transaction.

Throws:

javax.resource.spi.work.WorkException

recreate

public void recreate(Xid xid,
                     long timeout)
              throws javax.resource.spi.work.WorkException

Description copied from interface: JavaEETransactionManagerDelegate

Recreate a transaction based on the Xid. This call causes the calling thread to be associated with the specified transaction.

This is used by importing transactions via the Connector contract.

Specified by:

recreate in interface JavaEETransactionManagerDelegate

Parameters:

xid - the Xid object representing a transaction.

timeout - the timeout for the transaction to be recreated.

Throws:

javax.resource.spi.work.WorkException

getXATerminator

public javax.resource.spi.XATerminator getXATerminator()

Description copied from interface: JavaEETransactionManagerDelegate

This is used by importing transactions via the Connector contract. Should not be called

Specified by:

getXATerminator in interface JavaEETransactionManagerDelegate

Returns:

a XATerminator instance.

getXAResourceWrapper

public XAResourceWrapper getXAResourceWrapper(String clName)

Description copied from interface: JavaEETransactionManagerDelegate

Returns an instance of an XAResourceWrapper if this delegate supports transaction recovery and there is a wrapper available for this class name. Returns null otherwise.

Specified by:

getXAResourceWrapper in interface JavaEETransactionManagerDelegate

Returns:

an instance of an XAResourceWrapper or null if this delegate doesn't support transaction recovery or a wrapper is not available.

handlePropertyUpdate

public void handlePropertyUpdate(String name,
                                 Object value)

Description copied from interface: JavaEETransactionManagerDelegate

Handle configuration change.

Specified by:

handlePropertyUpdate in interface JavaEETransactionManagerDelegate

Parameters:

name - the name of the configuration property.

value - the ne value of the configuration.

recoverIncompleteTx

public boolean recoverIncompleteTx(boolean delegated,
                                   String logPath,
                                   XAResource[] xaresArray)
                            throws Exception

Description copied from interface: JavaEETransactionManagerDelegate

Recover the populated array of XAResource if this delegate supports transaction recovery.

Specified by:

recoverIncompleteTx in interface JavaEETransactionManagerDelegate

Parameters:

delegated - true if the recovery process is owned by this instance.

logPath - the name of the transaction logging directory

xaresArray - the array of XA Resources to be recovered.

Returns:

true if the recovery has been successful.

Throws:

Exception

beginJTS

public void beginJTS(int timeout)
              throws NotSupportedException,
                     SystemException

Throws:

NotSupportedException

SystemException

supportsXAResource

public boolean supportsXAResource()

Description copied from interface: JavaEETransactionManagerDelegate

Returns true if this delegate supports XA resources.

Specified by:

supportsXAResource in interface JavaEETransactionManagerDelegate

initTransactionProperties

public void initTransactionProperties()

isNullTransaction

public boolean isNullTransaction()

Return true if a "null transaction context" was received from the client. See EJB2.0 spec section 19.6.2.1. A null tx context has no Coordinator objref. It indicates that the client had an active tx but the client container did not support tx interop.

Specified by:

isNullTransaction in interface JavaEETransactionManagerDelegate

getTransactionAdminBean

public TransactionAdminBean getTransactionAdminBean(Transaction t)
                                             throws SystemException

Description copied from interface: JavaEETransactionManagerDelegate

Return TransactionAdminBean with delegate specific implementation details of an active Transaction.

Specified by:

getTransactionAdminBean in interface JavaEETransactionManagerDelegate

Throws:

SystemException

getTxLogLocation

public String getTxLogLocation()

Return location of transaction logs

Specified by:

getTxLogLocation in interface JavaEETransactionManagerDelegate

Returns:

String location of transaction logs

registerRecoveryResourceHandler

public void registerRecoveryResourceHandler(XAResource xaResource)

Allows an arbitrary XAResource to register for recovery

Specified by:

registerRecoveryResourceHandler in interface JavaEETransactionManagerDelegate

Parameters:

xaResource - XAResource to register for recovery

getReadLock

public Lock getReadLock()

Description copied from interface: JavaEETransactionManagerDelegate

Return the delegate specific read lock that implements Lock interface.

Specified by:

getReadLock in interface JavaEETransactionManagerDelegate

acquireWriteLock

public void acquireWriteLock()

Description copied from interface: JavaEETransactionManagerDelegate

Allows the delegate to acquire a write lock.

Specified by:

acquireWriteLock in interface JavaEETransactionManagerDelegate

releaseWriteLock

public void releaseWriteLock()

Description copied from interface: JavaEETransactionManagerDelegate

Allows the delegate to release a write lock.

Specified by:

releaseWriteLock in interface JavaEETransactionManagerDelegate

isWriteLocked

public boolean isWriteLocked()

Description copied from interface: JavaEETransactionManagerDelegate

Return true if the delegate had its write lock acquired.

Specified by:

isWriteLocked in interface JavaEETransactionManagerDelegate

getInstance

public static JavaEETransactionManagerJTSDelegate getInstance()

initXA

public void initXA()