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