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.NETCONF_CANDIDATE_QNAME;
  12 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_QNAME;
  13 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DEFAULT_OPERATION_QNAME;
  14 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_QNAME;
  15 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_QNAME;
  16 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_ERROR_OPTION_QNAME;
  17 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME;
  18 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
  19 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_LOCK_QNAME;
  20 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME;
  21 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_SOURCE_QNAME;
  22 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_TARGET_QNAME;
  23 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_UNLOCK_QNAME;
  24 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_VALIDATE_QNAME;
  25 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.ROLLBACK_ON_ERROR_OPTION;
  26 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toFilterStructure;
  27 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toId;
  28 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toPath;
  29
  30 import com.google.common.base.Optional;
  31 import com.google.common.base.Preconditions;
  32 import com.google.common.util.concurrent.FutureCallback;
  33 import com.google.common.util.concurrent.Futures;
  34 import com.google.common.util.concurrent.ListenableFuture;
  35 import com.google.common.util.concurrent.MoreExecutors;
  36 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  37 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  38 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade.KeepaliveDOMRpcService;
  39 import org.opendaylight.netconf.sal.connect.netconf.sal.SchemalessNetconfDeviceRpc;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.copy.config.input.target.ConfigTarget;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.edit.config.input.EditContent;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.get.config.input.source.ConfigSource;
  43 import org.opendaylight.yangtools.yang.common.Empty;
  44 import org.opendaylight.yangtools.yang.common.QName;
  45 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  47 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  50 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  51 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  52 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  53 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  54
  55 /**
  56  * Provides base operations for netconf e.g. get, get-config, edit-config, (un)lock, commit etc.
  57  * According to RFC-6241
  58  */
  59 public final class NetconfBaseOps {
  60
  61     private final DOMRpcService rpc;
  62     private final SchemaContext schemaContext;
  63     private final RpcStructureTransformer transformer;
  64
  65     public NetconfBaseOps(final DOMRpcService rpc, final SchemaContext schemaContext) {
  66         this.rpc = rpc;
  67         this.schemaContext = schemaContext;
  68
  69         if (rpc instanceof KeepaliveDOMRpcService
  70                 && ((KeepaliveDOMRpcService) rpc).getDeviceRpc() instanceof SchemalessNetconfDeviceRpc) {
  71             this.transformer = new SchemalessRpcStructureTransformer();
  72         } else {
  73             this.transformer = new NetconfRpcStructureTransformer(schemaContext);
  74         }
  75     }
  76
  77     public ListenableFuture<DOMRpcResult> lock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
  78         Preconditions.checkNotNull(callback);
  79         Preconditions.checkNotNull(datastore);
  80
  81         final ListenableFuture<DOMRpcResult> future =
  82                 rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(datastore));
  83         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
  84         return future;
  85     }
  86
  87     public ListenableFuture<DOMRpcResult> lockCandidate(final FutureCallback<DOMRpcResult> callback) {
  88         final ListenableFuture<DOMRpcResult> future =
  89                 rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(NETCONF_CANDIDATE_QNAME));
  90         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
  91         return future;
  92     }
  93
  94
  95     public ListenableFuture<DOMRpcResult> lockRunning(final FutureCallback<DOMRpcResult> callback) {
  96         final ListenableFuture<DOMRpcResult> future =
  97                 rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(NETCONF_RUNNING_QNAME));
  98         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
  99         return future;
 100     }
 101
 102     public ListenableFuture<DOMRpcResult> unlock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
 103         Preconditions.checkNotNull(callback);
 104         Preconditions.checkNotNull(datastore);
 105
 106         final ListenableFuture<DOMRpcResult> future =
 107                 rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(datastore));
 108         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 109         return future;
 110     }
 111
 112     public ListenableFuture<DOMRpcResult> unlockRunning(final FutureCallback<DOMRpcResult> callback) {
 113         final ListenableFuture<DOMRpcResult> future =
 114                 rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(NETCONF_RUNNING_QNAME));
 115         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 116         return future;
 117     }
 118
 119     public ListenableFuture<DOMRpcResult> unlockCandidate(final FutureCallback<DOMRpcResult> callback) {
 120         final ListenableFuture<DOMRpcResult> future =
 121                 rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(NETCONF_CANDIDATE_QNAME));
 122         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 123         return future;
 124     }
 125
 126     public ListenableFuture<DOMRpcResult> discardChanges(final FutureCallback<DOMRpcResult> callback) {
 127         Preconditions.checkNotNull(callback);
 128
 129         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_DISCARD_CHANGES_QNAME), null);
 130         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 131         return future;
 132     }
 133
 134     public ListenableFuture<DOMRpcResult> commit(final FutureCallback<DOMRpcResult> callback) {
 135         Preconditions.checkNotNull(callback);
 136
 137         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(
 138             toPath(NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME), NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
 139         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 140         return future;
 141     }
 142
 143     public ListenableFuture<DOMRpcResult> validate(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
 144         Preconditions.checkNotNull(callback);
 145         Preconditions.checkNotNull(datastore);
 146
 147         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(
 148                 toPath(NetconfMessageTransformUtil.NETCONF_VALIDATE_QNAME), getValidateContent(datastore));
 149         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 150         return future;
 151     }
 152
 153     public ListenableFuture<DOMRpcResult> validateCandidate(final FutureCallback<DOMRpcResult> callback) {
 154         return validate(callback, NETCONF_CANDIDATE_QNAME);
 155     }
 156
 157
 158     public ListenableFuture<DOMRpcResult> validateRunning(final FutureCallback<DOMRpcResult> callback) {
 159         return validate(callback, NETCONF_RUNNING_QNAME);
 160     }
 161
 162     public ListenableFuture<DOMRpcResult> copyConfig(final FutureCallback<DOMRpcResult> callback,
 163                                                      final QName source, final QName target) {
 164         Preconditions.checkNotNull(callback);
 165         Preconditions.checkNotNull(source);
 166         Preconditions.checkNotNull(target);
 167
 168         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(
 169                 toPath(NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_QNAME), getCopyConfigContent(source, target));
 170         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 171         return future;
 172     }
 173
 174     public ListenableFuture<DOMRpcResult> copyRunningToCandidate(final FutureCallback<DOMRpcResult> callback) {
 175         return copyConfig(callback, NETCONF_RUNNING_QNAME, NETCONF_CANDIDATE_QNAME);
 176     }
 177
 178     public ListenableFuture<DOMRpcResult> getConfig(final FutureCallback<DOMRpcResult> callback, final QName datastore,
 179                                                     final Optional<YangInstanceIdentifier> filterPath) {
 180         Preconditions.checkNotNull(callback);
 181         Preconditions.checkNotNull(datastore);
 182
 183         final ListenableFuture<DOMRpcResult> future;
 184         if (isFilterPresent(filterPath)) {
 185             final DataContainerChild<?, ?> node = transformer.toFilterStructure(filterPath.get());
 186             future = rpc.invokeRpc(toPath(NETCONF_GET_CONFIG_QNAME),
 187                             NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, getSourceNode(datastore), node));
 188         } else {
 189             future = rpc.invokeRpc(toPath(NETCONF_GET_CONFIG_QNAME),
 190                             NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, getSourceNode(datastore)));
 191         }
 192
 193         Futures.addCallback(future, callback, MoreExecutors.directExecutor());
 194         return future;
 195     }
 196
 197     public ListenableFuture<Optional<NormalizedNode<?, ?>>> getConfigRunningData(
 198             final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
 199         final ListenableFuture<DOMRpcResult> configRunning = getConfigRunning(callback, filterPath);
 200         return extractData(filterPath, configRunning);
 201     }
 202
 203     public ListenableFuture<Optional<NormalizedNode<?, ?>>> getData(final FutureCallback<DOMRpcResult> callback,
 204                                                                     final Optional<YangInstanceIdentifier> filterPath) {
 205         final ListenableFuture<DOMRpcResult> configRunning = get(callback, filterPath);
 206         return extractData(filterPath, configRunning);
 207     }
 208
 209     private ListenableFuture<Optional<NormalizedNode<?, ?>>> extractData(
 210             final Optional<YangInstanceIdentifier> path, final ListenableFuture<DOMRpcResult> configRunning) {
 211         return Futures.transform(configRunning, result -> {
 212             Preconditions.checkArgument(
 213                     result.getErrors().isEmpty(), "Unable to read data: %s, errors: %s", path, result.getErrors());
 214             final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataNode =
 215                     ((ContainerNode) result.getResult()).getChild(
 216                             NetconfMessageTransformUtil.toId(NetconfMessageTransformUtil.NETCONF_DATA_QNAME)).get();
 217             return transformer.selectFromDataStructure(dataNode, path.get());
 218         }, MoreExecutors.directExecutor());
 219     }
 220
 221     public ListenableFuture<DOMRpcResult> getConfigRunning(final FutureCallback<DOMRpcResult> callback,
 222                                                            final Optional<YangInstanceIdentifier> filterPath) {
 223         return getConfig(callback, NETCONF_RUNNING_QNAME, filterPath);
 224     }
 225
 226     public ListenableFuture<DOMRpcResult> getConfigCandidate(final FutureCallback<DOMRpcResult> callback,
 227                                                              final Optional<YangInstanceIdentifier> filterPath) {
 228         return getConfig(callback, NETCONF_CANDIDATE_QNAME, filterPath);
 229     }
 230
 231     public ListenableFuture<DOMRpcResult> get(final FutureCallback<DOMRpcResult> callback,
 232                                               final Optional<YangInstanceIdentifier> filterPath) {
 233         Preconditions.checkNotNull(callback);
 234
 235         final ListenableFuture<DOMRpcResult> future;
 236
 237         future = isFilterPresent(filterPath)
 238                 ? rpc.invokeRpc(toPath(NETCONF_GET_QNAME),
 239                 NetconfMessageTransformUtil.wrap(NETCONF_GET_QNAME, toFilterStructure(filterPath.get(), schemaContext)))
 240                 : rpc.invokeRpc(toPath(NETCONF_GET_QNAME), NetconfMessageTransformUtil.GET_RPC_CONTENT);
 241
 242         Futures.addCallback(future, 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 ListenableFuture<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 ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
 257                                                               final DataContainerChild<?, ?> editStructure,
 258                                                               final boolean rollback) {
 259         return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.<ModifyAction>absent(), rollback);
 260     }
 261
 262     public ListenableFuture<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 ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
 269                                                             final DataContainerChild<?, ?> editStructure,
 270                                                             final boolean rollback) {
 271         return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.<ModifyAction>absent(), rollback);
 272     }
 273
 274     public ListenableFuture<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 ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_EDIT_CONFIG_QNAME),
 283                 getEditConfigContent(datastore, editStructure, modifyAction, rollback));
 284
 285         Futures.addCallback(future, 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(toId(EditContent.QNAME)).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 DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> editBuilder =
 300                 Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_EDIT_CONFIG_QNAME));
 301
 302         // Target
 303         editBuilder.withChild(getTargetNode(datastore));
 304
 305         // Default operation
 306         if (defaultOperation.isPresent()) {
 307             final String opString = defaultOperation.get().name().toLowerCase();
 308             editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(toId(NETCONF_DEFAULT_OPERATION_QNAME))
 309                     .withValue(opString).build());
 310         }
 311
 312         // Error option
 313         if (rollback) {
 314             editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(toId(NETCONF_ERROR_OPTION_QNAME))
 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(toId(NETCONF_SOURCE_QNAME))
 325                 .withChild(Builders.choiceBuilder().withNodeIdentifier(toId(ConfigSource.QNAME)).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(toId(NETCONF_LOCK_QNAME))
 332                 .withChild(getTargetNode(datastore)).build();
 333     }
 334
 335     public static DataContainerChild<?, ?> getTargetNode(final QName datastore) {
 336         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_TARGET_QNAME))
 337                 .withChild(Builders.choiceBuilder().withNodeIdentifier(toId(ConfigTarget.QNAME)).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(toId(NETCONF_COPY_CONFIG_QNAME))
 344                 .withChild(getTargetNode(target)).withChild(getSourceNode(source)).build();
 345     }
 346
 347     public static NormalizedNode<?, ?> getValidateContent(final QName source) {
 348         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_VALIDATE_QNAME))
 349                 .withChild(getSourceNode(source)).build();
 350     }
 351
 352     public static NormalizedNode<?, ?> getUnLockContent(final QName datastore) {
 353         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_UNLOCK_QNAME))
 354                 .withChild(getTargetNode(datastore)).build();
 355     }
 356
 357 }