com.gigaspaces.client.transaction.xa

Class GSServerTransaction

java.lang.Object

net.jini.core.transaction.server.ServerTransaction

com.gigaspaces.client.transaction.xa.GSServerTransaction

All Implemented Interfaces:

ISwapExternalizable, SmartExternalizable, Externalizable, Serializable, ManagedTransaction, Transaction

public class GSServerTransaction
extends ServerTransaction

Title: GSServerTransaction Description: Extends the ServerTransaction to hold Object id should only be used as a key.

Version:

4.5

Author:

Guy Korland

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface net.jini.core.transaction.Transaction

Transaction.Created

Field Summary

Fields inherited from class net.jini.core.transaction.server.ServerTransaction

EMBEDDED_CRASH_COUNT, id, mgr

Constructor Summary

Constructors

Constructor and Description
GSServerTransaction() Do not use!.
GSServerTransaction(TransactionManager tm, Object id) Ctor
GSServerTransaction(TransactionManager tm, Object id, long lease)
GSServerTransaction(TransactionManager tm, Object id, TransactionParticipantDataImpl metaData)

Method Summary

Modifier and Type	Method and Description
void	abort() Abort the transaction.
void	abort(long l) Abort the transaction, waiting for participants to be notified of the decision.
void	commit() Commit the transaction.
void	commit(long l) Commit the transaction, waiting for participants to be notified of the decision.
static GSServerTransaction	create(TransactionManager tm, Object id, long lease)
ServerTransaction	createCopy()
protected ServerTransaction	createInstance() Creates an instance of this class for cloning using the ServerTransaction.createCopy() method.
boolean	equals(Object obj) Two instances are equal if they have the same transaction manager and the same transaction id.
Object	getId()
int	getState() Returns the current state of the transaction.
int	hashCode()
boolean	isXid()
void	join(TransactionParticipant part, long crashCount) Join the transaction.
void	join(TransactionParticipant part, long crashCount, int partitionId, String clusterName)
protected void	join(TransactionParticipant part, long crashCount, int partitionId, String clusterName, Object proxy)
void	readExternal(ObjectInput in)
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class net.jini.core.transaction.server.ServerTransaction

create, getLease, getMetaData, getTransactionManager, initEmbedded, isEmbeddedMgrInProxy, isEmbeddedMgrProxySideInstance, isNested, joinIfNeededAndEmbedded, joinIfNeededAndEmbedded, needParticipantsJoin, readFromSwap, setEmbeddedMgrProxySideInstance, setLease, setMetaData, writeToSwap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gigaspaces.serialization.SmartExternalizable

enabledSmartExternalizableWithReference

Constructor Detail

GSServerTransaction

public GSServerTransaction()

Do not use!. Externalizable only.

GSServerTransaction

public GSServerTransaction(TransactionManager tm,
                           Object id,
                           long lease)

GSServerTransaction

public GSServerTransaction(TransactionManager tm,
                           Object id)

Ctor

Parameters:

tm - the local transaction manager for current transaction

id - unique id for the transaction, should be Xid for XA transactions

GSServerTransaction

public GSServerTransaction(TransactionManager tm,
                           Object id,
                           TransactionParticipantDataImpl metaData)

Method Detail

create

public static GSServerTransaction create(TransactionManager tm,
                                         Object id,
                                         long lease)
                                  throws RemoteException

Throws:

RemoteException

hashCode

public int hashCode()

Overrides:

hashCode in class ServerTransaction

equals

public boolean equals(Object obj)

Description copied from class: ServerTransaction

Two instances are equal if they have the same transaction manager and the same transaction id.

Overrides:

equals in class ServerTransaction

toString

public String toString()

Overrides:

toString in class ServerTransaction

commit

public void commit()
            throws UnknownTransactionException,
                   CannotCommitException,
                   RemoteException

Description copied from interface: Transaction

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 Transaction

Overrides:

commit in class ServerTransaction

Throws:

UnknownTransactionException - if the transaction is unknown to the manager. This may be because the transaction ID was incorrect, or because the transaction has proceeded to cleanup due to an earlier commit or abort, and has been forgotten.

CannotCommitException - if the transaction reaches the ABORTED state, or is known to have previously reached that state due to an earlier commit or abort.

RemoteException - if a communication error occurs.

commit

public void commit(long l)
            throws UnknownTransactionException,
                   CannotCommitException,
                   TimeoutExpiredException,
                   RemoteException

Description copied from interface: Transaction

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 Transaction

Overrides:

commit in class ServerTransaction

Parameters:

l - 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 manager. This may be because the transaction ID was incorrect, or because the transaction has proceeded to cleanup due to an earlier commit or abort, and has been forgotten.

CannotCommitException - if the transaction reaches the ABORTED state, or is known to have previously reached that state due to an earlier commit or abort.

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

RemoteException - if a communication error occurs.

abort

public void abort()
           throws UnknownTransactionException,
                  CannotAbortException,
                  RemoteException

Description copied from interface: Transaction

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 Transaction

Overrides:

abort in class ServerTransaction

Throws:

UnknownTransactionException - if the transaction is unknown to the manager. This may be because the transaction ID was incorrect, or because the transaction has proceeded to cleanup due to an earlier commit or abort, and has been forgotten.

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

RemoteException - if a communication error occurs.

abort

public void abort(long l)
           throws UnknownTransactionException,
                  CannotAbortException,
                  TimeoutExpiredException,
                  RemoteException

Description copied from interface: Transaction

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 Transaction

Overrides:

abort in class ServerTransaction

Parameters:

l - 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 manager. This may be because the transaction ID was incorrect, or because the transaction has proceeded to cleanup due to an earlier commit or abort, and has been forgotten.

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 a communication error occurs.

join

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

Description copied from class: ServerTransaction

Join the transaction. 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.

Overrides:

join in class ServerTransaction

Parameters:

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

join

protected void join(TransactionParticipant part,
                    long crashCount,
                    int partitionId,
                    String clusterName,
                    Object proxy)
             throws UnknownTransactionException,
                    CannotJoinException,
                    CrashCountException,
                    RemoteException

Overrides:

join in class ServerTransaction

Throws:

UnknownTransactionException

CannotJoinException

CrashCountException

RemoteException

join

public void join(TransactionParticipant part,
                 long crashCount,
                 int partitionId,
                 String clusterName)
          throws UnknownTransactionException,
                 CannotJoinException,
                 CrashCountException,
                 RemoteException

Overrides:

join in class ServerTransaction

Throws:

UnknownTransactionException

CannotJoinException

CrashCountException

RemoteException

getState

public int getState()
             throws UnknownTransactionException,
                    RemoteException

Description copied from class: ServerTransaction

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

Overrides:

getState in class ServerTransaction

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:

TransactionConstants

getId

public Object getId()

Returns:

Returns the id.

isXid

public boolean isXid()

Overrides:

isXid in class ServerTransaction

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class ServerTransaction

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class ServerTransaction

Throws:

IOException

ClassNotFoundException

createInstance

protected ServerTransaction createInstance()

Description copied from class: ServerTransaction

Creates an instance of this class for cloning using the ServerTransaction.createCopy() method.

Overrides:

createInstance in class ServerTransaction

createCopy

public ServerTransaction createCopy()

Overrides:

createCopy in class ServerTransaction