net.jini.core.transaction.server
Interface TransactionManager

All Superinterfaces:

Remote, TransactionConstants

All Known Subinterfaces:

ExtendedTransactionManager, NestableTransactionManager, TxnManager

All Known Implementing Classes:

LocalTransactionManager, TxnManagerImpl, TxnMgrProxy

public interface TransactionManager
extends Remote, TransactionConstants

The interface used for managers of the two-phase commit protocol for top-level transactions. All ServerTransaction objects are governed by a transaction manager that runs this protocol.

Since:

1.0

Author:

Sun Microsystems, Inc.

See Also:

NestableTransactionManager, ServerTransaction, TransactionParticipant

Nested Class Summary

static class

TransactionManager.Created Class that holds return values from create methods.

Field Summary

Fields inherited from interface net.jini.core.transaction.server.TransactionConstants

ABORTED, ACTIVE, COMMITTED, NOTCHANGED, PREPARED, VOTING

Method Summary

void	abort(long id) Abort the transaction.
void	abort(long id, long waitFor) Abort the transaction, waiting for participants to be notified of the decision.
void	commit(long id) Commit the transaction.
void	commit(long id, long waitFor) Commit the transaction, waiting for participants to be notified of the decision.
TransactionManager.Created	create(long lease) Begin a new top-level transaction.
int	getState(long id) Returns the current state of the given transaction.
Uuid	getTransactionManagerId()
void	join(long id, TransactionParticipant part, long crashCount) Join a transaction that is managed by this transaction manager.
boolean	needParticipantsJoin() returns true if this mgr which requires that the txn participants join into the txn in contrary to a mgr which the participants are known prior to txn propagation

Method Detail

create

TransactionManager.Created create(long lease)
                                  throws LeaseDeniedException,
                                         RemoteException

Begin a new top-level transaction.

Parameters:

lease - the requested lease time for the transaction

Returns:

the transaction ID and the lease granted

Throws:

LeaseDeniedException - if this manager is unwilling to grant the requested lease time

RemoteException - if there is a communication error

needParticipantsJoin

boolean needParticipantsJoin()
                             throws RemoteException

returns true if this mgr which requires that the txn participants join into the txn in contrary to a mgr which the participants are known prior to txn propagation

Returns:

true if its a mgr which requires the txn participants to join

Throws:

RemoteException

join

void join(long id,
          TransactionParticipant part,
          long crashCount)
          throws UnknownTransactionException,
                 CannotJoinException,
                 CrashCountException,
                 RemoteException

Join a transaction that is managed by this transaction manager. The crashCount marks the state of the storage used by the participant for transactions. If the participant attempts to join a transaction more than once, the crash counts must be the same. Each system crash or other event that destroys the state of the participant's unprepared transaction storage must cause the crash count to increase by at least one.

Parameters:

id - the transaction ID

part - the participant joining the transaction

crashCount - the participant's current crash count

Throws:

UnknownTransactionException - if the transaction is unknown to the transaction manager, either because the transaction ID is incorrect or because the transaction is complete and its state has been discarded by the manager.

CannotJoinException - if the transaction is known to the manager but is no longer active.

CrashCountException - if the crash count provided for the participant differs from the crash count in a previous invocation of the same pairing of participant and transaction

RemoteException - if there is a communication error

See Also:

ServerTransaction.join(net.jini.core.transaction.server.TransactionParticipant, long)

getState

int getState(long id)
             throws UnknownTransactionException,
                    RemoteException

Returns the current state of the given transaction. The returned state can be any of the TransactionConstants values.

Parameters:

id - the transaction ID

Returns:

an int representing the state of the transaction

Throws:

UnknownTransactionException - if the transaction is unknown to the transaction manager, either because the transaction ID is incorrect or because the transaction is complete and its state has been discarded by the manager.

RemoteException - if there is a communication error

See Also:

ServerTransaction.getState(), TransactionConstants

commit

void commit(long id)
            throws UnknownTransactionException,
                   CannotCommitException,
                   RemoteException

