org.opendaylight.controller.md.sal.common.api.data

Interface AsyncConfigurationCommitHandler<P extends org.opendaylight.yangtools.concepts.Path<P>,D>

Type Parameters:

P - Type of path (subtree identifier), which represents location in tree

D - Type of data (payload), which represents data payload

public interface AsyncConfigurationCommitHandler<P extends org.opendaylight.yangtools.concepts.Path<P>,D>

User-supplied participant in three-phase commit of transaction for configuration data tree Client-supplied implementation of commit handler for subtree, which is responsible for processing CAN-COMMIT phase of three-phase commit protocol and return CommitCohort, which provides access to additional transitions such as PRE-COMMIT, COMMIT and ABORT.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AsyncConfigurationCommitHandler.ConfigurationCommitRequest<P extends org.opendaylight.yangtools.concepts.Path<P>,D> Commit Request as was submitted by client code Commit Request contains list view of created / updated / removed path and read-only view of proposed client transaction, which may be used to retrieve modified or referenced data.

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<AsyncConfigurationCommitCohort<P,D>,DataValidationFailedException>	canCommit(AsyncConfigurationCommitHandler.ConfigurationCommitRequest<P,D> request) Requests a can commit phase Implementations SHOULD NOT do any blocking operation during processing this callback.

Method Detail

canCommit

com.google.common.util.concurrent.CheckedFuture<AsyncConfigurationCommitCohort<P,D>,DataValidationFailedException> canCommit(AsyncConfigurationCommitHandler.ConfigurationCommitRequest<P,D> request)

Requests a can commit phase Implementations SHOULD NOT do any blocking operation during processing this callback. Implementation Notes

• Implementation are REQUIRED to use request object for any data related access
• Implementations SHOULD NOT use any other state stored outside configuration subtree for validation
• Validation should happen asynchronously, outside callback call by updating returned CheckedFuture object.
• If validation (CAN_COMMIT) phase:
  • is successful - invocation of CheckedFuture.checkedGet() on returned future MUST return AsyncConfigurationCommitCohort associated with request.
  • is unsuccessful - invocation of CheckedFuture.checkedGet() must throw instance of DataValidationFailedException with human readable explanaition of error condition.

Parameters:

request - Commit Request submitted by client, which contains information about modifications and read-only view as if transaction happened.

Returns:

CheckedFuture which contains client-supplied implementation of AsyncConfigurationCommitCohort associated with submitted request, if can commit phase is successful, if can commit was unsuccessful, future must fail with TransactionCommitFailedException exception.