XidGenerator (Flink : Connectors : JDBC 3.1.1-1.17 API)

All Superinterfaces:: AutoCloseable, Serializable

@Internal
public interface XidGenerator
extends Serializable, AutoCloseable

Xid generator.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`boolean`	`belongsToSubtask(Xid xid, org.apache.flink.api.common.functions.RuntimeContext ctx)`
`default void`	`close()`
`Xid`	`generateXid(org.apache.flink.api.common.functions.RuntimeContext runtimeContext, long checkpointId)`	Generate new `Xid`.
`default void`	`open()`
`static XidGenerator`	`semanticXidGenerator()`	Creates a `XidGenerator` that generates `xids` from: job id subtask index checkpoint id four random bytes generated using `SecureRandom`)

- Method Detail
  - generateXid
```
Xid generateXid(org.apache.flink.api.common.functions.RuntimeContext runtimeContext,
                long checkpointId)
```
    Generate new Xid. Requirements for generated Xids:
    
    Global Transaction Id MUST be unique across Flink job, and probably across Xids generated by other jobs and applications - depends on the usage of this class
    SHOULD be immutable
    SHOULD override hashCode and equals
    Parameters:
    
    runtimeContext - can be used for example to derive global transaction id
    
    checkpointId - can be used for example to derive global transaction id
  - open
```
default void open()
```
  - belongsToSubtask
```
boolean belongsToSubtask(Xid xid,
                         org.apache.flink.api.common.functions.RuntimeContext ctx)
```
    Returns:
    
    true if the provided transaction belongs to this subtask
  - close
```
default void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - semanticXidGenerator
```
static XidGenerator semanticXidGenerator()
```
    Creates a XidGenerator that generates xids from:
    
    job id
    subtask index
    checkpoint id
    four random bytes generated using SecureRandom)
    
    Each created XidGenerator instance MUST be used for only one Sink instance (otherwise Xids could collide).