2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.sal.connect.netconf.sal.tx;
11 import com.google.common.base.Function;
12 import com.google.common.base.Optional;
13 import com.google.common.util.concurrent.CheckedFuture;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
17 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
18 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
19 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
20 import org.opendaylight.controller.sal.connect.netconf.util.NetconfBaseOps;
21 import org.opendaylight.controller.sal.connect.netconf.util.NetconfRpcFutureCallback;
22 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
23 import org.opendaylight.yangtools.yang.common.RpcResult;
24 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
25 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
27 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
28 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
33 * Tx implementation for netconf devices that support only writable-running with no candidate
34 * The sequence goes as:
36 * <li/> Lock running datastore on tx construction
38 * <li/> Lock has to succeed, if it does not, transaction is failed
40 * <li/> Edit-config in running N times
42 * <li/> If any issue occurs during edit, datastore is unlocked and an exception is thrown
44 * <li/> Unlock running datastore on tx commit
47 public class WriteRunningTx extends AbstractWriteTx {
49 private static final Logger LOG = LoggerFactory.getLogger(WriteRunningTx.class);
51 public WriteRunningTx(final RemoteDeviceId id, final NetconfBaseOps netOps,
52 final boolean rollbackSupport, long requestTimeoutMillis) {
53 super(requestTimeoutMillis, netOps, id, rollbackSupport);
57 protected synchronized void init() {
63 invokeBlocking("Lock running", new Function<NetconfBaseOps, ListenableFuture<DOMRpcResult>>() {
65 public ListenableFuture<DOMRpcResult> apply(final NetconfBaseOps input) {
66 return input.lockRunning(new NetconfRpcFutureCallback("Lock running", id));
69 } catch (final NetconfDocumentedException e) {
70 LOG.warn("{}: Failed to initialize netconf transaction (lock running)", e);
72 throw new RuntimeException(id + ": Failed to initialize netconf transaction (lock running)", e);
77 protected void cleanup() {
82 protected void handleEditException(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data, final NetconfDocumentedException e, final String editType) {
83 LOG.warn("{}: Error " + editType + " data to (running){}, data: {}, canceling", id, path, data, e);
85 throw new RuntimeException(id + ": Error while " + editType + ": (running)" + path, e);
89 protected void handleDeleteException(final YangInstanceIdentifier path, final NetconfDocumentedException e) {
90 LOG.warn("{}: Error deleting data (running){}, canceling", id, path, e);
92 throw new RuntimeException(id + ": Error while deleting (running)" + path, e);
96 public synchronized CheckedFuture<Void, TransactionCommitFailedException> submit() {
97 final ListenableFuture<Void> commmitFutureAsVoid = Futures.transform(commit(), new Function<RpcResult<TransactionStatus>, Void>() {
99 public Void apply(final RpcResult<TransactionStatus> input) {
104 return Futures.makeChecked(commmitFutureAsVoid, new Function<Exception, TransactionCommitFailedException>() {
106 public TransactionCommitFailedException apply(final Exception input) {
107 return new TransactionCommitFailedException("Submit of transaction " + getIdentifier() + " failed", input);
113 public synchronized ListenableFuture<RpcResult<TransactionStatus>> performCommit() {
115 return Futures.immediateFuture(RpcResultBuilder.success(TransactionStatus.COMMITED).build());
119 protected void editConfig(final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> defaultOperation) throws NetconfDocumentedException {
120 invokeBlocking("Edit running", new Function<NetconfBaseOps, ListenableFuture<DOMRpcResult>>() {
122 public ListenableFuture<DOMRpcResult> apply(final NetconfBaseOps input) {
123 return defaultOperation.isPresent()
124 ? input.editConfigRunning(new NetconfRpcFutureCallback("Edit running", id), editStructure, defaultOperation.get(),
126 : input.editConfigRunning(new NetconfRpcFutureCallback("Edit running", id), editStructure,
132 private void unlock() {
134 invokeBlocking("Unlocking running", new Function<NetconfBaseOps, ListenableFuture<DOMRpcResult>>() {
136 public ListenableFuture<DOMRpcResult> apply(final NetconfBaseOps input) {
137 return input.unlockRunning(new NetconfRpcFutureCallback("Unlock running", id));
140 } catch (final NetconfDocumentedException e) {
141 LOG.warn("{}: Failed to unlock running datastore", e);
142 throw new RuntimeException(id + ": Failed to unlock running datastore", e);