Package org.apache.pulsar.client.api.transaction

Interface TransactionCoordinatorClient

All Superinterfaces:

AutoCloseable, Closeable

@Private
@Evolving
public interface TransactionCoordinatorClient
extends Closeable

Transaction coordinator client.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	TransactionCoordinatorClient.State	State of the transaction coordinator client.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_TXN_TTL_MS	Default transaction ttl in mills.

Method Summary

Modifier and Type	Method	Description
void	abort(TxnID txnID)	Abort txn.
CompletableFuture<Void>	abortAsync(TxnID txnID)	Abort txn asynchronously.
void	addPublishPartitionToTxn(TxnID txnID, List<String> partitions)	Add publish partition to txn.
CompletableFuture<Void>	addPublishPartitionToTxnAsync(TxnID txnID, List<String> partitions)	Add publish partition to txn asynchronously.
void	addSubscriptionToTxn(TxnID txnID, String topic, String subscription)	Add ack subscription to txn.
CompletableFuture<Void>	addSubscriptionToTxnAsync(TxnID txnID, String topic, String subscription)	Add ack subscription to txn asynchronously.
CompletableFuture<Void>	closeAsync()	Close the transaction meta store client asynchronous.
void	commit(TxnID txnID)	Commit txn.
CompletableFuture<Void>	commitAsync(TxnID txnID)	Commit txn asynchronously.
TransactionCoordinatorClient.State	getState()	Get current state of the transaction meta store.
TxnID	newTransaction()	Create a new transaction.
TxnID	newTransaction(long timeout, TimeUnit unit)	Create a new transaction.
CompletableFuture<TxnID>	newTransactionAsync()	Create a new transaction asynchronously.
CompletableFuture<TxnID>	newTransactionAsync(long timeout, TimeUnit unit)	Create a new transaction asynchronously.
void	start()	Start transaction meta store client.
CompletableFuture<Void>	startAsync()	Start transaction meta store client asynchronous.

Methods inherited from interface java.io.Closeable

close

Field Details

DEFAULT_TXN_TTL_MS

static final long DEFAULT_TXN_TTL_MS

Default transaction ttl in mills.

See Also:

• Constant Field Values

Method Details

start

void start()
    throws TransactionCoordinatorClientException

Start transaction meta store client.

This will create connections to transaction meta store service.

Throws:

TransactionCoordinatorClientException - exception occur while start

startAsync

CompletableFuture<Void> startAsync()

Start transaction meta store client asynchronous.

This will create connections to transaction meta store service.

Returns:

a future represents the result of start transaction meta store

closeAsync

CompletableFuture<Void> closeAsync()

Close the transaction meta store client asynchronous.

Returns:

a future represents the result of close transaction meta store

newTransaction

TxnID newTransaction()
              throws TransactionCoordinatorClientException

Create a new transaction.

Returns:

TxnID as the identifier for identifying the transaction.

Throws:

TransactionCoordinatorClientException

newTransactionAsync

CompletableFuture<TxnID> newTransactionAsync()

Create a new transaction asynchronously.

Returns:

a future represents the result of creating a new transaction. it returns TxnID as the identifier for identifying the transaction.

newTransaction

TxnID newTransaction(long timeout,
 TimeUnit unit)
              throws TransactionCoordinatorClientException

Create a new transaction.

Parameters:

timeout - timeout for new transaction

unit - time unit for new transaction

Returns:

TxnID as the identifier for identifying the transaction.

Throws:

TransactionCoordinatorClientException

newTransactionAsync

CompletableFuture<TxnID> newTransactionAsync(long timeout,
 TimeUnit unit)

Create a new transaction asynchronously.

Parameters:

timeout - timeout for new transaction

unit - time unit for new transaction

Returns:

a future represents the result of creating a new transaction. it returns TxnID as the identifier for identifying the transaction.

addPublishPartitionToTxn

void addPublishPartitionToTxn(TxnID txnID,
 List<String> partitions)
                       throws TransactionCoordinatorClientException

Add publish partition to txn.

Parameters:

txnID - txn id which add partitions to.

partitions - partitions add to the txn.

Throws:

TransactionCoordinatorClientException

addPublishPartitionToTxnAsync

CompletableFuture<Void> addPublishPartitionToTxnAsync(TxnID txnID,
 List<String> partitions)

Add publish partition to txn asynchronously.

Parameters:

txnID - txn id which add partitions to.

partitions - partitions add to the txn.

Returns:

a future represents the result of add publish partition to txn.

addSubscriptionToTxn

void addSubscriptionToTxn(TxnID txnID,
 String topic,
 String subscription)
                   throws TransactionCoordinatorClientException

Add ack subscription to txn.

Parameters:

txnID - transaction id

topic - topic name

subscription - subscription name

Throws:

TransactionCoordinatorClientException - while transaction is conflict

addSubscriptionToTxnAsync

CompletableFuture<Void> addSubscriptionToTxnAsync(TxnID txnID,
 String topic,
 String subscription)

Add ack subscription to txn asynchronously.

Parameters:

txnID - transaction id

topic - topic name

subscription - subscription name

Returns:

the future of the result

commit

void commit(TxnID txnID)
     throws TransactionCoordinatorClientException

Commit txn.

Parameters:

txnID - txn id to commit.

Throws:

TransactionCoordinatorClientException

commitAsync

CompletableFuture<Void> commitAsync(TxnID txnID)

Commit txn asynchronously.

Parameters:

txnID - txn id to commit.

Returns:

a future represents the result of commit txn.

abort

void abort(TxnID txnID)
    throws TransactionCoordinatorClientException

Abort txn.

Parameters:

txnID - txn id to abort.

Throws:

TransactionCoordinatorClientException

abortAsync

CompletableFuture<Void> abortAsync(TxnID txnID)

Abort txn asynchronously.

Parameters:

txnID - txn id to abort.

Returns:

a future represents the result of abort txn.

getState

TransactionCoordinatorClient.State getState()

Get current state of the transaction meta store.

Returns:

current state TransactionCoordinatorClient.State of the transaction meta store