X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=netconf%2Fsal-netconf-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fnetconf%2Fsal%2Fconnect%2Fnetconf%2Fsal%2Ftx%2FAbstractWriteTx.java;h=3e6201df86c692ae605c7a35e312768c52c207e1;hb=45ef57fef0b7a0951ac3ed4b0a249225071fcd2c;hp=5f31400bec62fdef8adf03d806c3c67635cda0d6;hpb=2c5eea937aa51612acd6e444b3e3359598781b38;p=netconf.git diff --git a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/sal/tx/AbstractWriteTx.java b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/sal/tx/AbstractWriteTx.java index 5f31400bec..3e6201df86 100644 --- a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/sal/tx/AbstractWriteTx.java +++ b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/sal/tx/AbstractWriteTx.java @@ -5,32 +5,38 @@ * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ - package org.opendaylight.netconf.sal.connect.netconf.sal.tx; -import com.google.common.base.Optional; -import com.google.common.base.Preconditions; -import com.google.common.collect.Lists; +import static com.google.common.base.Preconditions.checkArgument; +import static com.google.common.base.Preconditions.checkState; + +import com.google.common.util.concurrent.FluentFuture; import com.google.common.util.concurrent.FutureCallback; import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.MoreExecutors; import com.google.common.util.concurrent.SettableFuture; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; +import java.util.ArrayList; +import java.util.Collection; import java.util.List; +import java.util.Optional; import java.util.concurrent.CopyOnWriteArrayList; -import javax.annotation.Nonnull; -import org.opendaylight.controller.config.util.xml.DocumentedException; -import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; -import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; -import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction; -import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult; +import org.opendaylight.mdsal.common.api.CommitInfo; +import org.opendaylight.mdsal.common.api.LogicalDatastoreType; +import org.opendaylight.mdsal.common.api.TransactionCommitFailedException; +import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction; +import org.opendaylight.mdsal.dom.api.DOMRpcResult; +import org.opendaylight.netconf.api.ModifyAction; import org.opendaylight.netconf.api.NetconfDocumentedException; import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps; import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId; +import org.opendaylight.yangtools.yang.common.ErrorSeverity; +import org.opendaylight.yangtools.yang.common.ErrorTag; +import org.opendaylight.yangtools.yang.common.ErrorType; import org.opendaylight.yangtools.yang.common.RpcError; import org.opendaylight.yangtools.yang.common.RpcResult; import org.opendaylight.yangtools.yang.common.RpcResultBuilder; -import org.opendaylight.yangtools.yang.data.api.ModifyAction; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild; import org.opendaylight.yangtools.yang.data.api.schema.MixinNode; @@ -38,23 +44,25 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -public abstract class AbstractWriteTx implements DOMDataWriteTransaction { +public abstract class AbstractWriteTx implements DOMDataTreeWriteTransaction { private static final Logger LOG = LoggerFactory.getLogger(AbstractWriteTx.class); protected final RemoteDeviceId id; protected final NetconfBaseOps netOps; protected final boolean rollbackSupport; - protected final List> resultsFutures; + protected final List> resultsFutures = new ArrayList<>(); private final List listeners = new CopyOnWriteArrayList<>(); // Allow commit to be called only once protected volatile boolean finished = false; + protected final boolean isLockAllowed; - public AbstractWriteTx(final NetconfBaseOps netOps, final RemoteDeviceId id, final boolean rollbackSupport) { - this.netOps = netOps; + public AbstractWriteTx(final RemoteDeviceId id, final NetconfBaseOps netconfOps, final boolean rollbackSupport, + final boolean isLockAllowed) { + this.netOps = netconfOps; this.id = id; this.rollbackSupport = rollbackSupport; - this.resultsFutures = Lists.newArrayList(); + this.isLockAllowed = isLockAllowed; init(); } @@ -63,7 +71,7 @@ public abstract class AbstractWriteTx implements DOMDataWriteTransaction { } protected void checkNotFinished() { - Preconditions.checkState(!isFinished(), "%s: Transaction %s already finished", id, getIdentifier()); + checkState(!isFinished(), "%s: Transaction %s already finished", id, getIdentifier()); } protected boolean isFinished() { @@ -92,7 +100,7 @@ public abstract class AbstractWriteTx implements DOMDataWriteTransaction { @Override public synchronized void put(final LogicalDatastoreType store, final YangInstanceIdentifier path, - final NormalizedNode data) { + final NormalizedNode data) { checkEditable(store); // Trying to write only mixin nodes (not visible when serialized). @@ -102,15 +110,14 @@ public abstract class AbstractWriteTx implements DOMDataWriteTransaction { return; } - final DataContainerChild editStructure = - netOps.createEditConfigStrcture(Optional.>fromNullable(data), + final DataContainerChild editStructure = netOps.createEditConfigStrcture(Optional.ofNullable(data), Optional.of(ModifyAction.REPLACE), path); - editConfig(path, Optional.fromNullable(data), editStructure, Optional.of(ModifyAction.NONE), "put"); + editConfig(path, Optional.ofNullable(data), editStructure, Optional.empty(), "put"); } @Override public synchronized void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path, - final NormalizedNode data) { + final NormalizedNode data) { checkEditable(store); // Trying to write only mixin nodes (not visible when serialized). @@ -120,17 +127,15 @@ public abstract class AbstractWriteTx implements DOMDataWriteTransaction { return; } - final DataContainerChild editStructure = - netOps.createEditConfigStrcture(Optional.>fromNullable(data), - Optional.absent(), path); - editConfig(path, Optional.fromNullable(data), editStructure, Optional.absent(), "merge"); + final DataContainerChild editStructure = netOps.createEditConfigStrcture(Optional.ofNullable(data), + Optional.empty(), path); + editConfig(path, Optional.ofNullable(data), editStructure, Optional.empty(), "merge"); } /** * Check whether the data to be written consists only from mixins. */ - private static boolean containsOnlyNonVisibleData(final YangInstanceIdentifier path, - final NormalizedNode data) { + private static boolean containsOnlyNonVisibleData(final YangInstanceIdentifier path, final NormalizedNode data) { // There's only one such case:top level list (pathArguments == 1 && data is Mixin) // any other mixin nodes are contained by a "regular" node thus visible when serialized return path.getPathArguments().size() == 1 && data instanceof MixinNode; @@ -139,11 +144,36 @@ public abstract class AbstractWriteTx implements DOMDataWriteTransaction { @Override public synchronized void delete(final LogicalDatastoreType store, final YangInstanceIdentifier path) { checkEditable(store); - final DataContainerChild editStructure = - netOps.createEditConfigStrcture(Optional.>absent(), + final DataContainerChild editStructure = netOps.createEditConfigStrcture(Optional.empty(), Optional.of(ModifyAction.DELETE), path); - editConfig(path, Optional.>absent(), - editStructure, Optional.of(ModifyAction.NONE), "delete"); + editConfig(path, Optional.empty(), editStructure, Optional.of(ModifyAction.NONE), "delete"); + } + + @Override + public FluentFuture commit() { + final SettableFuture resultFuture = SettableFuture.create(); + Futures.addCallback(commitConfiguration(), new FutureCallback>() { + @Override + public void onSuccess(final RpcResult result) { + if (!result.isSuccessful()) { + final Collection errors = result.getErrors(); + resultFuture.setException(new TransactionCommitFailedException( + String.format("Commit of transaction %s failed", getIdentifier()), + errors.toArray(new RpcError[errors.size()]))); + return; + } + + resultFuture.set(CommitInfo.empty()); + } + + @Override + public void onFailure(final Throwable failure) { + resultFuture.setException(new TransactionCommitFailedException( + String.format("Commit of transaction %s failed", getIdentifier()), failure)); + } + }, MoreExecutors.directExecutor()); + + return FluentFuture.from(resultFuture); } protected final ListenableFuture> commitConfiguration() { @@ -153,7 +183,7 @@ public abstract class AbstractWriteTx implements DOMDataWriteTransaction { final ListenableFuture> result = performCommit(); Futures.addCallback(result, new FutureCallback>() { @Override - public void onSuccess(@Nonnull final RpcResult rpcResult) { + public void onSuccess(final RpcResult rpcResult) { if (rpcResult.isSuccessful()) { listeners.forEach(txListener -> txListener.onTransactionSuccessful(AbstractWriteTx.this)); } else { @@ -176,12 +206,12 @@ public abstract class AbstractWriteTx implements DOMDataWriteTransaction { private void checkEditable(final LogicalDatastoreType store) { checkNotFinished(); - Preconditions.checkArgument(store == LogicalDatastoreType.CONFIGURATION, + checkArgument(store == LogicalDatastoreType.CONFIGURATION, "Can edit only configuration data, not %s", store); } - protected abstract void editConfig(YangInstanceIdentifier path, Optional> data, - DataContainerChild editStructure, + protected abstract void editConfig(YangInstanceIdentifier path, Optional data, + DataContainerChild editStructure, Optional defaultOperation, String operation); protected ListenableFuture> resultsToTxStatus() { @@ -189,20 +219,9 @@ public abstract class AbstractWriteTx implements DOMDataWriteTransaction { Futures.addCallback(Futures.allAsList(resultsFutures), new FutureCallback>() { @Override - public void onSuccess(@Nonnull final List domRpcResults) { - domRpcResults.forEach(domRpcResult -> { - if (!domRpcResult.getErrors().isEmpty() && !transformed.isDone()) { - final NetconfDocumentedException exception = - new NetconfDocumentedException(id + ":RPC during tx failed", - DocumentedException.ErrorType.APPLICATION, - DocumentedException.ErrorTag.OPERATION_FAILED, - DocumentedException.ErrorSeverity.ERROR); - transformed.setException(exception); - } - }); - + public void onSuccess(final List domRpcResults) { if (!transformed.isDone()) { - transformed.set(RpcResultBuilder.success().build()); + extractResult(domRpcResults, transformed); } } @@ -210,11 +229,10 @@ public abstract class AbstractWriteTx implements DOMDataWriteTransaction { public void onFailure(final Throwable throwable) { final NetconfDocumentedException exception = new NetconfDocumentedException( - id + ":RPC during tx returned an exception", + id + ":RPC during tx returned an exception" + throwable.getMessage(), + // FIXME: add proper unmask/wrap to ExecutionException new Exception(throwable), - DocumentedException.ErrorType.APPLICATION, - DocumentedException.ErrorTag.OPERATION_FAILED, - DocumentedException.ErrorSeverity.ERROR); + ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED, ErrorSeverity.ERROR); transformed.setException(exception); } }, MoreExecutors.directExecutor()); @@ -222,6 +240,37 @@ public abstract class AbstractWriteTx implements DOMDataWriteTransaction { return transformed; } + @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", + justification = "https://github.com/spotbugs/spotbugs/issues/811") + private void extractResult(final List domRpcResults, + final SettableFuture> transformed) { + ErrorType errType = ErrorType.APPLICATION; + ErrorSeverity errSeverity = ErrorSeverity.ERROR; + StringBuilder msgBuilder = new StringBuilder(); + boolean errorsEncouneterd = false; + String errorTag = "operation-failed"; + + for (final DOMRpcResult domRpcResult : domRpcResults) { + if (!domRpcResult.getErrors().isEmpty()) { + errorsEncouneterd = true; + final RpcError error = domRpcResult.getErrors().iterator().next(); + + errType = error.getErrorType().toNetconf(); + errSeverity = error.getSeverity().toNetconf(); + msgBuilder.append(error.getMessage()); + msgBuilder.append(error.getInfo()); + errorTag = error.getTag(); + } + } + if (errorsEncouneterd) { + final NetconfDocumentedException exception = new NetconfDocumentedException( + id + ":RPC during tx failed. " + msgBuilder, errType, new ErrorTag(errorTag), errSeverity); + transformed.setException(exception); + return; + } + transformed.set(RpcResultBuilder.success().build()); + } + AutoCloseable addListener(final TxListener listener) { listeners.add(listener); return () -> listeners.remove(listener);