From 3f26555a1f1bff188860a37fe44e49ac75970353 Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Sat, 15 Feb 2014 07:05:11 +0100 Subject: [PATCH] Add a bit of documentation Change-Id: I57883cffb62f4f22de74d567f9d040a90e21a5d0 Signed-off-by: Robert Varga --- .../md/sal/common/api/TransactionStatus.java | 19 ++++++++++++++++++- ...etconfDeviceTwoPhaseCommitTransaction.java | 4 ++-- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/TransactionStatus.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/TransactionStatus.java index 92ff55175c..a8989c4ce8 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/TransactionStatus.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/TransactionStatus.java @@ -8,9 +8,26 @@ package org.opendaylight.controller.md.sal.common.api; public enum TransactionStatus { + /** + * The transaction has been freshly allocated. The user is still accessing + * it and it has not been sealed. + */ NEW, + /** + * The transaction has been completed by the user and sealed. It is currently + * awaiting execution. + */ SUBMITED, + /** + * The transaction has been successfully committed to backing store. + */ COMMITED, + /** + * The transaction has failed to commit due to some underlying issue. + */ FAILED, - CANCELED + /** + * Currently unused. + */ + CANCELED, } diff --git a/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/NetconfDeviceTwoPhaseCommitTransaction.java b/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/NetconfDeviceTwoPhaseCommitTransaction.java index 83700c892b..c5390e5409 100644 --- a/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/NetconfDeviceTwoPhaseCommitTransaction.java +++ b/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/NetconfDeviceTwoPhaseCommitTransaction.java @@ -7,11 +7,11 @@ */ package org.opendaylight.controller.sal.connect.netconf; -import static org.opendaylight.controller.sal.connect.netconf.NetconfMapping.NETCONF_OPERATION_QNAME; import static org.opendaylight.controller.sal.connect.netconf.NetconfMapping.NETCONF_CANDIDATE_QNAME; import static org.opendaylight.controller.sal.connect.netconf.NetconfMapping.NETCONF_COMMIT_QNAME; import static org.opendaylight.controller.sal.connect.netconf.NetconfMapping.NETCONF_CONFIG_QNAME; import static org.opendaylight.controller.sal.connect.netconf.NetconfMapping.NETCONF_EDIT_CONFIG_QNAME; +import static org.opendaylight.controller.sal.connect.netconf.NetconfMapping.NETCONF_OPERATION_QNAME; import static org.opendaylight.controller.sal.connect.netconf.NetconfMapping.NETCONF_RUNNING_QNAME; import static org.opendaylight.controller.sal.connect.netconf.NetconfMapping.NETCONF_TARGET_QNAME; @@ -132,7 +132,7 @@ public class NetconfDeviceTwoPhaseCommitTransaction implements DataCommitTransac } @Override - public RpcResult finish() throws IllegalStateException { + public RpcResult finish() { CompositeNodeBuilder commitInput = ImmutableCompositeNode.builder(); commitInput.setQName(NETCONF_COMMIT_QNAME); RpcResult rpcResult = device.invokeRpc(NetconfMapping.NETCONF_COMMIT_QNAME, commitInput.toInstance()); -- 2.36.6