org.omg.CosTransactions
Interface CoordinatorOperations

All Known Subinterfaces:

Coordinator

All Known Implementing Classes:

_CoordinatorStub, CoordinatorPOA

public interface CoordinatorOperations

The Coordinator interface provides operations that are used by participants in a transaction.

Method Summary

Control	create_subtransaction() A new subtransaction is created whose parent is the transaction associated with the target object.
Status	get_parent_status() If the transaction is a top-level transaction then its status is returned.
Status	get_status() The status of the transaction.
Status	get_top_level_status() The status of the top-level transaction is returned.
String	get_transaction_name() Returns a printable string describing the transaction associated with the target object.
PropagationContext	get_txcontext() Returns a PropagationContext object, which is used by one Transaction Service domain to export the current transaction to a new Transaction Service domain.
int	hash_top_level_tran()
int	hash_transaction()
boolean	is_ancestor_transaction(Coordinator tc) This operation returns true if, and only if, the transaction associated with the target object is an ancestor of the transaction associated with the parameter object.
boolean	is_descendant_transaction(Coordinator tc) This operation returns true if, and only if, the transaction associated with the target object is a descendant of the transaction associated with the parameter object.
boolean	is_related_transaction(Coordinator tc) This operation returns true if, and only if, the transaction associated with the target object is related to the transaction associated with the parameter object.
boolean	is_same_transaction(Coordinator tc) This operation returns true if, and only if, the target object and the parameter object both refer to the same transaction.
boolean	is_top_level_transaction() This operation returns true if, and only if, the transaction associated with the target object is a top-level transaction.
RecoveryCoordinator	register_resource(Resource r) Register a Resource as a participant in the transaction associated with the target object.
void	register_subtran_aware(SubtransactionAwareResource r) This operation registers the specified subtransaction aware resource such that it will be notified when the subtransaction has committed or rolled back.
void	register_synchronization(Synchronization sync) This operation registers the specified Synchronization object such that it will be notified to perform necessary processing prior to prepare being driven to resources registered with this Coordinator.
void	rollback_only() The transaction associated with the target object is modified so that the only possible outcome is to rollback the transaction.

Method Detail

get_status

public Status get_status()

The status of the transaction.

get_parent_status

public Status get_parent_status()

If the transaction is a top-level transaction then its status is returned. Otherwise, the status of the parent of the transaction is returned.

get_top_level_status

public Status get_top_level_status()

The status of the top-level transaction is returned.

is_same_transaction

public boolean is_same_transaction(Coordinator tc)

This operation returns true if, and only if, the target object and the parameter object both refer to the same transaction.

is_ancestor_transaction

public boolean is_ancestor_transaction(Coordinator tc)

This operation returns true if, and only if, the transaction associated with the target object is an ancestor of the transaction associated with the parameter object. A transaction T1 is an ancestor of a transaction T2 if, and only if, T1 is the same as T2 or T1 is an ancestor of the parent of T2.

is_descendant_transaction

public boolean is_descendant_transaction(Coordinator tc)

This operation returns true if, and only if, the transaction associated with the target object is a descendant of the transaction associated with the parameter object. A transaction T1 is a descendant of a transaction T2 if, and only if, T2 is an ancestor of T1.

is_related_transaction

public boolean is_related_transaction(Coordinator tc)

This operation returns true if, and only if, the transaction associated with the target object is related to the transaction associated with the parameter object. A transaction T1 is related to a transaction T2 if, and only if, there exists a transaction T3 such that T3 is an ancestor of T1 and T3 is an ancestor of T2.

is_top_level_transaction

public boolean is_top_level_transaction()

This operation returns true if, and only if, the transaction associated with the target object is a top-level transaction. A transaction is a top-level transaction if it has no parent.

hash_transaction

public int hash_transaction()

hash_top_level_tran

public int hash_top_level_tran()

register_resource

public RecoveryCoordinator register_resource(Resource r)
                                      throws Inactive

Register a Resource as a participant in the transaction associated with the target object.

Throws:

Inactive

register_synchronization

public void register_synchronization(Synchronization sync)
                              throws Inactive,
                                     SynchronizationUnavailable

This operation registers the specified Synchronization object such that it will be notified to perform necessary processing prior to prepare being driven to resources registered with this Coordinator.

Throws:

Inactive

SynchronizationUnavailable

register_subtran_aware

public void register_subtran_aware(SubtransactionAwareResource r)
                            throws Inactive,
                                   NotSubtransaction

This operation registers the specified subtransaction aware resource such that it will be notified when the subtransaction has committed or rolled back. These requests are described in the description of the SubtransactionAwareResource interface.

Throws:

Inactive

NotSubtransaction

rollback_only

public void rollback_only()
                   throws Inactive

The transaction associated with the target object is modified so that the only possible outcome is to rollback the transaction.

Throws:

Inactive

get_transaction_name

public String get_transaction_name()

Returns a printable string describing the transaction associated with the target object.

create_subtransaction

public Control create_subtransaction()
                              throws SubtransactionsUnavailable,
                                     Inactive

A new subtransaction is created whose parent is the transaction associated with the target object.

Throws:

SubtransactionsUnavailable

Inactive

get_txcontext

public PropagationContext get_txcontext()
                                 throws Unavailable

Returns a PropagationContext object, which is used by one Transaction Service domain to export the current transaction to a new Transaction Service domain.

Throws:

Unavailable