atg.dtm

Class AutoCloseTransactionDemarcation

java.lang.Object

atg.dtm.TransactionDemarcation

atg.dtm.AutoCloseTransactionDemarcation

All Implemented Interfaces:

java.lang.AutoCloseable

public class AutoCloseTransactionDemarcation
extends TransactionDemarcation
implements java.lang.AutoCloseable

A subclass of TransactionDemarcation that implements AutoCloseable. It also adds a boolean "success" property that defaults to false. If it is still false at close time, end(true) is called, which will rollback the transaction. Therefore, one should set success to true after all other code in the transaction demarc has completed successfully.

The following is a sample use:

 try (AutoCloseTransactionDemarcation td = new AutoCloseTransactionDemarcation(getTransactionManager())) {

   ... code to execute within the transaction ...

   td.setSuccess(true);
 }
 

Created: December 06 2013

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.dtm.TransactionDemarcation

MANDATORY, NEVER, NOT_SUPPORTED, REQUIRED, REQUIRES_NEW, STATUS_CREATED_TRANSACTION_COMMITTED, STATUS_SUSPENDED_TRANSACTION_RESUMED, STATUS_TRANSACTION_CREATED, STATUS_TRANSACTION_ENDED_IN_CODE, SUPPORTS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AutoCloseTransactionDemarcation() Create a new AutoCloseTransactionDemarcation that hasn't called begin().
	AutoCloseTransactionDemarcation(javax.transaction.TransactionManager pManager) Create a new AutoCloseTransactionDemarcation that begins the transaction with our default attribute (REQUIRED, unless overridden).
	AutoCloseTransactionDemarcation(javax.transaction.TransactionManager pManager, int pTransactionAttribute) Create a new AutoCloseTransactionDemarcation that begins the transaction with specified transaction attribute.

Method Summary

Modifier and Type	Method and Description
void	close() Close by calling end(!isSuccess()).
boolean	isSuccess() Returns property success.
void	setSuccess(boolean pSuccess) Sets property success.

Methods inherited from class atg.dtm.TransactionDemarcation

begin, begin, end, end, equalTransactions, getDefaultTransactionAttribute, getTransaction, isTransactionCreated, setClearTransactionOnEnd

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

AutoCloseTransactionDemarcation

public AutoCloseTransactionDemarcation(javax.transaction.TransactionManager pManager)
                                throws TransactionDemarcationException

Create a new AutoCloseTransactionDemarcation that begins the transaction with our default attribute (REQUIRED, unless overridden).

Parameters:

pManager - our transaction manager.

Throws:

TransactionDemarcationException

AutoCloseTransactionDemarcation

public AutoCloseTransactionDemarcation(javax.transaction.TransactionManager pManager,
                                       int pTransactionAttribute)
                                throws TransactionDemarcationException

Create a new AutoCloseTransactionDemarcation that begins the transaction with specified transaction attribute.

Parameters:

pManager - our transaction manager.

pTransactionAttribute - the transaction attribute (such as REQUIRED, REQUIRES_NEW, etc).

Throws:

TransactionDemarcationException

AutoCloseTransactionDemarcation

protected AutoCloseTransactionDemarcation()

Create a new AutoCloseTransactionDemarcation that hasn't called begin(). Intended for use by subclasses.

Method Detail

setSuccess

public void setSuccess(boolean pSuccess)

Sets property success. Whether we were successful. Defaults to false. If not true when close is called, the current transaction will be rolled back or marked for rollback.

isSuccess

public boolean isSuccess()

Returns property success. Whether we were successful. Defaults to false.

close

public void close()
           throws TransactionDemarcationException

Close by calling end(!isSuccess()).

Specified by:

close in interface java.lang.AutoCloseable

Throws:

TransactionDemarcationException