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