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