atg.dtm

Class SingleExceptionTransactionDemarcation<E extends java.lang.Exception>

java.lang.Object

atg.dtm.TransactionDemarcation

atg.dtm.SingleExceptionTransactionDemarcation<E>

Type Parameters:

E - the type of exception that can be thrown.

Created: December 06 2013

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

RepositoryTransactionDemarcation

public abstract class SingleExceptionTransactionDemarcation<E extends java.lang.Exception>
extends TransactionDemarcation
implements java.lang.AutoCloseable

An abstract subclass of TransactionDemarcation that implements AutoCloseable and wraps TransactionDemarcationExceptions so that a different exception type can be thrown (this can avoid having to have repetitive catch/re-throw blocks for dealing with TransactionDemarcationException).

This class 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.

This class cannot be a subclass of AutoCloseableTranctionDemarcation because the signature of close() differs in Exception type.

See Also:

atg.dtm.AutoCloseableTranctionDemarcation

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	SingleExceptionTransactionDemarcation() Create a new instance that hasn't called begin().
	SingleExceptionTransactionDemarcation(javax.transaction.TransactionManager pManager) Create a new SingleExceptionTransactionDemarcation that begins the transaction with our default attribute (REQUIRED, unless overridden).
	SingleExceptionTransactionDemarcation(javax.transaction.TransactionManager pManager, int pTransactionAttribute) Create a new SingleExceptiontransactionDemarcation that begins the transaction with specified transaction attribute.

Method Summary

Modifier and Type	Method and Description
void	close() Actually close by calling end(!isSuccess()).
boolean	isSuccess() Returns property success.
void	setSuccess(boolean pSuccess) Sets property success.
protected abstract E	wrapTransactionDemarcationException(TransactionDemarcationException pException) Wrap TransactionDemarcationException with an exception of type E.

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

SingleExceptionTransactionDemarcation

public SingleExceptionTransactionDemarcation(javax.transaction.TransactionManager pManager)
                                      throws E extends java.lang.Exception

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

Parameters:

pManager - our transaction manager.

Throws:

E extends java.lang.Exception

SingleExceptionTransactionDemarcation

public SingleExceptionTransactionDemarcation(javax.transaction.TransactionManager pManager,
                                             int pTransactionAttribute)
                                      throws E extends java.lang.Exception

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

Parameters:

pManager - our transaction manager.

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

Throws:

E extends java.lang.Exception

SingleExceptionTransactionDemarcation

protected SingleExceptionTransactionDemarcation()

Create a new instance 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.

wrapTransactionDemarcationException

protected abstract E wrapTransactionDemarcationException(TransactionDemarcationException pException)

Wrap TransactionDemarcationException with an exception of type E.

Parameters:

pException - the exception to wrap.

close

public void close()
           throws E extends java.lang.Exception

Actually close by calling end(!isSuccess()).

Specified by:

close in interface java.lang.AutoCloseable

Throws:

E extends java.lang.Exception