org.opendaylight.mdsal.common.api

Interface ThreePhaseCommitStep

All Known Subinterfaces:

PostCanCommitStep, PostPreCommitStep

@Beta
public interface ThreePhaseCommitStep

Common interface for implementing three-phase commit steps. Actual steps to be implemented are: PostCanCommitStep and PostPreCommitStep which allows to customize pre-commit, commit and abort actions.

Field Summary

Fields

Modifier and Type	Field and Description
static @NonNull com.google.common.util.concurrent.ListenableFuture<?>	NOOP_ABORT_FUTURE

Method Summary

Modifier and Type	Method and Description
@NonNull com.google.common.util.concurrent.ListenableFuture<?>	abort() Invoked on transaction aborted.

Field Detail

NOOP_ABORT_FUTURE

static final @NonNull com.google.common.util.concurrent.ListenableFuture<?> NOOP_ABORT_FUTURE

Method Detail

abort

@NonNull com.google.common.util.concurrent.ListenableFuture<?> abort()

Invoked on transaction aborted. This callback is invoked by three-phase commit coordinator if associated data transaction will not be commited and is being aborted. Implementation MUST rollback any changes, which were introduced by implementation based on supplied data.

Returns:

ListenableFuture which will complete once abort is completed.