netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/util/NetconfBaseOps.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.netconf.sal.connect.netconf.util;
   9
  10 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.EDIT_CONTENT_NODEID;
  11 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_CANDIDATE_QNAME;
  12 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_NODEID;
  13 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_PATH;
  14 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DEFAULT_OPERATION_NODEID;
  15 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_PATH;
  16 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_NODEID;
  17 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_PATH;
  18 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_ERROR_OPTION_NODEID;
  19 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_NODEID;
  20 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_PATH;
  21 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_NODEID;
  22 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_PATH;
  23 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_LOCK_NODEID;
  24 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_LOCK_PATH;
  25 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME;
  26 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_SOURCE_NODEID;
  27 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_TARGET_NODEID;
  28 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_UNLOCK_NODEID;
  29 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_UNLOCK_PATH;
  30 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_VALIDATE_NODEID;
  31 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.ROLLBACK_ON_ERROR_OPTION;
  32 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toFilterStructure;
  33 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toId;
  34
  35 import com.google.common.base.Preconditions;
  36 import com.google.common.util.concurrent.FluentFuture;
  37 import com.google.common.util.concurrent.FutureCallback;
  38 import com.google.common.util.concurrent.MoreExecutors;
  39 import java.util.Locale;
  40 import java.util.Optional;
  41 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  42 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  43 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade.KeepaliveDOMRpcService;
  44 import org.opendaylight.netconf.sal.connect.netconf.sal.SchemalessNetconfDeviceRpc;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.copy.config.input.target.ConfigTarget;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.get.config.input.source.ConfigSource;
  47 import org.opendaylight.yangtools.yang.common.Empty;
  48 import org.opendaylight.yangtools.yang.common.QName;
  49 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  52 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  54 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  55 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  56 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  58 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  59
  60 /**
  61  * Provides base operations for netconf e.g. get, get-config, edit-config, (un)lock, commit etc.
  62  * According to RFC-6241
  63  */
  64 public final class NetconfBaseOps {
  65     private static final NodeIdentifier CONFIG_SOURCE_NODEID = NodeIdentifier.create(ConfigSource.QNAME);
  66     private static final NodeIdentifier CONFIG_TARGET_NODEID = NodeIdentifier.create(ConfigTarget.QNAME);
  67
  68     private final DOMRpcService rpc;
  69     private final SchemaContext schemaContext;
  70     private final RpcStructureTransformer transformer;
  71
  72     public NetconfBaseOps(final DOMRpcService rpc, final SchemaContext schemaContext) {
  73         this.rpc = rpc;
  74         this.schemaContext = schemaContext;
  75
  76         if (rpc instanceof KeepaliveDOMRpcService
  77                 && ((KeepaliveDOMRpcService) rpc).getDeviceRpc() instanceof SchemalessNetconfDeviceRpc) {
  78             this.transformer = new SchemalessRpcStructureTransformer();
  79         } else {
  80             this.transformer = new NetconfRpcStructureTransformer(schemaContext);
  81         }
  82     }
  83
  84     public FluentFuture<DOMRpcResult> lock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
  85         Preconditions.checkNotNull(callback);
  86         Preconditions.checkNotNull(datastore);
  87
  88         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_LOCK_PATH, getLockContent(datastore));
  89         future.addCallback(callback, MoreExecutors.directExecutor());
  90         return future;
  91     }
  92
  93     public FluentFuture<DOMRpcResult> lockCandidate(final FutureCallback<DOMRpcResult> callback) {
  94         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_LOCK_PATH,
  95             getLockContent(NETCONF_CANDIDATE_QNAME));
  96         future.addCallback(callback, MoreExecutors.directExecutor());
  97         return future;
  98     }
  99
 100
 101     public FluentFuture<DOMRpcResult> lockRunning(final FutureCallback<DOMRpcResult> callback) {
 102         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_LOCK_PATH,
 103             getLockContent(NETCONF_RUNNING_QNAME));
 104         future.addCallback(callback, MoreExecutors.directExecutor());
 105         return future;
 106     }
 107
 108     public FluentFuture<DOMRpcResult> unlock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
 109         Preconditions.checkNotNull(callback);
 110         Preconditions.checkNotNull(datastore);
 111
 112         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH, getUnLockContent(datastore));
 113         future.addCallback(callback, MoreExecutors.directExecutor());
 114         return future;
 115     }
 116
 117     public FluentFuture<DOMRpcResult> unlockRunning(final FutureCallback<DOMRpcResult> callback) {
 118         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH,
 119             getUnLockContent(NETCONF_RUNNING_QNAME));
 120         future.addCallback(callback, MoreExecutors.directExecutor());
 121         return future;
 122     }
 123
 124     public FluentFuture<DOMRpcResult> unlockCandidate(final FutureCallback<DOMRpcResult> callback) {
 125         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH,
 126             getUnLockContent(NETCONF_CANDIDATE_QNAME));
 127         future.addCallback(callback, MoreExecutors.directExecutor());
 128         return future;
 129     }
 130
 131     public FluentFuture<DOMRpcResult> discardChanges(final FutureCallback<DOMRpcResult> callback) {
 132         Preconditions.checkNotNull(callback);
 133
 134         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_DISCARD_CHANGES_PATH, null);
 135         future.addCallback(callback, MoreExecutors.directExecutor());
 136         return future;
 137     }
 138
 139     public FluentFuture<DOMRpcResult> commit(final FutureCallback<DOMRpcResult> callback) {
 140         Preconditions.checkNotNull(callback);
 141
 142         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NetconfMessageTransformUtil.NETCONF_COMMIT_PATH,
 143             NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
 144         future.addCallback(callback, MoreExecutors.directExecutor());
 145         return future;
 146     }
 147
 148     public FluentFuture<DOMRpcResult> validate(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
 149         Preconditions.checkNotNull(callback);
 150         Preconditions.checkNotNull(datastore);
 151
 152         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NetconfMessageTransformUtil.NETCONF_VALIDATE_PATH,
 153             getValidateContent(datastore));
 154         future.addCallback(callback, MoreExecutors.directExecutor());
 155         return future;
 156     }
 157
 158     public FluentFuture<DOMRpcResult> validateCandidate(final FutureCallback<DOMRpcResult> callback) {
 159         return validate(callback, NETCONF_CANDIDATE_QNAME);
 160     }
 161
 162     public FluentFuture<DOMRpcResult> validateRunning(final FutureCallback<DOMRpcResult> callback) {
 163         return validate(callback, NETCONF_RUNNING_QNAME);
 164     }
 165
 166     public FluentFuture<DOMRpcResult> copyConfig(final FutureCallback<DOMRpcResult> callback,
 167                                                      final QName source, final QName target) {
 168         Preconditions.checkNotNull(callback);
 169         Preconditions.checkNotNull(source);
 170         Preconditions.checkNotNull(target);
 171
 172         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_COPY_CONFIG_PATH,
 173             getCopyConfigContent(source, target));
 174         future.addCallback(callback, MoreExecutors.directExecutor());
 175         return future;
 176     }
 177
 178     public FluentFuture<DOMRpcResult> copyRunningToCandidate(final FutureCallback<DOMRpcResult> callback) {
 179         return copyConfig(callback, NETCONF_RUNNING_QNAME, NETCONF_CANDIDATE_QNAME);
 180     }
 181
 182     public FluentFuture<DOMRpcResult> getConfig(final FutureCallback<DOMRpcResult> callback, final QName datastore,
 183                                                     final Optional<YangInstanceIdentifier> filterPath) {
 184         Preconditions.checkNotNull(callback);
 185         Preconditions.checkNotNull(datastore);
 186
 187         final FluentFuture<DOMRpcResult> future;
 188         if (isFilterPresent(filterPath)) {
 189             final DataContainerChild<?, ?> node = transformer.toFilterStructure(filterPath.get());
 190             future = rpc.invokeRpc(NETCONF_GET_CONFIG_PATH,
 191                 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, getSourceNode(datastore), node));
 192         } else {
 193             future = rpc.invokeRpc(NETCONF_GET_CONFIG_PATH,
 194                 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, getSourceNode(datastore)));
 195         }
 196
 197         future.addCallback(callback, MoreExecutors.directExecutor());
 198         return future;
 199     }
 200
 201     public FluentFuture<Optional<NormalizedNode<?, ?>>> getConfigRunningData(
 202             final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
 203         final FluentFuture<DOMRpcResult> configRunning = getConfigRunning(callback, filterPath);
 204         return extractData(filterPath, configRunning);
 205     }
 206
 207     public FluentFuture<Optional<NormalizedNode<?, ?>>> getData(final FutureCallback<DOMRpcResult> callback,
 208                                                                     final Optional<YangInstanceIdentifier> filterPath) {
 209         final FluentFuture<DOMRpcResult> configRunning = get(callback, filterPath);
 210         return extractData(filterPath, configRunning);
 211     }
 212
 213     private FluentFuture<Optional<NormalizedNode<?, ?>>> extractData(
 214             final Optional<YangInstanceIdentifier> path, final FluentFuture<DOMRpcResult> configRunning) {
 215         return configRunning.transform(result -> {
 216             Preconditions.checkArgument(result.getErrors().isEmpty(), "Unable to read data: %s, errors: %s", path,
 217                 result.getErrors());
 218             final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataNode =
 219                     ((ContainerNode) result.getResult()).getChild(NetconfMessageTransformUtil.NETCONF_DATA_NODEID)
 220                     .get();
 221             return transformer.selectFromDataStructure(dataNode, path.get());
 222         }, MoreExecutors.directExecutor());
 223     }
 224
 225     public FluentFuture<DOMRpcResult> getConfigRunning(final FutureCallback<DOMRpcResult> callback,
 226                                                            final Optional<YangInstanceIdentifier> filterPath) {
 227         return getConfig(callback, NETCONF_RUNNING_QNAME, filterPath);
 228     }
 229
 230     public FluentFuture<DOMRpcResult> getConfigCandidate(final FutureCallback<DOMRpcResult> callback,
 231                                                              final Optional<YangInstanceIdentifier> filterPath) {
 232         return getConfig(callback, NETCONF_CANDIDATE_QNAME, filterPath);
 233     }
 234
 235     public FluentFuture<DOMRpcResult> get(final FutureCallback<DOMRpcResult> callback,
 236                                               final Optional<YangInstanceIdentifier> filterPath) {
 237         Preconditions.checkNotNull(callback);
 238
 239         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_GET_PATH, isFilterPresent(filterPath)
 240             ? NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, toFilterStructure(filterPath.get(), schemaContext))
 241                     : NetconfMessageTransformUtil.GET_RPC_CONTENT);
 242         future.addCallback(callback, MoreExecutors.directExecutor());
 243         return future;
 244     }
 245
 246     private static boolean isFilterPresent(final Optional<YangInstanceIdentifier> filterPath) {
 247         return filterPath.isPresent() && !filterPath.get().isEmpty();
 248     }
 249
 250     public FluentFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
 251                                                               final DataContainerChild<?, ?> editStructure,
 252                                                               final ModifyAction modifyAction, final boolean rollback) {
 253         return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.of(modifyAction), rollback);
 254     }
 255
 256     public FluentFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
 257                                                               final DataContainerChild<?, ?> editStructure,
 258                                                               final boolean rollback) {
 259         return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.empty(), rollback);
 260     }
 261
 262     public FluentFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
 263                                                             final DataContainerChild<?, ?> editStructure,
 264                                                             final ModifyAction modifyAction, final boolean rollback) {
 265         return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.of(modifyAction), rollback);
 266     }
 267
 268     public FluentFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
 269                                                             final DataContainerChild<?, ?> editStructure,
 270                                                             final boolean rollback) {
 271         return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.empty(), rollback);
 272     }
 273
 274     public FluentFuture<DOMRpcResult> editConfig(
 275             final FutureCallback<? super DOMRpcResult> callback, final QName datastore,
 276             final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> modifyAction,
 277             final boolean rollback) {
 278         Preconditions.checkNotNull(editStructure);
 279         Preconditions.checkNotNull(callback);
 280         Preconditions.checkNotNull(datastore);
 281
 282         final FluentFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_EDIT_CONFIG_PATH,
 283                 getEditConfigContent(datastore, editStructure, modifyAction, rollback));
 284
 285         future.addCallback(callback, MoreExecutors.directExecutor());
 286         return future;
 287     }
 288
 289     public DataContainerChild<?, ?> createEditConfigStrcture(final Optional<NormalizedNode<?, ?>> lastChild,
 290                                                              final Optional<ModifyAction> operation,
 291                                                              final YangInstanceIdentifier dataPath) {
 292         final AnyXmlNode configContent = transformer.createEditConfigStructure(lastChild, dataPath, operation);
 293         return Builders.choiceBuilder().withNodeIdentifier(EDIT_CONTENT_NODEID).withChild(configContent).build();
 294     }
 295
 296     private static ContainerNode getEditConfigContent(
 297             final QName datastore, final DataContainerChild<?, ?> editStructure,
 298             final Optional<ModifyAction> defaultOperation, final boolean rollback) {
 299         final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> editBuilder =
 300                 Builders.containerBuilder().withNodeIdentifier(NETCONF_EDIT_CONFIG_NODEID);
 301
 302         // Target
 303         editBuilder.withChild(getTargetNode(datastore));
 304
 305         // Default operation
 306         if (defaultOperation.isPresent()) {
 307             final String opString = defaultOperation.get().name().toLowerCase(Locale.ROOT);
 308             editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(NETCONF_DEFAULT_OPERATION_NODEID)
 309                     .withValue(opString).build());
 310         }
 311
 312         // Error option
 313         if (rollback) {
 314             editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(NETCONF_ERROR_OPTION_NODEID)
 315                     .withValue(ROLLBACK_ON_ERROR_OPTION).build());
 316         }
 317
 318         // Edit content
 319         editBuilder.withChild(editStructure);
 320         return editBuilder.build();
 321     }
 322
 323     public static DataContainerChild<?, ?> getSourceNode(final QName datastore) {
 324         return Builders.containerBuilder().withNodeIdentifier(NETCONF_SOURCE_NODEID)
 325                 .withChild(Builders.choiceBuilder().withNodeIdentifier(CONFIG_SOURCE_NODEID).withChild(
 326                     Builders.leafBuilder().withNodeIdentifier(toId(datastore)).withValue(Empty.getInstance()).build())
 327                     .build()).build();
 328     }
 329
 330     public static ContainerNode getLockContent(final QName datastore) {
 331         return Builders.containerBuilder().withNodeIdentifier(NETCONF_LOCK_NODEID)
 332                 .withChild(getTargetNode(datastore)).build();
 333     }
 334
 335     public static DataContainerChild<?, ?> getTargetNode(final QName datastore) {
 336         return Builders.containerBuilder().withNodeIdentifier(NETCONF_TARGET_NODEID)
 337                 .withChild(Builders.choiceBuilder().withNodeIdentifier(CONFIG_TARGET_NODEID).withChild(
 338                     Builders.leafBuilder().withNodeIdentifier(toId(datastore)).withValue(Empty.getInstance()).build())
 339                     .build()).build();
 340     }
 341
 342     public static NormalizedNode<?, ?> getCopyConfigContent(final QName source, final QName target) {
 343         return Builders.containerBuilder().withNodeIdentifier(NETCONF_COPY_CONFIG_NODEID)
 344                 .withChild(getTargetNode(target)).withChild(getSourceNode(source)).build();
 345     }
 346
 347     public static NormalizedNode<?, ?> getValidateContent(final QName source) {
 348         return Builders.containerBuilder().withNodeIdentifier(NETCONF_VALIDATE_NODEID)
 349                 .withChild(getSourceNode(source)).build();
 350     }
 351
 352     public static NormalizedNode<?, ?> getUnLockContent(final QName datastore) {
 353         return Builders.containerBuilder().withNodeIdentifier(NETCONF_UNLOCK_NODEID)
 354                 .withChild(getTargetNode(datastore)).build();
 355     }
 356
 357 }