1 package org.opendaylight.controller.sal.connect.netconf.sal.tx;
3 import com.google.common.base.Function;
4 import com.google.common.base.Optional;
5 import com.google.common.base.Preconditions;
6 import com.google.common.util.concurrent.ListenableFuture;
7 import java.util.concurrent.ExecutionException;
8 import java.util.concurrent.TimeUnit;
9 import java.util.concurrent.TimeoutException;
10 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
11 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
12 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
13 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
14 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
15 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionPreferences;
16 import org.opendaylight.controller.sal.connect.netconf.util.NetconfBaseOps;
17 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
18 import org.opendaylight.yangtools.yang.common.RpcResult;
19 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
21 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
24 public abstract class AbstractWriteTx implements DOMDataWriteTransaction {
26 private static final long DEFAULT_REQUEST_TIMEOUT_MINUTES = 1L;
28 protected final RemoteDeviceId id;
29 protected final NetconfBaseOps netOps;
30 protected final NetconfSessionPreferences netconfSessionPreferences;
31 // Allow commit to be called only once
32 protected boolean finished = false;
34 public AbstractWriteTx(final NetconfBaseOps netOps, final RemoteDeviceId id, final NetconfSessionPreferences netconfSessionPreferences) {
37 this.netconfSessionPreferences = netconfSessionPreferences;
41 static boolean isSuccess(final DOMRpcResult result) {
42 return result.getErrors().isEmpty();
45 protected void checkNotFinished() {
46 Preconditions.checkState(!isFinished(), "%s: Transaction %s already finished", id, getIdentifier());
49 protected boolean isFinished() {
53 protected void invokeBlocking(final String msg, final Function<NetconfBaseOps, ListenableFuture<DOMRpcResult>> op) throws NetconfDocumentedException {
55 final DOMRpcResult compositeNodeRpcResult = op.apply(netOps).get(DEFAULT_REQUEST_TIMEOUT_MINUTES, TimeUnit.MINUTES);
56 if(isSuccess(compositeNodeRpcResult) == false) {
57 throw new NetconfDocumentedException(id + ": " + msg + " failed: " + compositeNodeRpcResult.getErrors(), NetconfDocumentedException.ErrorType.application,
58 NetconfDocumentedException.ErrorTag.operation_failed, NetconfDocumentedException.ErrorSeverity.warning);
60 } catch (final InterruptedException e) {
61 Thread.currentThread().interrupt();
62 throw new RuntimeException(e);
63 } catch (final ExecutionException | TimeoutException e) {
64 throw new NetconfDocumentedException(id + ": " + msg + " failed: " + e.getMessage(), e, NetconfDocumentedException.ErrorType.application,
65 NetconfDocumentedException.ErrorTag.operation_failed, NetconfDocumentedException.ErrorSeverity.warning);
70 public synchronized boolean cancel() {
80 protected abstract void init();
82 protected abstract void cleanup();
85 public Object getIdentifier() {
90 public synchronized void put(final LogicalDatastoreType store, final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
95 netOps.createEditConfigStrcture(Optional.<NormalizedNode<?, ?>>fromNullable(data), Optional.of(ModifyAction.REPLACE), path), Optional.of(ModifyAction.NONE));
96 } catch (final NetconfDocumentedException e) {
97 handleEditException(path, data, e, "putting");
101 protected abstract void handleEditException(YangInstanceIdentifier path, NormalizedNode<?, ?> data, NetconfDocumentedException e, String editType);
102 protected abstract void handleDeleteException(YangInstanceIdentifier path, NetconfDocumentedException e);
105 public synchronized void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
106 checkEditable(store);
110 netOps.createEditConfigStrcture(Optional.<NormalizedNode<?, ?>>fromNullable(data), Optional.<ModifyAction>absent(), path), Optional.<ModifyAction>absent());
111 } catch (final NetconfDocumentedException e) {
112 handleEditException(path, data, e, "merge");
117 public synchronized void delete(final LogicalDatastoreType store, final YangInstanceIdentifier path) {
118 checkEditable(store);
122 netOps.createEditConfigStrcture(Optional.<NormalizedNode<?, ?>>absent(), Optional.of(ModifyAction.DELETE), path), Optional.of(ModifyAction.NONE));
123 } catch (final NetconfDocumentedException e) {
124 handleDeleteException(path, e);
129 public final ListenableFuture<RpcResult<TransactionStatus>> commit() {
133 return performCommit();
136 protected abstract ListenableFuture<RpcResult<TransactionStatus>> performCommit();
138 private void checkEditable(final LogicalDatastoreType store) {
140 Preconditions.checkArgument(store == LogicalDatastoreType.CONFIGURATION, "Can edit only configuration data, not %s", store);
143 protected abstract void editConfig(DataContainerChild<?, ?> editStructure, Optional<ModifyAction> defaultOperation) throws NetconfDocumentedException;