opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/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.controller.sal.connect.netconf.util;
  10
  11 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.DISCARD_CHANGES_RPC_CONTENT;
  12 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_CANDIDATE_QNAME;
  13 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_QNAME;
  14 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DEFAULT_OPERATION_QNAME;
  15 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_QNAME;
  16 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_QNAME;
  17 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_ERROR_OPTION_QNAME;
  18 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME;
  19 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
  20 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_LOCK_QNAME;
  21 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME;
  22 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_SOURCE_QNAME;
  23 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_TARGET_QNAME;
  24 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_UNLOCK_QNAME;
  25 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_VALIDATE_QNAME;
  26 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.ROLLBACK_ON_ERROR_OPTION;
  27 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.toFilterStructure;
  28 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.toId;
  29 import static org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil.toPath;
  30
  31 import com.google.common.base.Optional;
  32 import com.google.common.base.Preconditions;
  33 import com.google.common.collect.Iterables;
  34 import com.google.common.util.concurrent.FutureCallback;
  35 import com.google.common.util.concurrent.Futures;
  36 import com.google.common.util.concurrent.ListenableFuture;
  37 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  38 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  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.get.config.input.source.ConfigSource;
  41 import org.opendaylight.yangtools.yang.common.QName;
  42 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  45 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  46 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  50
  51 /**
  52  * Provides base operations for netconf e.g. get, get-config, edit-config, (un)lock, commit etc.
  53  * According to RFC-6241
  54  */
  55 public final class NetconfBaseOps {
  56
  57     private final DOMRpcService rpc;
  58     private final SchemaContext schemaContext;
  59
  60     public NetconfBaseOps(final DOMRpcService rpc, final SchemaContext schemaContext) {
  61         this.rpc = rpc;
  62         this.schemaContext = schemaContext;
  63     }
  64
  65     public ListenableFuture<DOMRpcResult> lock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
  66         Preconditions.checkNotNull(callback);
  67         Preconditions.checkNotNull(datastore);
  68
  69         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(datastore));
  70         Futures.addCallback(future, callback);
  71         return future;
  72     }
  73
  74     public ListenableFuture<DOMRpcResult> lockCandidate(final FutureCallback<DOMRpcResult> callback) {
  75         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(NETCONF_CANDIDATE_QNAME));
  76         Futures.addCallback(future, callback);
  77         return future;
  78     }
  79
  80
  81     public ListenableFuture<DOMRpcResult> lockRunning(final FutureCallback<DOMRpcResult> callback) {
  82         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(NETCONF_RUNNING_QNAME));
  83         Futures.addCallback(future, callback);
  84         return future;
  85     }
  86
  87     public ListenableFuture<DOMRpcResult> unlock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
  88         Preconditions.checkNotNull(callback);
  89         Preconditions.checkNotNull(datastore);
  90
  91         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(datastore));
  92         Futures.addCallback(future, callback);
  93         return future;
  94     }
  95
  96     public ListenableFuture<DOMRpcResult> unlockRunning(final FutureCallback<DOMRpcResult> callback) {
  97         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(NETCONF_RUNNING_QNAME));
  98         Futures.addCallback(future, callback);
  99         return future;
 100     }
 101
 102     public ListenableFuture<DOMRpcResult> unlockCandidate(final FutureCallback<DOMRpcResult> callback) {
 103         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(NETCONF_CANDIDATE_QNAME));
 104         Futures.addCallback(future, callback);
 105         return future;
 106     }
 107
 108     public ListenableFuture<DOMRpcResult> discardChanges(final FutureCallback<DOMRpcResult> callback) {
 109         Preconditions.checkNotNull(callback);
 110
 111         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_DISCARD_CHANGES_QNAME), DISCARD_CHANGES_RPC_CONTENT);
 112         Futures.addCallback(future, callback);
 113         return future;
 114     }
 115
 116     public ListenableFuture<DOMRpcResult> commit(final FutureCallback<DOMRpcResult> callback) {
 117         Preconditions.checkNotNull(callback);
 118
 119         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME), NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
 120         Futures.addCallback(future, callback);
 121         return future;
 122     }
 123
 124     public ListenableFuture<DOMRpcResult> validate(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
 125         Preconditions.checkNotNull(callback);
 126         Preconditions.checkNotNull(datastore);
 127
 128         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_VALIDATE_QNAME), getValidateContent(datastore));
 129         Futures.addCallback(future, callback);
 130         return future;
 131     }
 132
 133     public ListenableFuture<DOMRpcResult> validateCandidate(final FutureCallback<DOMRpcResult> callback) {
 134         return validate(callback, NETCONF_CANDIDATE_QNAME);
 135     }
 136
 137
 138     public ListenableFuture<DOMRpcResult> validateRunning(final FutureCallback<DOMRpcResult> callback) {
 139         return validate(callback, NETCONF_RUNNING_QNAME);
 140     }
 141
 142     public ListenableFuture<DOMRpcResult> copyConfig(final FutureCallback<DOMRpcResult> callback, final QName source, final QName target) {
 143         Preconditions.checkNotNull(callback);
 144         Preconditions.checkNotNull(source);
 145         Preconditions.checkNotNull(target);
 146
 147         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_QNAME), getCopyConfigContent(source, target));
 148         Futures.addCallback(future, callback);
 149         return future;
 150     }
 151
 152     public ListenableFuture<DOMRpcResult> copyRunningToCandidate(final FutureCallback<DOMRpcResult> callback) {
 153         return copyConfig(callback, NETCONF_RUNNING_QNAME, NETCONF_CANDIDATE_QNAME);
 154     }
 155
 156     public ListenableFuture<DOMRpcResult> getConfig(final FutureCallback<DOMRpcResult> callback, final QName datastore, final Optional<YangInstanceIdentifier> filterPath) {
 157         Preconditions.checkNotNull(callback);
 158         Preconditions.checkNotNull(datastore);
 159
 160         final ListenableFuture<DOMRpcResult> future;
 161         if (isFilterPresent(filterPath)) {
 162             // FIXME the source node has to be wrapped in a choice
 163             final DataContainerChild<?, ?> node = toFilterStructure(filterPath.get(), schemaContext);
 164             future = rpc.invokeRpc(toPath(NETCONF_GET_CONFIG_QNAME),
 165                             NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, getSourceNode(datastore), node));
 166         } else {
 167             future = rpc.invokeRpc(toPath(NETCONF_GET_CONFIG_QNAME),
 168                             NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, getSourceNode(datastore)));
 169         }
 170
 171         Futures.addCallback(future, callback);
 172         return future;
 173     }
 174
 175     public ListenableFuture<DOMRpcResult> getConfigRunning(final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
 176         return getConfig(callback, NETCONF_RUNNING_QNAME, filterPath);
 177     }
 178
 179     public ListenableFuture<DOMRpcResult> getConfigCandidate(final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
 180         return getConfig(callback, NETCONF_CANDIDATE_QNAME, filterPath);
 181     }
 182
 183     public ListenableFuture<DOMRpcResult> get(final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
 184         Preconditions.checkNotNull(callback);
 185
 186         final ListenableFuture<DOMRpcResult> future;
 187
 188         future = isFilterPresent(filterPath) ?
 189                 rpc.invokeRpc(toPath(NETCONF_GET_QNAME), NetconfMessageTransformUtil.wrap(NETCONF_GET_QNAME, toFilterStructure(filterPath.get(), schemaContext))) :
 190                 rpc.invokeRpc(toPath(NETCONF_GET_QNAME), NetconfMessageTransformUtil.GET_RPC_CONTENT);
 191
 192         Futures.addCallback(future, callback);
 193         return future;
 194     }
 195
 196     private boolean isFilterPresent(final Optional<YangInstanceIdentifier> filterPath) {
 197         return filterPath.isPresent() && Iterables.isEmpty(filterPath.get().getPathArguments()) == false;
 198     }
 199
 200     public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild<?, ?> editStructure, final ModifyAction modifyAction, final boolean rollback) {
 201         return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.of(modifyAction), rollback);
 202     }
 203
 204     public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild<?, ?> editStructure, final boolean rollback) {
 205         return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.<ModifyAction>absent(), rollback);
 206     }
 207
 208     public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild<?, ?> editStructure, final ModifyAction modifyAction, final boolean rollback) {
 209         return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.of(modifyAction), rollback);
 210     }
 211
 212     public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild<?, ?> editStructure, final boolean rollback) {
 213         return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.<ModifyAction>absent(), rollback);
 214     }
 215
 216     public ListenableFuture<DOMRpcResult> editConfig(final FutureCallback<? super DOMRpcResult> callback, final QName datastore, final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> modifyAction, final boolean rollback) {
 217         Preconditions.checkNotNull(editStructure);
 218         Preconditions.checkNotNull(callback);
 219         Preconditions.checkNotNull(datastore);
 220
 221         final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_EDIT_CONFIG_QNAME), getEditConfigContent(datastore, editStructure, modifyAction, rollback));
 222
 223         Futures.addCallback(future, callback);
 224         return future;
 225     }
 226
 227     public DataContainerChild<?, ?> createEditConfigStrcture(final Optional<NormalizedNode<?, ?>> lastChild, final Optional<ModifyAction> operation, final YangInstanceIdentifier dataPath) {
 228         return NetconfMessageTransformUtil.createEditConfigStructure(schemaContext, dataPath, operation, lastChild);
 229     }
 230
 231     private ContainerNode getEditConfigContent(final QName datastore, final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> defaultOperation, final boolean rollback) {
 232         final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> editBuilder = Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_EDIT_CONFIG_QNAME));
 233
 234         // Target
 235         editBuilder.withChild(getTargetNode(datastore));
 236
 237         // Default operation
 238         if(defaultOperation.isPresent()) {
 239             editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(toId(NETCONF_DEFAULT_OPERATION_QNAME)).withValue(NetconfMessageTransformUtil.modifyOperationToXmlString(defaultOperation.get())).build());
 240         }
 241
 242         // Error option
 243         if(rollback) {
 244             editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(toId(NETCONF_ERROR_OPTION_QNAME)).withValue(ROLLBACK_ON_ERROR_OPTION).build());
 245         }
 246
 247         // Edit content
 248         editBuilder.withChild(editStructure);
 249         return editBuilder.build();
 250     }
 251
 252     public static DataContainerChild<?, ?> getSourceNode(final QName datastore) {
 253         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_SOURCE_QNAME))
 254                 .withChild(
 255                         Builders.choiceBuilder().withNodeIdentifier(toId(ConfigSource.QNAME)).withChild(
 256                                 Builders.leafBuilder().withNodeIdentifier(toId(datastore)).build()).build()
 257                 ).build();
 258     }
 259
 260     public static ContainerNode getLockContent(final QName datastore) {
 261         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_LOCK_QNAME))
 262                 .withChild(getTargetNode(datastore)).build();
 263     }
 264
 265     public static DataContainerChild<?, ?> getTargetNode(final QName datastore) {
 266         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_TARGET_QNAME))
 267                 .withChild(
 268                         Builders.choiceBuilder().withNodeIdentifier(toId(ConfigTarget.QNAME)).withChild(
 269                                 Builders.leafBuilder().withNodeIdentifier(toId(datastore)).build()).build()
 270                 ).build();
 271     }
 272
 273     public static NormalizedNode<?, ?> getCopyConfigContent(final QName source, final QName target) {
 274         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_COPY_CONFIG_QNAME))
 275                 .withChild(getTargetNode(target)).withChild(getSourceNode(source)).build();
 276     }
 277
 278     public static NormalizedNode<?, ?> getValidateContent(final QName source) {
 279         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_VALIDATE_QNAME))
 280                 .withChild(getSourceNode(source)).build();
 281     }
 282
 283     public static NormalizedNode<?, ?> getUnLockContent(final QName datastore) {
 284         return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_UNLOCK_QNAME))
 285                 .withChild(getTargetNode(datastore)).build();
 286     }
 287
 288 }