org.apache.pulsar.transaction.coordinator.impl

Class MLTransactionMetadataStore

java.lang.Object

org.apache.pulsar.transaction.coordinator.TransactionMetadataStoreState

org.apache.pulsar.transaction.coordinator.impl.MLTransactionMetadataStore

All Implemented Interfaces:

TransactionMetadataStore

public class MLTransactionMetadataStore
extends TransactionMetadataStoreState
implements TransactionMetadataStore

The provider that offers managed ledger implementation of TransactionMetadataStore.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pulsar.transaction.coordinator.TransactionMetadataStoreState

TransactionMetadataStoreState.State

Constructor Summary

Constructors

Constructor and Description
MLTransactionMetadataStore(TransactionCoordinatorID tcID, MLTransactionLogImpl mlTransactionLog)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	addAckedPartitionToTxn(org.apache.pulsar.client.api.transaction.TxnID txnID, List<TransactionSubscription> txnSubscriptions) Add the acked partitions to transaction identified by txnid.
CompletableFuture<Void>	addProducedPartitionToTxn(org.apache.pulsar.client.api.transaction.TxnID txnID, List<String> partitions) Add the produced partitions to transaction identified by txnid.
CompletableFuture<Void>	closeAsync() Close the transaction metadata store.
TransactionCoordinatorID	getTransactionCoordinatorID() Get the transaction coordinator id.
CompletableFuture<TxnMeta>	getTxnMeta(org.apache.pulsar.client.api.transaction.TxnID txnID) Query the TxnMeta of a given transaction txnid.
CompletableFuture<PulsarTransactionMetadata.TxnStatus>	getTxnStatus(org.apache.pulsar.client.api.transaction.TxnID txnID) Query the PulsarTransactionMetadata.TxnStatus of a given transaction txnid.
CompletableFuture<org.apache.pulsar.client.api.transaction.TxnID>	newTransaction(long timeOut) Create a new transaction in the transaction metadata store.
static List<TransactionSubscription>	subscriptionToTxnSubscription(List<PulsarApi.Subscription> subscriptions)
static List<PulsarApi.Subscription>	txnSubscriptionToSubscription(List<TransactionSubscription> tnxSubscriptions)
CompletableFuture<Void>	updateTxnStatus(org.apache.pulsar.client.api.transaction.TxnID txnID, PulsarTransactionMetadata.TxnStatus newStatus, PulsarTransactionMetadata.TxnStatus expectedStatus) Update the transaction from expectedStatus to newStatus.

Methods inherited from class org.apache.pulsar.transaction.coordinator.TransactionMetadataStoreState

changeToCloseState, changeToInitializingState, changeToReadyState, checkIfReady, getState

Methods inherited from class java.lang.Object

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

Constructor Detail

MLTransactionMetadataStore

public MLTransactionMetadataStore(TransactionCoordinatorID tcID,
                                  MLTransactionLogImpl mlTransactionLog)

Method Detail

getTxnStatus

public CompletableFuture<PulsarTransactionMetadata.TxnStatus> getTxnStatus(org.apache.pulsar.client.api.transaction.TxnID txnID)

Description copied from interface: TransactionMetadataStore

Query the PulsarTransactionMetadata.TxnStatus of a given transaction txnid.

Specified by:

getTxnStatus in interface TransactionMetadataStore

Parameters:

txnID - transaction id

Returns:

a future represents the result of this operation. it returns PulsarTransactionMetadata.TxnStatus of the given transaction.

getTxnMeta

public CompletableFuture<TxnMeta> getTxnMeta(org.apache.pulsar.client.api.transaction.TxnID txnID)

Description copied from interface: TransactionMetadataStore

Query the TxnMeta of a given transaction txnid.

Specified by:

getTxnMeta in interface TransactionMetadataStore

Parameters:

txnID - transaction id

Returns:

a future represents the result of this operation. it returns TxnMeta of the given transaction.

newTransaction

public CompletableFuture<org.apache.pulsar.client.api.transaction.TxnID> newTransaction(long timeOut)

Description copied from interface: TransactionMetadataStore

Create a new transaction in the transaction metadata store.

Specified by:

newTransaction in interface TransactionMetadataStore

Parameters:

timeOut - the timeout duration of the transaction in mills

Returns:

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

addProducedPartitionToTxn

public CompletableFuture<Void> addProducedPartitionToTxn(org.apache.pulsar.client.api.transaction.TxnID txnID,
                                                         List<String> partitions)

Description copied from interface: TransactionMetadataStore

Add the produced partitions to transaction identified by txnid.

Specified by:

addProducedPartitionToTxn in interface TransactionMetadataStore

Parameters:

txnID - transaction id

partitions - the list of partitions that a transaction produces to

Returns:

a future represents the result of this operation

addAckedPartitionToTxn

public CompletableFuture<Void> addAckedPartitionToTxn(org.apache.pulsar.client.api.transaction.TxnID txnID,
                                                      List<TransactionSubscription> txnSubscriptions)

Description copied from interface: TransactionMetadataStore

Add the acked partitions to transaction identified by txnid.

Specified by:

addAckedPartitionToTxn in interface TransactionMetadataStore

Parameters:

txnID - transaction id

txnSubscriptions - the list of partitions that a transaction acknowledge to

Returns:

a future represents the result of the operation

updateTxnStatus

public CompletableFuture<Void> updateTxnStatus(org.apache.pulsar.client.api.transaction.TxnID txnID,
                                               PulsarTransactionMetadata.TxnStatus newStatus,
                                               PulsarTransactionMetadata.TxnStatus expectedStatus)

Description copied from interface: TransactionMetadataStore

Update the transaction from expectedStatus to newStatus.

If the current transaction status is not expectedStatus, the update will be failed.

Specified by:

updateTxnStatus in interface TransactionMetadataStore

Parameters:

txnID - TxnID for update txn status

newStatus - the new txn status that the transaction should be updated to

expectedStatus - the expected status that the transaction should be

Returns:

a future represents the result of the operation

getTransactionCoordinatorID

public TransactionCoordinatorID getTransactionCoordinatorID()

Description copied from interface: TransactionMetadataStore

Get the transaction coordinator id.

Specified by:

getTransactionCoordinatorID in interface TransactionMetadataStore

Returns:

transaction coordinator id

closeAsync

public CompletableFuture<Void> closeAsync()

Description copied from interface: TransactionMetadataStore

Close the transaction metadata store.

Specified by:

closeAsync in interface TransactionMetadataStore

Returns:

a future represents the result of this operation

txnSubscriptionToSubscription

public static List<PulsarApi.Subscription> txnSubscriptionToSubscription(List<TransactionSubscription> tnxSubscriptions)

subscriptionToTxnSubscription

public static List<TransactionSubscription> subscriptionToTxnSubscription(List<PulsarApi.Subscription> subscriptions)