org.omg.CosTransactions
Interface CoordinatorOperations

All Known Subinterfaces:
Coordinator
All Known Implementing Classes:
_CoordinatorStub, Coordinator, CoordinatorPOA, CoordinatorPOATie, SubCoordinator, SubTransCoordinator

public interface CoordinatorOperations

The Coordinator interface provides operations that are used by participants in a transaction. These participants are typically either recoverable objects or agents of recoverable objects, such as subordinate coordinators. Each object supporting the Coordinator interface is implicitly associated with a single 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 associated with the target object is a top-level transaction, then this operation is equivalent to the get_status operation.
 Status get_status()
          This operation returns the status of the transaction associated with the target object: StatusActive - A transaction is associated with the target object and it is in the active state.
 Status get_top_level_status()
          This operation returns the status of the top-level ancestor of the transaction associated with the target object.
 java.lang.String get_transaction_name()
          This operation returns a printable string describing the transaction associated with the target object.
 PropagationContext get_txcontext()
          The get_txcontext operation 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()
          This operation returns the hash code for the top-level ancestor of the transaction associated with the target object.
 int hash_transaction()
          This operation returns a hash code for the transaction associated with the target object.
 boolean is_ancestor_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_descendant_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_related_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_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)
          This operation registers the specified 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

Status get_status()
This operation returns the status of the transaction associated with the target object: StatusActive - A transaction is associated with the target object and it is in the active state. An implementation returns this status after a transaction has been started and prior to a coordinator issuing any prepares unless it has been marked for rollback. StatusMarkedRollback - A transaction is associated with the target object and has been marked for rollback, perhaps as the result of a rollback_only operation. StatusPrepared - A transaction is associated with the target object and has been prepared (i.e., all subordinates have responded VoteCommit). The target object may be waiting for a superior?s instructions as to how to proceed. StatusCommitted - A transaction is associated with the target object and it has completed commitment. It is likely that heuristics exists; otherwise, the transaction would have been destroyed and StatusNoTransaction returned. StatusRolledBack - A transaction is associated with the target object and the outcome has been determined as rollback. It is likely that heuristics exists, otherwise the transaction would have been destroyed and StatusNoTransaction returned. StatusUnknown - A transaction is associated with the target object, but the Transaction Service cannot determine its current status. This is a transient condition, and a subsequent invocation will ultimately return a different status. StatusNoTransaction - No transaction is currently associated with the target object. This will occur after a transaction has completed. StatusPreparing - A transaction is associated with the target object and it is the process of preparing. An implementation returns this status if it has started preparing, but has not yet completed the process, probably because it is waiting for responses to prepare from one or more resources. StatusCommitting - A transaction is associated with the target object and is in the process of committing. An implementation returns this status if it has decided to commit, but has not yet completed the process, probably because it is waiting for responses from one or more resources. StatusRollingBack - A transaction is associated with the target object and it is in the process of rolling back. An implementation returns this status if it has decided to rollback, but has not yet completed the process, probably because it is waiting for responses from one or more resources.


get_parent_status

Status get_parent_status()
If the transaction associated with the target object is a top-level transaction, then this operation is equivalent to the get_status operation. Otherwise, this operation returns the status of the parent of the transaction associated with the target object.


get_top_level_status

Status get_top_level_status()
This operation returns the status of the top-level ancestor of the transaction associated with the target object. If the transaction is a top-level transaction, then this operation is equivalent to the get_status operation.


is_same_transaction

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_related_transaction

boolean is_related_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.


is_ancestor_transaction

boolean is_ancestor_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.


is_descendant_transaction

boolean is_descendant_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.


is_top_level_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. A transaction is a top-level transaction if it has no parent.


hash_transaction

int hash_transaction()
This operation returns a hash code for the transaction associated with the target object. Each transaction has a single hash code. Hash codes for transactions should be uniformly distributed.


hash_top_level_tran

int hash_top_level_tran()
This operation returns the hash code for the top-level ancestor of the transaction associated with the target object. This operation is equivalent to the hash_transaction operation when the transaction associated with the target object is a top-level transaction.


register_resource

RecoveryCoordinator register_resource(Resource r)
                                      throws Inactive
This operation registers the specified resource as a participant in the transaction associated with the target object. When the transaction is terminated, the resource will receive requests to commit or rollback the updates performed as part of the transaction. These requests are described in the description of the Resource interface. The Inactive exception is raised if the transaction has already been prepared. The standard exception TRANSACTION_ROLLEDBACK may be raised if the transaction has been marked rollback only. If the resource is a subtransaction aware resource (it supports the SubtransactionAwareResource interface) and the transaction associated with the target object is a subtransaction, then this operation registers the specified resource with the subtransaction and indirectly with the top-level transaction when the subtransaction?s ancestors have completed. Otherwise, the resource is registered as a participant in the current transaction. If the current transaction is a subtransaction, the resource will not receive prepare or commit requests until the top-level ancestor terminates. This operation returns a RecoveryCoordinator that can be used by this resource during recovery.

Throws:
Inactive

register_synchronization

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. These requests are described in the description of the Synchronization interface. The Inactive exception is raised if the transaction has already been prepared. The SynchronizationUnavailable exception is raised if the Coordinator does not support synchronization. The standard exception TRANSACTION_ROLLEDBACK may be raised if the transaction has been marked rollback only.

Throws:
Inactive
SynchronizationUnavailable

register_subtran_aware

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. Note that this operation registers the specified resource only with the subtransaction. This operation cannot be used to register the resource as a participant in the transaction. The NotSubtransaction exception is raised if the current transaction is not a subtransaction. The Inactive exception is raised if the subtransaction (or any ancestor) has already been terminated. The standard exception TRANSACTION_ROLLEDBACK may be raised if the subtransaction (or any ancestor) has been marked rollback only.

Throws:
Inactive
NotSubtransaction

rollback_only

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. The Inactive exception is raised if the transaction has already been prepared.

Throws:
Inactive

get_transaction_name

java.lang.String get_transaction_name()
This operation returns a printable string describing the transaction associated with the target object. The returned string is intended to support debugging.


create_subtransaction

Control create_subtransaction()
                              throws SubtransactionsUnavailable,
                                     Inactive
A new subtransaction is created whose parent is the transaction associated with the target object. The Inactive exception is raised if the target transaction has already been prepared. An implementation of the Transaction Service is not required to support nested transactions. If nested transactions are not supported, the exception SubtransactionsUnavailable is raised. The create_subtransaction operation returns a Control object, which enables the subtransaction to be terminated and allows recoverable objects to participate in the subtransaction. An implementation of the Transaction Service may restrict the ability for the Control object to be transmitted to or used in other execution environments.

Throws:
SubtransactionsUnavailable
Inactive

get_txcontext

PropagationContext get_txcontext()
                                 throws Unavailable
The get_txcontext operation returns a PropagationContext object, which is used by one Transaction Service domain to export the current transaction to a new Transaction Service domain. An implementation of the Transaction Service may also use the PropagationContext to assist in the implementation of the is_same_transaction operation when the input Coordinator has been generated by a different Transaction Service implementation. The Unavailable exception is raised if the Transaction Service implementation chooses to restrict the availability of the PropagationContext.

Throws:
Unavailable