org.opendaylight.mdsal.dom.spi.store

Interface DOMStoreThreePhaseCommitCohort

All Known Implementing Classes:

ForeignShardThreePhaseCommitCohort, ForwardingDOMStoreThreePhaseCommitCohort

public interface DOMStoreThreePhaseCommitCohort

Interface implemented by the DOMStore and exposed for each DOMStoreWriteTransaction upon its transition to Ready state. The frontend (DOMStore user) uses this interface to drive the commit procedure across potentially multiple DOMStores using the Three-Phase-Commit (3PC) Protocol, as described in Three phase Commit.

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<Void>	abort() Initiates a abort phase of associated transaction on data store.
com.google.common.util.concurrent.ListenableFuture<Boolean>	canCommit() Sends transaction associated with this three phase commit instance to the participant, participant votes on the transaction, if the transaction should be committed or aborted.
com.google.common.util.concurrent.ListenableFuture<Void>	commit() Initiates a commit phase on of associated transaction on data store.
com.google.common.util.concurrent.ListenableFuture<Void>	preCommit() Initiates a pre-commit phase of associated transaction on datastore.

Method Detail

canCommit

com.google.common.util.concurrent.ListenableFuture<Boolean> canCommit()

Sends transaction associated with this three phase commit instance to the participant, participant votes on the transaction, if the transaction should be committed or aborted.

Returns:

ListenableFuture with vote of the participant. Vote Future.get() is following:

• true if transaction is approved by data store.
• false if the transaction is not approved by data store and should be aborted.

preCommit

com.google.common.util.concurrent.ListenableFuture<Void> preCommit()

Initiates a pre-commit phase of associated transaction on datastore.

This message is valid only and only if the participant responded on canCommit() call with positive response.

Returns:

ListenableFuture representing acknowledgment for participant that pre-commit message was received and processed.

abort

com.google.common.util.concurrent.ListenableFuture<Void> abort()

Initiates a abort phase of associated transaction on data store.

Returns:

ListenableFuture representing acknowledgment for participant that abort message was received.

commit

com.google.common.util.concurrent.ListenableFuture<Void> commit()

Initiates a commit phase on of associated transaction on data store.

Returns:

ListenableFuture representing acknowledgment for participant that commit message was received and commit of transaction was processed.