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