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 = rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(datastore));
  78         Futures.addCallback(future, callback);
  79         return future;
  80     }
  81
  82     public ListenableFuture<DOMRpcResult> lockCandidate(final FutureCallback<DOMRpcResult> callback) {
  83         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(NETCONF_CANDIDATE_QNAME));
  84         Futures.addCallback(future, callback);
  85         return future;
  86     }
  87
  88
  89     public ListenableFuture<DOMRpcResult> lockRunning(final FutureCallback<DOMRpcResult> callback) {
  90         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(NETCONF_RUNNING_QNAME));
  91         Futures.addCallback(future, callback);
  92         return future;
  93     }
  94
  95     public ListenableFuture<DOMRpcResult> unlock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
  96         Preconditions.checkNotNull(callback);
  97         Preconditions.checkNotNull(datastore);
  98
  99         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(datastore));
 100         Futures.addCallback(future, callback);
 101         return future;
 102     }
 103
 104     public ListenableFuture<DOMRpcResult> unlockRunning(final FutureCallback<DOMRpcResult> callback) {
 105         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(NETCONF_RUNNING_QNAME));
 106         Futures.addCallback(future, callback);
 107         return future;
 108     }
 109
 110     public ListenableFuture<DOMRpcResult> unlockCandidate(final FutureCallback<DOMRpcResult> callback) {
 111         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(NETCONF_CANDIDATE_QNAME));
 112         Futures.addCallback(future, callback);
 113         return future;
 114     }
 115
 116     public ListenableFuture<DOMRpcResult> discardChanges(final FutureCallback<DOMRpcResult> callback) {
 117         Preconditions.checkNotNull(callback);
 118
 119         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_DISCARD_CHANGES_QNAME), null);
 120         Futures.addCallback(future, callback);
 121         return future;
 122     }
 123
 124     public ListenableFuture<DOMRpcResult> commit(final FutureCallback<DOMRpcResult> callback) {
 125         Preconditions.checkNotNull(callback);
 126
 127         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME), NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
 128         Futures.addCallback(future, callback);
 129         return future;
 130     }
 131
 132     public ListenableFuture<DOMRpcResult> validate(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
 133         Preconditions.checkNotNull(callback);
 134         Preconditions.checkNotNull(datastore);
 135
 136         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_VALIDATE_QNAME), getValidateContent(datastore));
 137         Futures.addCallback(future, callback);
 138         return future;
 139     }
 140
 141     public ListenableFuture<DOMRpcResult> validateCandidate(final FutureCallback<DOMRpcResult> callback) {
 142         return validate(callback, NETCONF_CANDIDATE_QNAME);
 143     }
 144
 145
 146     public ListenableFuture<DOMRpcResult> validateRunning(final FutureCallback<DOMRpcResult> callback) {
 147         return validate(callback, NETCONF_RUNNING_QNAME);
 148     }
 149
 150     public ListenableFuture<DOMRpcResult> copyConfig(final FutureCallback<DOMRpcResult> callback, final QName source, final QName target) {
 151         Preconditions.checkNotNull(callback);
 152         Preconditions.checkNotNull(source);
 153         Preconditions.checkNotNull(target);
 154
 155         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_QNAME), getCopyConfigContent(source, target));
 156         Futures.addCallback(future, callback);
 157         return future;
 158     }
 159
 160     public ListenableFuture<DOMRpcResult> copyRunningToCandidate(final FutureCallback<DOMRpcResult> callback) {
 161         return copyConfig(callback, NETCONF_RUNNING_QNAME, NETCONF_CANDIDATE_QNAME);
 162     }
 163
 164     public ListenableFuture<DOMRpcResult> getConfig(final FutureCallback<DOMRpcResult> callback, final QName datastore, final Optional<YangInstanceIdentifier> filterPath) {
 165         Preconditions.checkNotNull(callback);
 166         Preconditions.checkNotNull(datastore);
 167
 168         final ListenableFuture<DOMRpcResult> future;
 169         if (isFilterPresent(filterPath)) {
 170             final DataContainerChild<?, ?> node = transformer.toFilterStructure(filterPath.get());
 171             future = rpc.invokeRpc(toPath(NETCONF_GET_CONFIG_QNAME),
 172                             NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, getSourceNode(datastore), node));
 173         } else {
 174             future = rpc.invokeRpc(toPath(NETCONF_GET_CONFIG_QNAME),
 175                             NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, getSourceNode(datastore)));
 176         }
 177
 178         Futures.addCallback(future, callback);
 179         return future;
 180     }
 181
 182     public ListenableFuture<Optional<NormalizedNode<?, ?>>> getConfigRunningData(final FutureCallback<DOMRpcResult> callback,
 183                                                                                  final Optional<YangInstanceIdentifier> filterPath) {
 184         final ListenableFuture<DOMRpcResult> configRunning = getConfigRunning(callback, filterPath);
 185         return extractData(filterPath, configRunning);
 186     }
 187
 188     public ListenableFuture<Optional<NormalizedNode<?, ?>>> getData(final FutureCallback<DOMRpcResult> callback,
 189                                                                     final Optional<YangInstanceIdentifier> filterPath) {
 190         final ListenableFuture<DOMRpcResult> configRunning = get(callback, filterPath);
 191         return extractData(filterPath, configRunning);
 192     }
 193
 194     private ListenableFuture<Optional<NormalizedNode<?, ?>>> extractData(final Optional<YangInstanceIdentifier> path,
 195                                                                          final ListenableFuture<DOMRpcResult> configRunning) {
 196         return Futures.transform(configRunning, (Function<DOMRpcResult, Optional<NormalizedNode<?, ?>>>) result -> {
 197             Preconditions.checkArgument(result.getErrors().isEmpty(), "Unable to read data: %s, errors: %s", path, result.getErrors());
 198             final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataNode =
 199                     ((ContainerNode) result.getResult()).getChild(NetconfMessageTransformUtil.toId(NetconfMessageTransformUtil.NETCONF_DATA_QNAME)).get();
 200             return transformer.selectFromDataStructure(dataNode, path.get());
 201         });
 202     }
 203
 204     public ListenableFuture<DOMRpcResult> getConfigRunning(final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
 205         return getConfig(callback, NETCONF_RUNNING_QNAME, filterPath);
 206     }
 207
 208     public ListenableFuture<DOMRpcResult> getConfigCandidate(final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
 209         return getConfig(callback, NETCONF_CANDIDATE_QNAME, filterPath);
 210     }
 211
 212     public ListenableFuture<DOMRpcResult> get(final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
 213         Preconditions.checkNotNull(callback);
 214
 215         final ListenableFuture<DOMRpcResult> future;
 216
 217         future = isFilterPresent(filterPath) ?
 218                 rpc.invokeRpc(toPath(NETCONF_GET_QNAME), NetconfMessageTransformUtil.wrap(NETCONF_GET_QNAME, toFilterStructure(filterPath.get(), schemaContext))) :
 219                 rpc.invokeRpc(toPath(NETCONF_GET_QNAME), NetconfMessageTransformUtil.GET_RPC_CONTENT);
 220
 221         Futures.addCallback(future, callback);
 222         return future;
 223     }
 224
 225     private static boolean isFilterPresent(final Optional<YangInstanceIdentifier> filterPath) {
 226         return filterPath.isPresent() && !filterPath.get().isEmpty();
 227     }
 228
 229     public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild<?, ?> editStructure, final ModifyAction modifyAction, final boolean rollback) {
 230         return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.of(modifyAction), rollback);
 231     }
 232
 233     public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild<?, ?> editStructure, final boolean rollback) {
 234         return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.<ModifyAction>absent(), rollback);
 235     }
 236
 237     public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild<?, ?> editStructure, final ModifyAction modifyAction, final boolean rollback) {
 238         return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.of(modifyAction), rollback);
 239     }
 240
 241     public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild<?, ?> editStructure, final boolean rollback) {
 242         return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.<ModifyAction>absent(), rollback);
 243     }
 244
 245     public ListenableFuture<DOMRpcResult> editConfig(final FutureCallback<? super DOMRpcResult> callback, final QName datastore, final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> modifyAction, final boolean rollback) {
 246         Preconditions.checkNotNull(editStructure);
 247         Preconditions.checkNotNull(callback);
 248         Preconditions.checkNotNull(datastore);
 249
 250         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_EDIT_CONFIG_QNAME), getEditConfigContent(datastore, editStructure, modifyAction, rollback));
 251
 252         Futures.addCallback(future, callback);
 253         return future;
 254     }
 255
 256     public DataContainerChild<?, ?> createEditConfigStrcture(final Optional<NormalizedNode<?, ?>> lastChild, final Optional<ModifyAction> operation, final YangInstanceIdentifier dataPath) {
 257         final AnyXmlNode configContent = transformer.createEditConfigStructure(lastChild, dataPath, operation);
 258         return Builders.choiceBuilder().withNodeIdentifier(toId(EditContent.QNAME)).withChild(configContent).build();
 259     }
 260
 261     private static ContainerNode getEditConfigContent(final QName datastore,
 262             final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> defaultOperation, final boolean rollback) {
 263         final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> editBuilder =
 264                 Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_EDIT_CONFIG_QNAME));
 265
 266         // Target
 267         editBuilder.withChild(getTargetNode(datastore));
 268
 269         // Default operation
 270         if(defaultOperation.isPresent()) {
 271             final String opString = defaultOperation.get().name().toLowerCase();
 272             editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(toId(NETCONF_DEFAULT_OPERATION_QNAME)).withValue(opString).build());
 273         }
 274
 275         // Error option
 276         if(rollback) {
 277             editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(toId(NETCONF_ERROR_OPTION_QNAME)).withValue(ROLLBACK_ON_ERROR_OPTION).build());
 278         }
 279
 280         // Edit content
 281         editBuilder.withChild(editStructure);
 282         return editBuilder.build();
 283     }
 284
 285     public static DataContainerChild<?, ?> getSourceNode(final QName datastore) {
 286         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_SOURCE_QNAME))
 287                 .withChild(
 288                         Builders.choiceBuilder().withNodeIdentifier(toId(ConfigSource.QNAME)).withChild(
 289                                 Builders.leafBuilder().withNodeIdentifier(toId(datastore)).build()).build()
 290                 ).build();
 291     }
 292
 293     public static ContainerNode getLockContent(final QName datastore) {
 294         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_LOCK_QNAME))
 295                 .withChild(getTargetNode(datastore)).build();
 296     }
 297
 298     public static DataContainerChild<?, ?> getTargetNode(final QName datastore) {
 299         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_TARGET_QNAME))
 300                 .withChild(
 301                         Builders.choiceBuilder().withNodeIdentifier(toId(ConfigTarget.QNAME)).withChild(
 302                                 Builders.leafBuilder().withNodeIdentifier(toId(datastore)).build()).build()
 303                 ).build();
 304     }
 305
 306     public static NormalizedNode<?, ?> getCopyConfigContent(final QName source, final QName target) {
 307         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_COPY_CONFIG_QNAME))
 308                 .withChild(getTargetNode(target)).withChild(getSourceNode(source)).build();
 309     }
 310
 311     public static NormalizedNode<?, ?> getValidateContent(final QName source) {
 312         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_VALIDATE_QNAME))
 313                 .withChild(getSourceNode(source)).build();
 314     }
 315
 316     public static NormalizedNode<?, ?> getUnLockContent(final QName datastore) {
 317         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_UNLOCK_QNAME))
 318                 .withChild(getTargetNode(datastore)).build();
 319     }
 320
 321 }