Commit the transaction. Commit asks the transaction manager to execute the voting process with the participants. Returns if the transaction successfully reaches either the NOTCHANGED or the COMMITTED state, without waiting for the transaction manager to notify all participants of the decision. If the transaction must be aborted (because one or more participants are unable to prepare), CannotCommitException is thrown without waiting for the transaction manager to notify all participants of the decision.

Parameters:

id - the transaction ID

Throws:

UnknownTransactionException - if the transaction is unknown to the transaction manager, either because the transaction ID is incorrect or because the transaction is complete and its state has been discarded by the manager.

CannotCommitException - if the transaction is being or already has been aborted

RemoteException - if there is a communication error

commit

void commit(long id,
            long waitFor)
            throws UnknownTransactionException,
                   CannotCommitException,
                   TimeoutExpiredException,
                   RemoteException

Commit the transaction, waiting for participants to be notified of the decision. Commit asks the transaction manager to execute the voting process with the participants. Returns if the transaction successfully reaches either the NOTCHANGED or the COMMITTED state, and the transaction manager has notified all participants of the decision, before the specified timeout expires. If the transaction must be aborted (because one or more participants are unable to prepare), CannotCommitException is thrown if the transaction manager is able to notify all participants of the decision before the specified timeout expires. If the transaction manager reaches a decision, but is unable to notify all participants of that decision before the specified timeout expires, then TimeoutExpiredException is thrown. If the specified timeout expires before the transaction manager reaches a decision, TimeoutExpiredException is not thrown until the manager reaches a decision.

Parameters:

id - the transaction ID

waitFor - timeout to wait, from the start of the call until all participants have been notified of the transaction manager's decision

Throws:

UnknownTransactionException - if the transaction is unknown to the transaction manager, either because the transaction ID is incorrect or because the transaction is complete and its state has been discarded by the manager.

CannotCommitException - if the transaction is being or already has been aborted

TimeoutExpiredException - if the transaction manager reaches a decision, but is unable to notify all participants of that decision before the specified timeout expires

RemoteException - if there is a communication error

abort

void abort(long id)
           throws UnknownTransactionException,
                  CannotAbortException,
                  RemoteException

Abort the transaction. This can be called at any time by any object holding a reference to the transaction. Abort asks the transaction manager to abort the transaction and to notify each participant of the decision, resulting in them rolling back any state changes made as part of the transaction. Returns as soon as the transaction manager records the abort decision, without waiting for the transaction manager to notify all participants of the decision.

Parameters:

id - the transaction ID

Throws:

UnknownTransactionException - if the transaction is unknown to the transaction manager, either because the transaction ID is incorrect or because the transaction is complete and its state has been discarded by the manager.

CannotAbortException - if the transaction is known to have previously reached the COMMITTED state due to an earlier commit

RemoteException - if there is a communication error

abort

void abort(long id,
           long waitFor)
           throws UnknownTransactionException,
                  CannotAbortException,
                  TimeoutExpiredException,
                  RemoteException

Abort the transaction, waiting for participants to be notified of the decision. This can be called at any time by any object holding a reference to the transaction. Abort asks the transaction manager to abort the transaction and to notify each participant of the decision, resulting in them rolling back any state changes made as part of the transaction. Returns if the transaction manager records the decision and is able to notify all participants of the decision before the specified timeout expires. If the transaction manager is unable to notify all participants of the decision before the specified timeout expires, then TimeoutExpiredException is thrown.

Parameters:

id - the transaction ID

waitFor - timeout to wait, from the start of the call until all participants have been notified of the transaction manager's decision

Throws:

UnknownTransactionException - if the transaction is unknown to the transaction manager, either because the transaction ID is incorrect or because the transaction is complete and its state has been discarded by the manager.

CannotAbortException - if the transaction is known to have previously reached the COMMITTED state due to an earlier commit

TimeoutExpiredException - if the timeout expires before all participants have been notified

RemoteException - if there is a communication error

getTransactionManagerId

Uuid getTransactionManagerId()
                             throws RemoteException

Returns:

The transaction manager's unique identifier. In case the transaction manager is a LocalTransactionManager instance this method returns null.

Throws:

RemoteException