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.yang.common.Empty;
  51 import org.opendaylight.yangtools.yang.common.QName;
  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.DataContainerNodeBuilder;
  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         requireNonNull(callback);
  88         requireNonNull(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     public ListenableFuture<DOMRpcResult> lockRunning(final FutureCallback<DOMRpcResult> callback) {
 103         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_LOCK_PATH,
 104             getLockContent(NETCONF_RUNNING_QNAME));
 105         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 106         return future;
 107     }
 108
 109     public ListenableFuture<DOMRpcResult> unlock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
 110         requireNonNull(callback);
 111         requireNonNull(datastore);
 112
 113         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH, getUnLockContent(datastore));
 114         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 115         return future;
 116     }
 117
 118     public ListenableFuture<DOMRpcResult> unlockRunning(final FutureCallback<DOMRpcResult> callback) {
 119         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH,
 120             getUnLockContent(NETCONF_RUNNING_QNAME));
 121         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 122         return future;
 123     }
 124
 125     public ListenableFuture<DOMRpcResult> unlockCandidate(final FutureCallback<DOMRpcResult> callback) {
 126         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH,
 127             getUnLockContent(NETCONF_CANDIDATE_QNAME));
 128         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 129         return future;
 130     }
 131
 132     public ListenableFuture<DOMRpcResult> discardChanges(final FutureCallback<DOMRpcResult> callback) {
 133         requireNonNull(callback);
 134
 135         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_DISCARD_CHANGES_PATH, null);
 136         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 137         return future;
 138     }
 139
 140     public ListenableFuture<DOMRpcResult> commit(final FutureCallback<DOMRpcResult> callback) {
 141         requireNonNull(callback);
 142
 143         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NetconfMessageTransformUtil.NETCONF_COMMIT_PATH,
 144             NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
 145         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 146         return future;
 147     }
 148
 149     public ListenableFuture<DOMRpcResult> validate(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
 150         requireNonNull(callback);
 151
 152         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NetconfMessageTransformUtil.NETCONF_VALIDATE_PATH,
 153             getValidateContent(requireNonNull(datastore)));
 154         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 155         return future;
 156     }
 157
 158     public ListenableFuture<DOMRpcResult> validateCandidate(final FutureCallback<DOMRpcResult> callback) {
 159         return validate(callback, NETCONF_CANDIDATE_QNAME);
 160     }
 161
 162     public ListenableFuture<DOMRpcResult> validateRunning(final FutureCallback<DOMRpcResult> callback) {
 163         return validate(callback, NETCONF_RUNNING_QNAME);
 164     }
 165
 166     public ListenableFuture<DOMRpcResult> copyConfig(final FutureCallback<DOMRpcResult> callback,
 167                                                      final QName source, final QName target) {
 168         requireNonNull(callback);
 169
 170         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_COPY_CONFIG_PATH,
 171             getCopyConfigContent(requireNonNull(source), requireNonNull(target)));
 172         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 173         return future;
 174     }
 175
 176     public ListenableFuture<DOMRpcResult> copyRunningToCandidate(final FutureCallback<DOMRpcResult> callback) {
 177         return copyConfig(callback, NETCONF_RUNNING_QNAME, NETCONF_CANDIDATE_QNAME);
 178     }
 179
 180     public ListenableFuture<DOMRpcResult> getConfig(final FutureCallback<DOMRpcResult> callback, final QName datastore,
 181                                                     final Optional<YangInstanceIdentifier> filterPath) {
 182         requireNonNull(callback);
 183         requireNonNull(datastore);
 184
 185         final ListenableFuture<DOMRpcResult> future;
 186         if (isFilterPresent(filterPath)) {
 187             final DataContainerChild<?, ?> node = transformer.toFilterStructure(filterPath.get());
 188             future = rpc.invokeRpc(NETCONF_GET_CONFIG_PATH,
 189                 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, getSourceNode(datastore), node));
 190         } else {
 191             future = rpc.invokeRpc(NETCONF_GET_CONFIG_PATH,
 192                 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, getSourceNode(datastore)));
 193         }
 194
 195         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 196         return future;
 197     }
 198
 199     public ListenableFuture<Optional<NormalizedNode<?, ?>>> getConfigRunningData(
 200             final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
 201         final ListenableFuture<DOMRpcResult> configRunning = getConfigRunning(callback, filterPath);
 202         return extractData(filterPath, configRunning);
 203     }
 204
 205     public ListenableFuture<Optional<NormalizedNode<?, ?>>> getData(final FutureCallback<DOMRpcResult> callback,
 206                                                                     final Optional<YangInstanceIdentifier> filterPath) {
 207         final ListenableFuture<DOMRpcResult> configRunning = get(callback, filterPath);
 208         return extractData(filterPath, configRunning);
 209     }
 210
 211     private ListenableFuture<Optional<NormalizedNode<?, ?>>> extractData(
 212             final Optional<YangInstanceIdentifier> path, final ListenableFuture<DOMRpcResult> configRunning) {
 213         return Futures.transform(configRunning, result -> {
 214             checkArgument(result.getErrors().isEmpty(), "Unable to read data: %s, errors: %s", path,
 215                 result.getErrors());
 216             final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataNode =
 217                     ((ContainerNode) result.getResult()).getChild(NetconfMessageTransformUtil.NETCONF_DATA_NODEID)
 218                     .get();
 219             return transformer.selectFromDataStructure(dataNode, path.get());
 220         }, MoreExecutors.directExecutor());
 221     }
 222
 223     public ListenableFuture<DOMRpcResult> getConfigRunning(final FutureCallback<DOMRpcResult> callback,
 224                                                            final Optional<YangInstanceIdentifier> filterPath) {
 225         return getConfig(callback, NETCONF_RUNNING_QNAME, filterPath);
 226     }
 227
 228     public ListenableFuture<DOMRpcResult> getConfigCandidate(final FutureCallback<DOMRpcResult> callback,
 229                                                              final Optional<YangInstanceIdentifier> filterPath) {
 230         return getConfig(callback, NETCONF_CANDIDATE_QNAME, filterPath);
 231     }
 232
 233     public ListenableFuture<DOMRpcResult> get(final FutureCallback<DOMRpcResult> callback,
 234                                               final Optional<YangInstanceIdentifier> filterPath) {
 235         requireNonNull(callback);
 236
 237         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_GET_PATH, isFilterPresent(filterPath)
 238             ? NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, toFilterStructure(filterPath.get(), schemaContext))
 239                     : NetconfMessageTransformUtil.GET_RPC_CONTENT);
 240         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 241         return future;
 242     }
 243
 244     private static boolean isFilterPresent(final Optional<YangInstanceIdentifier> filterPath) {
 245         return filterPath.isPresent() && !filterPath.get().isEmpty();
 246     }
 247
 248     public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
 249                                                               final DataContainerChild<?, ?> editStructure,
 250                                                               final ModifyAction modifyAction, final boolean rollback) {
 251         return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.of(modifyAction), rollback);
 252     }
 253
 254     public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
 255                                                               final DataContainerChild<?, ?> editStructure,
 256                                                               final boolean rollback) {
 257         return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.empty(), rollback);
 258     }
 259
 260     public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
 261                                                             final DataContainerChild<?, ?> editStructure,
 262                                                             final ModifyAction modifyAction, final boolean rollback) {
 263         return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.of(modifyAction), rollback);
 264     }
 265
 266     public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
 267                                                             final DataContainerChild<?, ?> editStructure,
 268                                                             final boolean rollback) {
 269         return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.empty(), rollback);
 270     }
 271
 272     public ListenableFuture<DOMRpcResult> editConfig(
 273             final FutureCallback<? super DOMRpcResult> callback, final QName datastore,
 274             final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> modifyAction,
 275             final boolean rollback) {
 276         requireNonNull(callback);
 277
 278         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_EDIT_CONFIG_PATH,
 279                 getEditConfigContent(requireNonNull(datastore), requireNonNull(editStructure), modifyAction, rollback));
 280
 281         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 282         return future;
 283     }
 284
 285     public DataContainerChild<?, ?> createEditConfigStrcture(final Optional<NormalizedNode<?, ?>> lastChild,
 286                                                              final Optional<ModifyAction> operation,
 287                                                              final YangInstanceIdentifier dataPath) {
 288         final AnyXmlNode configContent = transformer.createEditConfigStructure(lastChild, dataPath, operation);
 289         return Builders.choiceBuilder().withNodeIdentifier(EDIT_CONTENT_NODEID).withChild(configContent).build();
 290     }
 291
 292     private static ContainerNode getEditConfigContent(
 293             final QName datastore, final DataContainerChild<?, ?> editStructure,
 294             final Optional<ModifyAction> defaultOperation, final boolean rollback) {
 295         final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> editBuilder =
 296                 Builders.containerBuilder().withNodeIdentifier(NETCONF_EDIT_CONFIG_NODEID);
 297
 298         // Target
 299         editBuilder.withChild(getTargetNode(datastore));
 300
 301         // Default operation
 302         if (defaultOperation.isPresent()) {
 303             final String opString = defaultOperation.get().name().toLowerCase(Locale.ROOT);
 304             editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(NETCONF_DEFAULT_OPERATION_NODEID)
 305                     .withValue(opString).build());
 306         }
 307
 308         // Error option
 309         if (rollback) {
 310             editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(NETCONF_ERROR_OPTION_NODEID)
 311                     .withValue(ROLLBACK_ON_ERROR_OPTION).build());
 312         }
 313
 314         // Edit content
 315         editBuilder.withChild(editStructure);
 316         return editBuilder.build();
 317     }
 318
 319     public static DataContainerChild<?, ?> getSourceNode(final QName datastore) {
 320         return Builders.containerBuilder().withNodeIdentifier(NETCONF_SOURCE_NODEID)
 321                 .withChild(Builders.choiceBuilder().withNodeIdentifier(CONFIG_SOURCE_NODEID).withChild(
 322                     Builders.leafBuilder().withNodeIdentifier(toId(datastore)).withValue(Empty.getInstance()).build())
 323                     .build()).build();
 324     }
 325
 326     public static ContainerNode getLockContent(final QName datastore) {
 327         return Builders.containerBuilder().withNodeIdentifier(NETCONF_LOCK_NODEID)
 328                 .withChild(getTargetNode(datastore)).build();
 329     }
 330
 331     public static DataContainerChild<?, ?> getTargetNode(final QName datastore) {
 332         return Builders.containerBuilder().withNodeIdentifier(NETCONF_TARGET_NODEID)
 333                 .withChild(Builders.choiceBuilder().withNodeIdentifier(CONFIG_TARGET_NODEID).withChild(
 334                     Builders.leafBuilder().withNodeIdentifier(toId(datastore)).withValue(Empty.getInstance()).build())
 335                     .build()).build();
 336     }
 337
 338     public static NormalizedNode<?, ?> getCopyConfigContent(final QName source, final QName target) {
 339         return Builders.containerBuilder().withNodeIdentifier(NETCONF_COPY_CONFIG_NODEID)
 340                 .withChild(getTargetNode(target)).withChild(getSourceNode(source)).build();
 341     }
 342
 343     public static NormalizedNode<?, ?> getValidateContent(final QName source) {
 344         return Builders.containerBuilder().withNodeIdentifier(NETCONF_VALIDATE_NODEID)
 345                 .withChild(getSourceNode(source)).build();
 346     }
 347
 348     public static NormalizedNode<?, ?> getUnLockContent(final QName datastore) {
 349         return Builders.containerBuilder().withNodeIdentifier(NETCONF_UNLOCK_NODEID)
 350                 .withChild(getTargetNode(datastore)).build();
 351     }
 352
 353 }