X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-common-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fcommon%2Fapi%2Fdata%2FAsyncConfigurationCommitHandler.java;h=4ad46801221f7c68f75d47a57a124b3104f284f1;hb=0f69f9e83ca8602d7ad7646ff4e146f802c534c1;hp=6025e139abfd6331b3d45a399451f6b85f7b40b3;hpb=2a35e5ab8c3300757a425841d017097c1fa31e68;p=controller.git diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncConfigurationCommitHandler.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncConfigurationCommitHandler.java index 6025e139ab..4ad4680122 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncConfigurationCommitHandler.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncConfigurationCommitHandler.java @@ -7,13 +7,13 @@ */ package org.opendaylight.controller.md.sal.common.api.data; -import org.opendaylight.yangtools.concepts.Path; - import com.google.common.util.concurrent.CheckedFuture; +import org.opendaylight.yangtools.concepts.Path; /** - * User-supplied participant in three-phase commit of transaction for configuration data tree + * 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 @@ -28,9 +28,9 @@ import com.google.common.util.concurrent.CheckedFuture; public interface AsyncConfigurationCommitHandler

, D> { /** - * * Requests a can commit phase * + *

* Implementations SHOULD NOT do any blocking operation during * processing this callback. * @@ -44,11 +44,13 @@ public interface AsyncConfigurationCommitHandler

, D> { *

* + * * @param request * Commit Request submitted by client, which contains * information about modifications and read-only view as @@ -62,9 +64,9 @@ public interface AsyncConfigurationCommitHandler

, D> { ConfigurationCommitRequest request); /** - * * 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. @@ -76,33 +78,32 @@ public interface AsyncConfigurationCommitHandler

, D> { * @param * Type of data (payload), which represents data payload */ - static interface ConfigurationCommitRequest

, D> { + interface ConfigurationCommitRequest

, D> { /** - * * Read-only transaction which provides access only to configuration * data tree as if submitted transaction successfully happened and * no other concurrent modifications happened between allocation * of client transactions and write of client transactions. * + *

* Implementations of Commit Handlers are REQUIRED to use this * read-only view to access any data from configuration data tree, * in order to capture them as preconditions for this transaction. * * @return Read-only transaction which provides access only to configuration - * data tree as if submitted transaction successfully happened + * data tree as if submitted transaction successfully happened */ AsyncReadTransaction getReadOnlyView(); /** - * * Returns iteration of paths, to data which was introduced by this transaction. * * @return Iteration of paths, which was introduced by this transaction. */ Iterable

getCreatedPaths(); + /** - * * Returns iteration of paths, to data which was updated by this transaction. * * @return Iteration of paths, which was updated by this transaction. @@ -110,7 +111,6 @@ public interface AsyncConfigurationCommitHandler

, D> { Iterable

getUpdatedPaths(); /** - * * Returns iteration of paths, to data which was removed by this transaction. * * @return Iteration of paths, which was removed by this transaction.