org.opendaylight.mdsal.common.api

Interface PostCanCommitStep

All Superinterfaces:

ThreePhaseCommitStep

@Beta
public interface PostCanCommitStep
extends ThreePhaseCommitStep

User implementation of steps following can-commit in three phase protocol. If no additional visibility into transaction and data being aborted or committed is needed, use NOOP implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static PostCanCommitStep	NOOP No-op implementation of abort, pre-commit and commit steps.
static com.google.common.util.concurrent.CheckedFuture<PostCanCommitStep,DataValidationFailedException>	NOOP_SUCCESS_FUTURE Successful future, returning NOOP implementation of PostCanCommitSteps.

Fields inherited from interface org.opendaylight.mdsal.common.api.ThreePhaseCommitStep

NOOP_ABORT_FUTURE

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<? extends PostPreCommitStep>	preCommit() Initiates a pre-commit of associated request Implementation MUST NOT do any blocking calls during this callback, all pre-commit preparation SHOULD happen asynchronously and MUST result in completing returned future object.

Methods inherited from interface org.opendaylight.mdsal.common.api.ThreePhaseCommitStep

abort

Field Detail

NOOP

static final PostCanCommitStep NOOP

No-op implementation of abort, pre-commit and commit steps. This implementation should be used if user logic does only validation of data and does not need to perform any actions associated with pre-commit, commit or abort.

NOOP_SUCCESS_FUTURE

static final com.google.common.util.concurrent.CheckedFuture<PostCanCommitStep,DataValidationFailedException> NOOP_SUCCESS_FUTURE

Successful future, returning NOOP implementation of PostCanCommitSteps.

Method Detail

preCommit

@Nonnull
com.google.common.util.concurrent.ListenableFuture<? extends PostPreCommitStep> preCommit()

Initiates a pre-commit of associated request Implementation MUST NOT do any blocking calls during this callback, all pre-commit preparation SHOULD happen asynchronously and MUST result in completing returned future object.

Returns:

Future which is completed once pre-commit phase for this request is finished.