GlobalSession (seata-server 1.5.1.1 1.5.1.1 API)

java.lang.Object
- io.seata.server.session.GlobalSession

所有已实现的接口:

SessionLifecycle, SessionStorable
```
public class GlobalSession
extends Object
implements SessionLifecycle, SessionStorable
```
The type Global session.

作者:

sharajava

嵌套类概要

嵌套类
限定符和类型类和说明

static interface GlobalSession.LockCallable<V>

static interface GlobalSession.LockRunnable

嵌套类
限定符和类型	类和说明
`static interface`	`GlobalSession.LockCallable<V>`
`static interface`	`GlobalSession.LockRunnable`

构造器概要

构造器
构造器和说明
`GlobalSession()` Instantiates a new Global session.
`GlobalSession(String applicationId, String transactionServiceGroup, String transactionName, int timeout)` Instantiates a new Global session.
`GlobalSession(String applicationId, String transactionServiceGroup, String transactionName, int timeout, boolean lazyLoadBranch)` Instantiates a new Global session.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`add(BranchSession branchSession)` Add boolean.
`void`	`addBranch(BranchSession branchSession)` Add branch.
`void`	`addSessionLifecycleListener(SessionLifecycleListener sessionLifecycleListener)` Add session lifecycle listener.
`void`	`asyncCommit()`
`void`	`begin()` Begin.
`boolean`	`canBeCommittedAsync()` Can be committed async boolean.
`void`	`changeBranchStatus(BranchSession branchSession, BranchStatus status)` Change branch status.
`void`	`changeGlobalStatus(GlobalStatus status)` Change status.
`void`	`clean()`
`void`	`close()` Close.
`void`	`closeAndClean()` Close and clean.
`static GlobalSession`	`createGlobalSession(String applicationId, String txServiceGroup, String txName, int timeout)` Create global session global session.
`void`	`decode(byte[] a)` Decode.
`byte[]`	`encode()` Encode byte [ ].
`void`	`end()` end.
`String`	`getApplicationData()` Gets application data.
`String`	`getApplicationId()` Gets application id.
`long`	`getBeginTime()` Gets begin time.
`BranchSession`	`getBranch(long branchId)` Gets branch.
`List<BranchSession>`	`getBranchSessions()`
`List<BranchSession>`	`getReverseSortedBranches()` Gets reverse sorted branches.
`List<BranchSession>`	`getSortedBranches()` Gets sorted branches.
`GlobalStatus`	`getStatus()` Gets status.
`int`	`getTimeout()` Gets timeout.
`long`	`getTransactionId()` Gets transaction id.
`String`	`getTransactionName()` Gets transaction name.
`String`	`getTransactionServiceGroup()` Gets transaction service group.
`String`	`getXid()` Gets xid.
`boolean`	`hasATBranch()` Has AT branch
`boolean`	`hasBranch()` Has branch boolean.
`boolean`	`isActive()` Is active boolean.
`boolean`	`isDeadSession()` prevent could not handle committing and rollbacking transaction
`boolean`	`isLazyLoadBranch()`
`boolean`	`isSaga()` Is saga type transaction
`boolean`	`isSuccessEnd()`
`boolean`	`isTimeout()` Is timeout boolean.
`void`	`loadBranchs()`
`void`	`lock()`
`void`	`queueToRetryCommit()`
`void`	`queueToRetryRollback()`
`boolean`	`remove(BranchSession branchSession)` Remove boolean.
`void`	`removeBranch(BranchSession branchSession)` Remove branch.
`void`	`removeSessionLifecycleListener(SessionLifecycleListener sessionLifecycleListener)` Remove session lifecycle listener.
`void`	`setActive(boolean active)` Sets active.
`void`	`setApplicationData(String applicationData)` Sets application data.
`void`	`setBeginTime(long beginTime)` Sets begin time.
`void`	`setStatus(GlobalStatus status)` Sets status.
`void`	`setTransactionId(long transactionId)` Sets transaction id.
`void`	`setXid(String xid)` Sets xid.
`String`	`toString()`
`void`	`unlock()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - GlobalSession
```
public GlobalSession()
```
    Instantiates a new Global session.
  - GlobalSession
```
public GlobalSession(String applicationId,
                     String transactionServiceGroup,
                     String transactionName,
                     int timeout,
                     boolean lazyLoadBranch)
```
    Instantiates a new Global session.
    
    参数:
    
    applicationId - the application id
    
    transactionServiceGroup - the transaction service group
    
    transactionName - the transaction name
    
    timeout - the timeout
    
    lazyLoadBranch - the lazy load branch
  - GlobalSession
```
public GlobalSession(String applicationId,
                     String transactionServiceGroup,
                     String transactionName,
                     int timeout)
