RootContext (seata-core 2.0.0 2.0.0 API)

java.lang.Object
- io.seata.core.context.RootContext

```
public class RootContext
extends Object
```
The type Root context.

Author:

slievrly

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HIDDEN_KEY_BRANCH_TYPE` The constant HIDDEN_KEY_BRANCH_TYPE for sofa-rpc integration.
`static String`	`HIDDEN_KEY_XID` The constant HIDDEN_KEY_XID for sofa-rpc integration.
`static String`	`KEY_BRANCH_TYPE` The constant KEY_BRANCH_TYPE
`static String`	`KEY_GLOBAL_LOCK_FLAG` The constant KEY_GLOBAL_LOCK_FLAG, VALUE_GLOBAL_LOCK_FLAG
`static String`	`KEY_TIMEOUT` The constant KEY_TIMEOUT.
`static String`	`KEY_XID` The constant KEY_XID.
`static String`	`MDC_KEY_BRANCH_ID` The constant MDC_KEY_BRANCH_ID for logback
`static String`	`MDC_KEY_XID` The constant MDC_KEY_XID for logback
`static Boolean`	`VALUE_GLOBAL_LOCK_FLAG`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`assertNotInGlobalTransaction()` Assert not in global transaction.
`static void`	`bind(String xid)` Bind xid.
`static void`	`bindBranchType(BranchType branchType)` bind branch type
`static void`	`bindGlobalLockFlag()` declare local transactions will use global lock check for update/delete/insert/selectForUpdate SQL
`static Map<String,Object>`	`entries()` entry map
`static BranchType`	`getBranchType()` get the branch type
`static Integer`	`getTimeout()`
`static String`	`getXID()` Gets xid.
`static boolean`	`inGlobalTransaction()` In global transaction boolean.
`static boolean`	`inSagaBranch()` In saga branch boolean.
`static boolean`	`inTccBranch()` In tcc branch boolean.
`static boolean`	`requireGlobalLock()` requires global lock check
`static void`	`setDefaultBranchType(BranchType defaultBranchType)`
`static void`	`setTimeout(Integer timeout)`
`static String`	`unbind()` Unbind xid.
`static BranchType`	`unbindBranchType()` unbind branch type
`static void`	`unbindGlobalLockFlag()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_XID
```
public static final String KEY_XID
```
    The constant KEY_XID.
    
    See Also:
    
    Constant Field Values
  - HIDDEN_KEY_XID
```
public static final String HIDDEN_KEY_XID
```
    The constant HIDDEN_KEY_XID for sofa-rpc integration.
    
    See Also:
    
    Constant Field Values
  - KEY_TIMEOUT
```
public static final String KEY_TIMEOUT
```
    The constant KEY_TIMEOUT.
    
    See Also:
    
    Constant Field Values
  - MDC_KEY_XID
```
public static final String MDC_KEY_XID
```
    The constant MDC_KEY_XID for logback
    
    Since:
    
    1.5.0
    
    See Also:
    
    Constant Field Values
  - MDC_KEY_BRANCH_ID
```
public static final String MDC_KEY_BRANCH_ID
```
    The constant MDC_KEY_BRANCH_ID for logback
    
    Since:
    
    1.5.0
    
    See Also:
    
    Constant Field Values
  - KEY_BRANCH_TYPE
```
public static final String KEY_BRANCH_TYPE
```
    The constant KEY_BRANCH_TYPE
    
    See Also:
    
    Constant Field Values
  - HIDDEN_KEY_BRANCH_TYPE
```
public static final String HIDDEN_KEY_BRANCH_TYPE
```
    The constant HIDDEN_KEY_BRANCH_TYPE for sofa-rpc integration.
    
    See Also:
    
    Constant Field Values
  - KEY_GLOBAL_LOCK_FLAG
```
public static final String KEY_GLOBAL_LOCK_FLAG
```
    The constant KEY_GLOBAL_LOCK_FLAG, VALUE_GLOBAL_LOCK_FLAG
    
    See Also:
    
    Constant Field Values
  - VALUE_GLOBAL_LOCK_FLAG
```
public static final Boolean VALUE_GLOBAL_LOCK_FLAG
```
- Method Detail
  - setDefaultBranchType
```
public static void setDefaultBranchType(BranchType defaultBranchType)
```
  - getXID
```
@Nullable
public static String getXID()
```
    Gets xid.
    
    Returns:
    
    the xid
  - bind
```
public static void bind(@Nonnull
                        String xid)
```
    Bind xid.
    
    Parameters:
    
    xid - the xid
  - getTimeout
```
public static Integer getTimeout()
```
  - setTimeout
```
public static void setTimeout(Integer timeout)
```
  - bindGlobalLockFlag
```
public static void bindGlobalLockFlag()
```
    declare local transactions will use global lock check for update/delete/insert/selectForUpdate SQL
  - unbind
```
@Nullable
public static String unbind()
```
    Unbind xid.
    
    Returns:
    
    the previous xid or null
  - unbindGlobalLockFlag
```
public static void unbindGlobalLockFlag()
```
  - inGlobalTransaction
```
public static boolean inGlobalTransaction()
```
    In global transaction boolean.
    
    Returns:
    
    the boolean
  - inTccBranch
```
public static boolean inTccBranch()
```
    In tcc branch boolean.
    
    Returns:
    
    the boolean
  - inSagaBranch
```
public static boolean inSagaBranch()
```
    In saga branch boolean.
    
    Returns:
    
    the boolean
  - getBranchType
```
@Nullable
public static BranchType getBranchType()
```
    get the branch type
    
    Returns:
    
    the branch type String
  - bindBranchType
```
public static void bindBranchType(@Nonnull
                                  BranchType branchType)
```
    bind branch type
    
    Parameters:
    
    branchType - the branch type
  - unbindBranchType
```
@Nullable
public static BranchType unbindBranchType()
```
    unbind branch type
    
    Returns:
    
    the previous branch type or null
  - requireGlobalLock
```
public static boolean requireGlobalLock()
```
    requires global lock check
    
    Returns:
    
    the boolean
  - assertNotInGlobalTransaction
```
public static void assertNotInGlobalTransaction()
```
    Assert not in global transaction.
  - entries
```
public static Map<String,Object> entries()
```
    entry map
    
    Returns:
    
    the key-value map

Class RootContext

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_XID

HIDDEN_KEY_XID

KEY_TIMEOUT

MDC_KEY_XID

MDC_KEY_BRANCH_ID

KEY_BRANCH_TYPE

HIDDEN_KEY_BRANCH_TYPE

KEY_GLOBAL_LOCK_FLAG

VALUE_GLOBAL_LOCK_FLAG

Method Detail

setDefaultBranchType

getXID

bind

getTimeout

setTimeout

bindGlobalLockFlag

unbind

unbindGlobalLockFlag

inGlobalTransaction

inTccBranch

inSagaBranch

getBranchType

bindBranchType

unbindBranchType

requireGlobalLock

assertNotInGlobalTransaction

entries