com.sun.jini.mahalo
Class TxnMgrProxy

java.lang.Object
  extended by com.sun.jini.mahalo.TxnMgrProxy
All Implemented Interfaces:
Serializable, Remote, Administrable, TransactionConstants, TransactionManager, ReferentUuid
Direct Known Subclasses:
TxnMgrProxy.ConstrainableTxnMgrProxy

 class TxnMgrProxy
extends Object
implements TransactionManager, Administrable, Serializable, ReferentUuid

A TxnMgrProxy is a proxy for the transaction manager service. This is the object passed to clients of this service. It implements the TransactionManager and the Administrable interfaces.

Since:
1.1
Author:
Sun Microsystems, Inc.

Nested Class Summary
(package private) static class TxnMgrProxy.ConstrainableTxnMgrProxy
          A subclass of TxnMgrProxy that implements RemoteMethodControl.
 
Nested classes/interfaces inherited from interface net.jini.core.transaction.server.TransactionManager
TransactionManager.Created
 
Field Summary
(package private)  TxnManager backend
          The reference to the transaction manager service implementation
(package private)  Uuid proxyID
          The proxy's Uuid
private static long serialVersionUID
           
 
Fields inherited from interface net.jini.core.transaction.server.TransactionConstants
ABORTED, ACTIVE, COMMITTED, NOTCHANGED, PREPARED, VOTING
 
Constructor Summary
private TxnMgrProxy(TxnManager txnMgr, Uuid id)
          Convenience constructor.
 
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.
(package private) static TxnMgrProxy create(TxnManager txnMgr, Uuid id)
          Creates a transaction manager proxy, returning an instance that implements RemoteMethodControl if the server does too.
 boolean equals(Object o)
          Proxies for servers with the same proxyID are considered equal.
 Object getAdmin()
          Returns an object that implements whatever administration interfaces are appropriate for the particular service.
 Uuid getReferentUuid()
          Returns the universally unique identifier that has been assigned to the resource this proxy represents.
 int getState(long id)
          Returns the current state of the given transaction.
 int hashCode()
          Proxies for servers with the same proxyID have the same hash code.
 void join(long id, TransactionParticipant part, long crashCount)
          Join a transaction that is managed by this transaction manager.
private  void readObject(ObjectInputStream s)
          When an instance of this class is deserialized, this method is automatically invoked.
private  void readObjectNoData()
          During deserialization of an instance of this class, if it is found that the stream contains no data, this method is automatically invoked.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

backend

final TxnManager backend
The reference to the transaction manager service implementation


proxyID

final Uuid proxyID
The proxy's Uuid

Constructor Detail

TxnMgrProxy

private TxnMgrProxy(TxnManager txnMgr,
                    Uuid id)
Convenience constructor.

Method Detail

create

static TxnMgrProxy create(TxnManager txnMgr,
                          Uuid id)
Creates a transaction manager proxy, returning an instance that implements RemoteMethodControl if the server does too.

Parameters:
txnMgr - the server proxy
id - the ID of the server

create

public TransactionManager.Created create(long lease)
                                  throws LeaseDeniedException,
                                         RemoteException
Description copied from interface: TransactionManager
Begin a new top-level transaction.

Specified by:
create in interface TransactionManager
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

join

public void join(long id,
                 TransactionParticipant part,
                 long crashCount)
          throws UnknownTransactionException,
                 CannotJoinException,
                 CrashCountException,
                 RemoteException
Description copied from interface: TransactionManager
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.

Specified by:
join in interface TransactionManager
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

public int getState(long id)
             throws UnknownTransactionException,
                    RemoteException
Description copied from interface: TransactionManager
Returns the current state of the given transaction. The returned state can be any of the TransactionConstants values.

Specified by:
getState in interface TransactionManager
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

public void commit(long id)
            throws UnknownTransactionException,
                   CannotCommitException,
                   RemoteException
Description copied from interface: TransactionManager
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.

Specified by:
commit in interface TransactionManager
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

public void commit(long id,
                   long waitFor)
            throws UnknownTransactionException,
                   CannotCommitException,
                   TimeoutExpiredException,
                   RemoteException
Description copied from interface: TransactionManager
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.

Specified by:
commit in interface TransactionManager
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

public void abort(long id)
           throws UnknownTransactionException,
                  CannotAbortException,
                  RemoteException
Description copied from interface: TransactionManager
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.

Specified by:
abort in interface TransactionManager
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

public void abort(long id,
                  long waitFor)
           throws UnknownTransactionException,
                  CannotAbortException,
                  TimeoutExpiredException,
                  RemoteException
Description copied from interface: TransactionManager
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.

Specified by:
abort in interface TransactionManager
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

getAdmin

public Object getAdmin()
                throws RemoteException
Description copied from interface: Administrable
Returns an object that implements whatever administration interfaces are appropriate for the particular service.

Specified by:
getAdmin in interface Administrable
Returns:
an object that implements whatever administration interfaces are appropriate for the particular service.
Throws:
RemoteException
See Also:
JoinAdmin

getReferentUuid

public Uuid getReferentUuid()
Returns the universally unique identifier that has been assigned to the resource this proxy represents.

Specified by:
getReferentUuid in interface ReferentUuid
Returns:
the instance of Uuid that is associated with the resource this proxy represents. This method will not return null.
See Also:
ReferentUuid

hashCode

public int hashCode()
Proxies for servers with the same proxyID have the same hash code.

Overrides:
hashCode in class Object

equals

public boolean equals(Object o)
Proxies for servers with the same proxyID are considered equal.

Overrides:
equals in class Object

readObject

private void readObject(ObjectInputStream s)
                 throws IOException,
                        ClassNotFoundException
When an instance of this class is deserialized, this method is automatically invoked. This implementation of this method validates the state of the deserialized instance.

Throws:
InvalidObjectException - if the state of the deserialized instance of this class is found to be invalid.
IOException
ClassNotFoundException

readObjectNoData

private void readObjectNoData()
                       throws ObjectStreamException
During deserialization of an instance of this class, if it is found that the stream contains no data, this method is automatically invoked. Because it is expected that the stream should always contain data, this implementation of this method simply declares that something must be wrong.

Throws:
InvalidObjectException - to indicate that there was no data in the stream during deserialization of an instance of this class; declaring that something is wrong.
ObjectStreamException


Copyright 2007-2010, multiple authors.
Licensed under the Apache License, Version 2.0, see the NOTICE file for attributions.