```
    Instantiates a new Global session.
    
    参数:
    
    applicationId - the application id
    
    transactionServiceGroup - the transaction service group
    
    transactionName - the transaction name
    
    timeout - the timeout
- 方法详细资料
  - add
```
public boolean add(BranchSession branchSession)
```
    Add boolean.
    
    参数:
    
    branchSession - the branch session
    
    返回:
    
    the boolean
  - remove
```
public boolean remove(BranchSession branchSession)
```
    Remove boolean.
    
    参数:
    
    branchSession - the branch session
    
    返回:
    
    the boolean
  - canBeCommittedAsync
```
public boolean canBeCommittedAsync()
```
    Can be committed async boolean.
    
    返回:
    
    the boolean
  - hasATBranch
```
public boolean hasATBranch()
```
    Has AT branch
    
    返回:
    
    the boolean
  - isSaga
```
public boolean isSaga()
```
    Is saga type transaction
    
    返回:
    
    is saga
  - isTimeout
```
public boolean isTimeout()
```
    Is timeout boolean.
    
    返回:
    
    the boolean
  - isDeadSession
```
public boolean isDeadSession()
```
    prevent could not handle committing and rollbacking transaction
    
    返回:
    
    if true retry commit or roll back
  - begin
```
public void begin()
           throws TransactionException
```
    从接口复制的说明: SessionLifecycle
    
    Begin.
    
    指定者:
    
    begin 在接口中 SessionLifecycle
    
    抛出:
    
    TransactionException - the transaction exception
  - changeGlobalStatus
```
public void changeGlobalStatus(GlobalStatus status)
                        throws TransactionException
```
    从接口复制的说明: SessionLifecycle
    
    Change status.
    
    指定者:
    
    changeGlobalStatus 在接口中 SessionLifecycle
    
    参数:
    
    status - the status
    
    抛出:
    
    TransactionException - the transaction exception
  - changeBranchStatus
```
public void changeBranchStatus(BranchSession branchSession,
                               BranchStatus status)
                        throws TransactionException
```
    从接口复制的说明: SessionLifecycle
    
    Change branch status.
    
    指定者:
    
    changeBranchStatus 在接口中 SessionLifecycle
    
    参数:
    
    branchSession - the branch session
    
    status - the status
    
    抛出:
    
    TransactionException - the transaction exception
  - isActive
```
public boolean isActive()
```
    从接口复制的说明: SessionLifecycle
    
    Is active boolean.
    
    指定者:
    
    isActive 在接口中 SessionLifecycle
    
    返回:
    
    the boolean
  - close
```
public void close()
           throws TransactionException
```
    从接口复制的说明: SessionLifecycle
    
    Close.
    
    指定者:
    
    close 在接口中 SessionLifecycle
    
    抛出:
    
    TransactionException - the transaction exception
  - end
```
public void end()
         throws TransactionException
```
    从接口复制的说明: SessionLifecycle
    
    end.
    
    指定者:
    
    end 在接口中 SessionLifecycle
    
    抛出:
    
    TransactionException - the transaction exception
  - isSuccessEnd
```
public boolean isSuccessEnd()
```
  - clean
```
public void clean()
           throws TransactionException
```
    抛出:
    
    TransactionException
  - closeAndClean
```
public void closeAndClean()
                   throws TransactionException
```
    Close and clean.
    
    抛出:
    
    TransactionException - the transaction exception
  - addSessionLifecycleListener
```
public void addSessionLifecycleListener(SessionLifecycleListener sessionLifecycleListener)
```
    Add session lifecycle listener.
    
    参数:
    
    sessionLifecycleListener - the session lifecycle listener
  - removeSessionLifecycleListener
```
public void removeSessionLifecycleListener(SessionLifecycleListener sessionLifecycleListener)
```
    Remove session lifecycle listener.
    
    参数:
    
    sessionLifecycleListener - the session lifecycle listener
  - addBranch
```
public void addBranch(BranchSession branchSession)
               throws TransactionException
```
    从接口复制的说明: SessionLifecycle
    
    Add branch.
    
    指定者:
    
    addBranch 在接口中 SessionLifecycle
    
    参数:
    
    branchSession - the branch session
    
    抛出:
    
    TransactionException - the transaction exception
  - loadBranchs
```
public void loadBranchs()
```
  - removeBranch
```
public void removeBranch(BranchSession branchSession)
                  throws TransactionException
