io.seata.tm.api

Class DefaultGlobalTransaction

java.lang.Object

io.seata.tm.api.DefaultGlobalTransaction

All Implemented Interfaces:

GlobalTransaction

public class DefaultGlobalTransaction
extends Object
implements GlobalTransaction

The type Default global transaction.

Method Summary

Modifier and Type	Method and Description
void	begin() Begin a new global transaction with default timeout and name.
void	begin(int timeout) Begin a new global transaction with given timeout and default name.
void	begin(int timeout, String name) Begin a new global transaction with given timeout and given name.
void	commit() Commit the global transaction.
long	getCreateTime() get create time
GlobalTransactionRole	getGlobalTransactionRole() get global transaction role.
GlobalStatus	getLocalStatus() local status of the global transaction.
GlobalStatus	getStatus() Ask TC for current status of the corresponding global transaction.
String	getXid() Get XID.
void	globalReport(GlobalStatus globalStatus) report the global transaction status.
void	resume(SuspendedResourcesHolder suspendedResourcesHolder) Resume the global transaction.
void	rollback() Rollback the global transaction.
SuspendedResourcesHolder	suspend() Suspend the global transaction.
SuspendedResourcesHolder	suspend(boolean clean) Suspend the global transaction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

begin

public void begin()
           throws TransactionException

Description copied from interface: GlobalTransaction

Begin a new global transaction with default timeout and name.

Specified by:

begin in interface GlobalTransaction

Throws:

TransactionException - Any exception that fails this will be wrapped with TransactionException and thrown out.

begin

public void begin(int timeout)
           throws TransactionException

Description copied from interface: GlobalTransaction

Begin a new global transaction with given timeout and default name.

Specified by:

begin in interface GlobalTransaction

Parameters:

timeout - Global transaction timeout in MILLISECONDS

Throws:

TransactionException - Any exception that fails this will be wrapped with TransactionException and thrown out.

begin

public void begin(int timeout,
                  String name)
           throws TransactionException

Description copied from interface: GlobalTransaction

Begin a new global transaction with given timeout and given name.

Specified by:

begin in interface GlobalTransaction

Parameters:

timeout - Given timeout in MILLISECONDS.

name - Given name.

Throws:

TransactionException - Any exception that fails this will be wrapped with TransactionException and thrown out.

commit

public void commit()
            throws TransactionException

Description copied from interface: GlobalTransaction

Commit the global transaction.

Specified by:

commit in interface GlobalTransaction

Throws:

TransactionException - Any exception that fails this will be wrapped with TransactionException and thrown out.

rollback

public void rollback()
              throws TransactionException

Description copied from interface: GlobalTransaction

Rollback the global transaction.

Specified by:

rollback in interface GlobalTransaction

Throws:

TransactionException - Any exception that fails this will be wrapped with TransactionException and thrown out.

suspend

public SuspendedResourcesHolder suspend()
                                 throws TransactionException

Description copied from interface: GlobalTransaction

Suspend the global transaction.

Specified by:

suspend in interface GlobalTransaction

Returns:

the SuspendedResourcesHolder which holds the suspend resources

Throws:

TransactionException - Any exception that fails this will be wrapped with TransactionException and thrown

See Also:

SuspendedResourcesHolder

suspend

public SuspendedResourcesHolder suspend(boolean clean)
                                 throws TransactionException

Description copied from interface: GlobalTransaction

Suspend the global transaction.

Specified by:

suspend in interface GlobalTransaction

Parameters:

clean - the clean if true, clean the transaction context. otherwise,supend only

Returns:

the SuspendedResourcesHolder which holds the suspend resources

Throws:

TransactionException - Any exception that fails this will be wrapped with TransactionException and thrown

See Also:

SuspendedResourcesHolder

resume

public void resume(SuspendedResourcesHolder suspendedResourcesHolder)
            throws TransactionException

Description copied from interface: GlobalTransaction

Resume the global transaction.

Specified by:

resume in interface GlobalTransaction

Parameters:

suspendedResourcesHolder - the suspended resources to resume

Throws:

TransactionException - Any exception that fails this will be wrapped with TransactionException and thrown out.

See Also:

SuspendedResourcesHolder

getStatus

public GlobalStatus getStatus()
                       throws TransactionException

Description copied from interface: GlobalTransaction

Ask TC for current status of the corresponding global transaction.

Specified by:

getStatus in interface GlobalTransaction

Returns:

Status of the corresponding global transaction.

Throws:

TransactionException - Any exception that fails this will be wrapped with TransactionException and thrown out.

See Also:

GlobalStatus

getXid

public String getXid()

Description copied from interface: GlobalTransaction

Get XID.

Specified by:

getXid in interface GlobalTransaction

Returns:

XID. xid

globalReport

public void globalReport(GlobalStatus globalStatus)
                  throws TransactionException

Description copied from interface: GlobalTransaction

report the global transaction status.

Specified by:

globalReport in interface GlobalTransaction

Parameters:

globalStatus - global status.

Throws:

TransactionException - Any exception that fails this will be wrapped with TransactionException and thrown out.

getLocalStatus

public GlobalStatus getLocalStatus()

Description copied from interface: GlobalTransaction

local status of the global transaction.

Specified by:

getLocalStatus in interface GlobalTransaction

Returns:

Status of the corresponding global transaction.

See Also:

GlobalStatus

getGlobalTransactionRole

public GlobalTransactionRole getGlobalTransactionRole()

Description copied from interface: GlobalTransaction

get global transaction role.

Specified by:

getGlobalTransactionRole in interface GlobalTransaction

Returns:

global transaction Role.

See Also:

GlobalTransactionRole

getCreateTime

public long getCreateTime()

Description copied from interface: GlobalTransaction

get create time

Specified by:

getCreateTime in interface GlobalTransaction

Returns:

create time