org.omg.CosTransactions
Interface CurrentOperations

All Superinterfaces:
org.omg.CORBA.CurrentOperations
All Known Subinterfaces:
Current
All Known Implementing Classes:
Current

public interface CurrentOperations
extends org.omg.CORBA.CurrentOperations

The Current interface defines operations that allow a client of the Transaction Service to explicitly manage the association between threads and transactions. The Current interface also defines operations that simplify the use of the Transaction Service for most applications. These operations can be used to begin and end transactions and to obtain information about the current transaction. The Current interface is designed to be supported by a pseudo object whose behavior depends upon and may alter the transaction context associated with the invoking thread.


Method Summary
 void begin()
          A new transaction is created.
 void commit(boolean report_heuristics)
          If there is no transaction associated with the client thread, the NoTransaction exception is raised.
 Control get_control()
          If the client thread is not associated with a transaction, a null object reference is returned.
 Status get_status()
          If there is no transaction associated with the client thread, the StatusNoTransaction value is returned.
 java.lang.String get_transaction_name()
          If there is no transaction associated with the client thread, an empty string is returned.
 void resume(Control which)
          If the parameter is a null object reference, the client thread becomes associated with no transaction.
 void rollback_only()
          If there is no transaction associated with the client thread, the NoTransaction exception is raised.
 void rollback()
          If there is no transaction associated with the client thread, the NoTransaction exception is raised.
 void set_timeout(int seconds)
          This operation modifies a state variable associated with the target object that affects the time-out period associated with top-level transactions created by subsequent invocations of the begin operation.
 Control suspend()
          If the client thread is not associated with a transaction, a null object reference is returned.
 

Method Detail

begin

public void begin()
           throws SubtransactionsUnavailable
A new transaction is created. The transaction context of the client thread is modified so that the thread is associated with the new transaction. If the client thread is currently associated with a transaction, the new transaction is a subtransaction of that transaction. Otherwise, the new transaction is a top-level transaction.

Throws:
SubtransactionsUnavailable - The SubtransactionsUnavailable exception is raised if the client thread already has an associated transaction and the Transaction Service implementation does not support nested transactions.

commit

public void commit(boolean report_heuristics)
            throws NoTransaction,
                   HeuristicMixed,
                   HeuristicHazard
If there is no transaction associated with the client thread, the NoTransaction exception is raised. If the client thread does not have permission to commit the transaction, the standard exception NO_PERMISSION is raised. (The commit operation may be restricted to the transaction originator in some implementations.) Otherwise, the transaction associated with the client thread is completed. The effect of this request is equivalent to performing the commit operation on the corresponding Terminator object. The client thread transaction context is modified as follows: If the transaction was begun by a thread (invoking begin) in the same execution environment, then the thread?s transaction context is restored to its state prior to the begin request. Otherwise, the thread?s transaction context is set to null.

Throws:
NoTransaction
HeuristicMixed
HeuristicHazard

rollback

public void rollback()
              throws NoTransaction
If there is no transaction associated with the client thread, the NoTransaction exception is raised. If the client thread does not have permission to rollback the transaction, the standard exception NO_PERMISSION is raised. (The rollback operation may be restricted to the transaction originator in some implementations; however, the rollback_only operation, described below, is available to all transaction participants.) Otherwise, the transaction associated with the client thread is rolled back. The effect of this request is equivalent to performing the rollback operation on the corresponding Terminator object. The client thread transaction context is modified as follows: If the transaction was begun by a thread (invoking begin) in the same execution environment, then the thread?s transaction context is restored to its state prior to the begin request. Otherwise, the thread?s transaction context is set to null.

Throws:
NoTransaction

rollback_only

public void rollback_only()
                   throws NoTransaction
If there is no transaction associated with the client thread, the NoTransaction exception is raised. Otherwise, the transaction associated with the client thread is modified so that the only possible outcome is to rollback the transaction. The effect of this request is equivalent to performing the rollback_only operation on the corresponding Coordinator object.

Throws:
NoTransaction

get_status

public Status get_status()
If there is no transaction associated with the client thread, the StatusNoTransaction value is returned. Otherwise, this operation returns the status of the transaction associated with the client thread. The effect of this request is equivalent to performing the get_status operation on the corresponding Coordinator object.


get_transaction_name

public java.lang.String get_transaction_name()
If there is no transaction associated with the client thread, an empty string is returned. Otherwise, this operation returns a printable string describing the transaction. The returned string is intended to support debugging. The effect of this request is equivalent to performing the get_transaction_name operation on the corresponding Coordinator object.


set_timeout

public void set_timeout(int seconds)
This operation modifies a state variable associated with the target object that affects the time-out period associated with top-level transactions created by subsequent invocations of the begin operation. If the parameter has a nonzero value n, then top-level transactions created by subsequent invocations of begin will be subject to being rolled back if they do not complete before n seconds after their creation. If the parameter is zero, then no application specified time-out is established.


get_control

public Control get_control()
If the client thread is not associated with a transaction, a null object reference is returned. Otherwise, a Control object is returned that represents the transaction context currently associated with the client thread. This object can be given to the resume operation to reestablish this context in the same thread or a different thread. The scope within which this object is valid is implementation dependent; at a minimum, it must be usable by the client thread. This operation is not dependent on the state of the transaction; in particular, it does not raise the TRANSACTION_ROLLEDBACK exception.


suspend

public Control suspend()
If the client thread is not associated with a transaction, a null object reference is returned. Otherwise, an object is returned that represents the transaction context currently associated with the client thread. This object can be given to the resume operation to reestablish this context in the same thread or a different thread. The scope within which this object is valid is implementation dependent; at a minimum, it must be usable by the client thread. In addition, the client thread becomes associated with no transaction. This operation is not dependent on the state of the transaction; in particular, it does not raise the TRANSACTION_ROLLEDBACK exception.


resume

public void resume(Control which)
            throws InvalidControl
If the parameter is a null object reference, the client thread becomes associated with no transaction. Otherwise, if the parameter is valid in the current execution environment, the client thread becomes associated with that transaction (in place of any previous transaction). Otherwise, the InvalidControl exception is raised. This operation is not dependent on the state of the transaction; in particular, it does not raise the TRANSACTION_ROLLEDBACK exception.

Throws:
InvalidControl