com.atomikos.icatch

Interface CompositeTransactionManager

public interface CompositeTransactionManager

This interface outlines the API for managing composite transactions in the local VM.

Method Summary

Modifier and Type	Method and Description
CompositeTransaction	createCompositeTransaction(long timeout) Starts a new (sub)transaction (not an activity) for the current thread.
CompositeTransaction	getCompositeTransaction()
CompositeTransaction	getCompositeTransaction(java.lang.String tid) Gets the composite transaction with the given id.
CompositeTransaction	recreateCompositeTransaction(Propagation propagation) Recreate a composite transaction based on an imported context.
void	resume(CompositeTransaction compositeTransaction) Re-maps the calling thread to the given transaction.
CompositeTransaction	suspend() Suspends the transaction context for the current thread.

Method Detail

createCompositeTransaction

CompositeTransaction createCompositeTransaction(long timeout)
                                         throws SysException,
                                                java.lang.IllegalStateException

Starts a new (sub)transaction (not an activity) for the current thread. Associates the current thread with that instance.
NOTE: subtransactions should not be mixed: either each subtransaction is an activity, or not (default). Use suspend/resume if mixed models are necessary: for instance, if you want to create a normal transaction within an activity, then suspend the activity first before starting the transaction. Afterwards, resume the activity.

Parameters:

Timeout - (in millis) for the transaction.

Returns:

CompositeTransaction The new instance.

Throws:

SysException - Unexpected error.

java.lang.IllegalStateException - If there is an existing transaction that is an activity instead of a classical transaction.

getCompositeTransaction

CompositeTransaction getCompositeTransaction()
                                      throws SysException

Returns:

CompositeTransaction The instance for the current thread, null if none.

Throws:

SysException - On unexpected failure.

getCompositeTransaction

CompositeTransaction getCompositeTransaction(java.lang.String tid)
                                      throws SysException

Gets the composite transaction with the given id. This method is useful e.g. for retrieving a suspended transaction by its id.

Parameters:

tid - The id of the transaction.

Returns:

CompositeTransaction The transaction with the given id, or null if not found.

Throws:

SysException - Unexpected failure.

resume

void resume(CompositeTransaction compositeTransaction)
     throws java.lang.IllegalStateException,
            SysException

Re-maps the calling thread to the given transaction.

Parameters:

compositeTransaction -

Throws:

java.lang.IllegalStateException - If this thread has a transaction context already.

SysException

suspend

CompositeTransaction suspend()
                      throws SysException

Suspends the transaction context for the current thread. This method suspends the entire transaction tree, including any parent transactions.

Returns:

CompositeTransaction The transaction for the current thread.

Throws:

SysException

recreateCompositeTransaction

CompositeTransaction recreateCompositeTransaction(Propagation propagation)

Recreate a composite transaction based on an imported context. Needed by the application's communication layer.

Parameters:

context - The propagationcontext.

Returns:

CompositeTransaction The recreated local instance.

Throws:

SysException - Failure.