org.jboss.jbossts.xts.bridge.at

Class BridgeWrapper

java.lang.Object

org.jboss.jbossts.xts.bridge.at.BridgeWrapper

public class BridgeWrapper
extends Object

An API class for use by the JTA ==> AT bridge manager providing a wrapper around a subordinate transaction. Static methods are provided to create and register a WS-AT subordinate transaction or to locate a recovered transaction. The returned wrapper allows a client to drive the coordinator through prepare, (phase 2) commit and/or rollback, to access the transaction id under which the coordinator is registered and, if the transaction has not been recovered, to obtain a resumable tx context for the transaction. n.b. this class only supports bridging to WS-AT 1.1 transactions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUBORDINATE_TX_TYPE_AT_AT the standard type string used to identify AT AT subordinate transactions.

Method Summary

Modifier and Type	Method and Description
void	commit() perform a phase 2 commit for the bridged-to transaction
void	commitVolatile() initiate synchronization afterCompletion processing for the bridged-to transaction following a successful commit
static BridgeWrapper	create(String subordinateType, long expires, boolean isSecure) create an AT 1.1 subordinate transaction, associate it with the AT 1.1.
TxContext	getContext() obtain a resumable transaction context for the bridged-to transaction
String	getIdentifier() obtain the identifier for the bridged-to transaction
String	getSubordinateType() obtain the subordinate type for the bridged-to transaction
int	prepare() prepare the bridged-to transaction
boolean	prepareVolatile() initiate synchronization beforeCompletion processing for the bridged-to transaction
static BridgeWrapper	recover(String identifier) recreate a wrapper for a bridged-to WS-AT 1.1 transaction recovered from the log
void	rollback() rollback the bridged-to transaction
void	rollbackVolatile() initiate synchronization afterCompletion processing for the bridged-to transaction following a rollback
static BridgeWrapper[]	scan(String subordinateType) return a list of bridge wrappers for all recovered subordinate transactions with a given subordinate type
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SUBORDINATE_TX_TYPE_AT_AT

public static final String SUBORDINATE_TX_TYPE_AT_AT

the standard type string used to identify AT AT subordinate transactions. bridge clients must ensure that they do not employ this type for their subordinates.

See Also:

Constant Field Values

Method Detail

create

public static BridgeWrapper create(String subordinateType,
                                   long expires,
                                   boolean isSecure)

create an AT 1.1 subordinate transaction, associate it with the AT 1.1. registry then return a BridgedTransaction wrapper allowing the transaction to be driven through prepare, commit and/or rollback and providing access to the transaction id and a context which can be used to resume the transaction.

Parameters:

subordinateType - a unique string which groups subordinates for the benefit of their parent tx/app and allows them to be identified and retrieved as a group during recovery. this must differ from the string SUBORDINATE_TX_TYPE_AT_AT

expires - the timeout for the bridged-to transaction or 0 if no timeout is required

isSecure - true if AT 1.1. protocol messages for the bridged-to transaction should employ secure communications, otherwise false

Returns:

a wrapper for the bridged-to transaction

Throws:

SystemException

recover

public static BridgeWrapper recover(String identifier)
                             throws UnknownTransactionException

recreate a wrapper for a bridged-to WS-AT 1.1 transaction recovered from the log

Parameters:

identifier - the identifier of a previously created bridged-to transaction

Returns:

a wrapper for the bridged-to transaction or null if it may still be awaiting recovery

Throws:

UnknownTransactionException - if recovery has been performed and no transaction with the given identifier has been found in the log

scan

public static BridgeWrapper[] scan(String subordinateType)

return a list of bridge wrappers for all recovered subordinate transactions with a given subordinate type

Parameters:

subordinateType - the subordinate type supplied in the original bridge wrapper create call which created the subordinate transaction.

Returns:

a possibly zero-length array of bridge wrappers for all recovered subordinate AT transactions with the given subordinate type or null if a subordinate coordinator recovery scan has not yet occurred

getIdentifier

public String getIdentifier()

obtain the identifier for the bridged-to transaction

Returns:

the identifier for the bridged-to transaction

getContext

public TxContext getContext()
                     throws UnknownTransactionException

obtain a resumable transaction context for the bridged-to transaction

Returns:

a resumable transaction context

Throws:

UnknownTransactionException - if this transaction has been recovered from the log and hence has no associated transaction context.

getSubordinateType

public String getSubordinateType()

obtain the subordinate type for the bridged-to transaction

Returns:

the subordinate type for the bridged-to transaction

prepareVolatile

public boolean prepareVolatile()

initiate synchronization beforeCompletion processing for the bridged-to transaction

Returns:

true if the beforeCompletion succeeds otherwise false.

prepare

public int prepare()

prepare the bridged-to transaction

Returns:

the result of preparing the transaction

commitVolatile

public void commitVolatile()

initiate synchronization afterCompletion processing for the bridged-to transaction following a successful commit

commit

public void commit()

perform a phase 2 commit for the bridged-to transaction

rollbackVolatile

public void rollbackVolatile()

initiate synchronization afterCompletion processing for the bridged-to transaction following a rollback

rollback

public void rollback()

rollback the bridged-to transaction

toString

public String toString()

Overrides:

toString in class Object