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