```
    从接口复制的说明: SessionLifecycle
    
    Remove branch.
    
    指定者:
    
    removeBranch 在接口中 SessionLifecycle
    
    参数:
    
    branchSession - the branch session
    
    抛出:
    
    TransactionException - the transaction exception
  - getBranch
```
public BranchSession getBranch(long branchId)
```
    Gets branch.
    
    参数:
    
    branchId - the branch id
    
    返回:
    
    the branch
  - getSortedBranches
```
public List<BranchSession> getSortedBranches()
```
    Gets sorted branches.
    
    返回:
    
    the sorted branches
  - getReverseSortedBranches
```
public List<BranchSession> getReverseSortedBranches()
```
    Gets reverse sorted branches.
    
    返回:
    
    the reverse sorted branches
  - getTransactionId
```
public long getTransactionId()
```
    Gets transaction id.
    
    返回:
    
    the transaction id
  - setTransactionId
```
public void setTransactionId(long transactionId)
```
    Sets transaction id.
    
    参数:
    
    transactionId - the transaction id
  - getStatus
```
public GlobalStatus getStatus()
```
    Gets status.
    
    返回:
    
    the status
  - setStatus
```
public void setStatus(GlobalStatus status)
```
    Sets status.
    
    参数:
    
    status - the status
  - getXid
```
public String getXid()
```
    Gets xid.
    
    返回:
    
    the xid
  - setXid
```
public void setXid(String xid)
```
    Sets xid.
    
    参数:
    
    xid - the xid
  - getApplicationId
```
public String getApplicationId()
```
    Gets application id.
    
    返回:
    
    the application id
  - getTransactionServiceGroup
```
public String getTransactionServiceGroup()
```
    Gets transaction service group.
    
    返回:
    
    the transaction service group
  - getTransactionName
```
public String getTransactionName()
```
    Gets transaction name.
    
    返回:
    
    the transaction name
  - getTimeout
```
public int getTimeout()
```
    Gets timeout.
    
    返回:
    
    the timeout
  - getBeginTime
```
public long getBeginTime()
```
    Gets begin time.
    
    返回:
    
    the begin time
  - setBeginTime
```
public void setBeginTime(long beginTime)
```
    Sets begin time.
    
    参数:
    
    beginTime - the begin time
  - getApplicationData
```
public String getApplicationData()
```
    Gets application data.
    
    返回:
    
    the application data
  - setApplicationData
```
public void setApplicationData(String applicationData)
```
    Sets application data.
    
    参数:
    
    applicationData - the application data
  - isLazyLoadBranch
```
public boolean isLazyLoadBranch()
```
  - createGlobalSession
```
public static GlobalSession createGlobalSession(String applicationId,
                                                String txServiceGroup,
                                                String txName,
                                                int timeout)
```
    Create global session global session.
    
    参数:
    
    applicationId - the application id
    
    txServiceGroup - the tx service group
    
    txName - the tx name
    
    timeout - the timeout
    
    返回:
    
    the global session
  - setActive
```
public void setActive(boolean active)
```
    Sets active.
    
    参数:
    
    active - the active
  - encode
```
public byte[] encode()
```
    从接口复制的说明: SessionStorable
    
    Encode byte [ ].
    
    指定者:
    
    encode 在接口中 SessionStorable
    
    返回:
    
    the byte [ ]
  - decode
```
public void decode(byte[] a)
```
    从接口复制的说明: SessionStorable
    
    Decode.
    
    指定者:
    
    decode 在接口中 SessionStorable
    
    参数:
    
    a - the src
  - hasBranch
```
public boolean hasBranch()
```
    Has branch boolean.
    
    返回:
    
    the boolean
  - lock
```
public void lock()
          throws TransactionException
```
    抛出:
    
    TransactionException
  - unlock
```
public void unlock()
```
  - getBranchSessions
```
public List<BranchSession> getBranchSessions()
```
  - asyncCommit
```
public void asyncCommit()
                 throws TransactionException
```
    抛出:
    
    TransactionException
  - queueToRetryCommit
```
public void queueToRetryCommit()
                        throws TransactionException
```
    抛出:
    
    TransactionException
  - queueToRetryRollback
```
public void queueToRetryRollback()
                          throws TransactionException
```
    抛出:
    
    TransactionException
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 GlobalSession

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

GlobalSession

GlobalSession

GlobalSession

方法详细资料

add

remove

canBeCommittedAsync

hasATBranch

isSaga

isTimeout

isDeadSession

begin

changeGlobalStatus

changeBranchStatus

isActive

close

end

isSuccessEnd

clean

closeAndClean

addSessionLifecycleListener

removeSessionLifecycleListener

addBranch

loadBranchs

removeBranch

getBranch

getSortedBranches

getReverseSortedBranches

getTransactionId

setTransactionId

getStatus

setStatus

getXid

setXid

getApplicationId

getTransactionServiceGroup

getTransactionName

getTimeout

getBeginTime

setBeginTime

getApplicationData

setApplicationData

isLazyLoadBranch

createGlobalSession

setActive

encode

decode

hasBranch

lock

unlock

getBranchSessions

asyncCommit

queueToRetryCommit

queueToRetryRollback

toString