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