org.jboss.tm.usertx.client
Class ServerVMClientUserTransaction

java.lang.Object
  org.jboss.tm.usertx.client.ServerVMClientUserTransaction

All Implemented Interfaces:

UserTransaction (src)

public class ServerVMClientUserTransaction

extends java.lang.Object

implements UserTransaction (src)

The client-side UserTransaction implementation for clients operating in the same VM as the server. This will delegate all UserTransaction calls to the TransactionManager of the server.

ServerVMClientUserTransaction

public ServerVMClientUserTransaction(TransactionManager (src)  tm)

getSingleton

public static ServerVMClientUserTransaction (src)  getSingleton()

Return a reference to the singleton instance.

registerTxStartedListener

public void registerTxStartedListener(ServerVMClientUserTransaction.UserTransactionStartedListener (src)  txStartedListener)

unregisterTxStartedListener

public void unregisterTxStartedListener(ServerVMClientUserTransaction.UserTransactionStartedListener (src)  txStartedListener)

begin

public void begin()
           throws NotSupportedException (src) ,
                  SystemException (src) 

Description copied from interface: UserTransaction (src)

Starts a new transaction, and associate it with the calling thread.

Specified by:

begin in interface UserTransaction (src)

Throws:

NotSupportedException (src) - If the calling thread is already associated with a transaction, and nested transactions are not supported.

SystemException (src) - If the transaction service fails in an unexpected way.

commit

public void commit()
            throws RollbackException (src) ,
                   HeuristicMixedException (src) ,
                   HeuristicRollbackException (src) ,
                   java.lang.SecurityException,
                   java.lang.IllegalStateException,
                   SystemException (src) 

Description copied from interface: UserTransaction (src)

Commit the transaction associated with the calling thread.

Specified by:

commit in interface UserTransaction (src)

Throws:

HeuristicMixedException (src) - If a heuristic decision was made and some some parts of the transaction have been committed while other parts have been rolled back.

RollbackException (src) - If the transaction was marked for rollback only, the transaction is rolled back and this exception is thrown.

java.lang.SecurityException - If the caller is not allowed to commit this transaction.

HeuristicRollbackException (src) - If a heuristic decision to roll back the transaction was made.

java.lang.IllegalStateException - If the calling thread is not associated with a transaction.

SystemException (src) - If the transaction service fails in an unexpected way.

rollback

public void rollback()
              throws java.lang.SecurityException,
                     java.lang.IllegalStateException,
                     SystemException (src) 

Description copied from interface: UserTransaction (src)

Rolls back the transaction associated with the calling thread.

Specified by:

rollback in interface UserTransaction (src)

Throws:

SystemException (src) - If the transaction service fails in an unexpected way.

java.lang.IllegalStateException - If the transaction is in a state where it cannot be rolled back. This could be because the calling thread is not associated with a transaction, or because it is in the prepared state.

java.lang.SecurityException - If the caller is not allowed to roll back this transaction.

setRollbackOnly

public void setRollbackOnly()
                     throws java.lang.IllegalStateException,
                            SystemException (src) 

Description copied from interface: UserTransaction (src)

Mark the transaction associated with the calling thread for rollback only.

Specified by:

setRollbackOnly in interface UserTransaction (src)

Throws:

SystemException (src) - If the transaction service fails in an unexpected way.

java.lang.IllegalStateException - If the transaction is in a state where it cannot be rolled back. This could be because the calling thread is not associated with a transaction, or because it is in the prepared state.

getStatus

public int getStatus()
              throws SystemException (src) 

Description copied from interface: UserTransaction (src)

Get the status of the transaction associated with the calling thread.

Specified by:

getStatus in interface UserTransaction (src)

Returns:

The status of the transaction. This is one of the Status (src) constants. If no transaction is associated with the calling thread, Status.STATUS_NO_TRANSACTION is returned.

Throws:

SystemException (src) - If the transaction service fails in an unexpected way.

setTransactionTimeout

public void setTransactionTimeout(int seconds)
                           throws SystemException (src) 

Description copied from interface: UserTransaction (src)

Change the transaction timeout for transactions started by the calling thread with the UserTransaction.begin() method.

Specified by:

setTransactionTimeout in interface UserTransaction (src)

Parameters:

seconds - The new timeout value, in seconds. If this parameter is 0, the timeout value is reset to the default value.

Throws:

SystemException (src) - If the transaction service fails in an unexpected way.