2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.sal.connect.netconf.util;
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;
35 import com.google.common.base.Preconditions;
36 import com.google.common.util.concurrent.FutureCallback;
37 import com.google.common.util.concurrent.Futures;
38 import com.google.common.util.concurrent.ListenableFuture;
39 import com.google.common.util.concurrent.MoreExecutors;
40 import java.util.Locale;
41 import java.util.Optional;
42 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
43 import org.opendaylight.mdsal.dom.api.DOMRpcService;
44 import org.opendaylight.netconf.api.ModifyAction;
45 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade.KeepaliveDOMRpcService;
46 import org.opendaylight.netconf.sal.connect.netconf.sal.SchemalessNetconfDeviceRpc;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.copy.config.input.target.ConfigTarget;
48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.get.config.input.source.ConfigSource;
49 import org.opendaylight.yangtools.yang.common.Empty;
50 import org.opendaylight.yangtools.yang.common.QName;
51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
53 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
54 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
56 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
57 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
58 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
59 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
62 * Provides base operations for netconf e.g. get, get-config, edit-config, (un)lock, commit etc.
63 * According to RFC-6241
65 public final class NetconfBaseOps {
66 private static final NodeIdentifier CONFIG_SOURCE_NODEID = NodeIdentifier.create(ConfigSource.QNAME);
67 private static final NodeIdentifier CONFIG_TARGET_NODEID = NodeIdentifier.create(ConfigTarget.QNAME);
69 private final DOMRpcService rpc;
70 private final SchemaContext schemaContext;
71 private final RpcStructureTransformer transformer;
73 public NetconfBaseOps(final DOMRpcService rpc, final SchemaContext schemaContext) {
75 this.schemaContext = schemaContext;
77 if (rpc instanceof KeepaliveDOMRpcService
78 && ((KeepaliveDOMRpcService) rpc).getDeviceRpc() instanceof SchemalessNetconfDeviceRpc) {
79 this.transformer = new SchemalessRpcStructureTransformer();
81 this.transformer = new NetconfRpcStructureTransformer(schemaContext);
85 public ListenableFuture<DOMRpcResult> lock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
86 Preconditions.checkNotNull(callback);
87 Preconditions.checkNotNull(datastore);
89 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_LOCK_PATH, getLockContent(datastore));
90 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
94 public ListenableFuture<DOMRpcResult> lockCandidate(final FutureCallback<DOMRpcResult> callback) {
95 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_LOCK_PATH,
96 getLockContent(NETCONF_CANDIDATE_QNAME));
97 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
101 public ListenableFuture<DOMRpcResult> lockRunning(final FutureCallback<DOMRpcResult> callback) {
102 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_LOCK_PATH,
103 getLockContent(NETCONF_RUNNING_QNAME));
104 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
108 public ListenableFuture<DOMRpcResult> unlock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
109 Preconditions.checkNotNull(callback);
110 Preconditions.checkNotNull(datastore);
112 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH, getUnLockContent(datastore));
113 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
117 public ListenableFuture<DOMRpcResult> unlockRunning(final FutureCallback<DOMRpcResult> callback) {
118 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH,
119 getUnLockContent(NETCONF_RUNNING_QNAME));
120 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
124 public ListenableFuture<DOMRpcResult> unlockCandidate(final FutureCallback<DOMRpcResult> callback) {
125 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH,
126 getUnLockContent(NETCONF_CANDIDATE_QNAME));
127 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
131 public ListenableFuture<DOMRpcResult> discardChanges(final FutureCallback<DOMRpcResult> callback) {
132 Preconditions.checkNotNull(callback);
134 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_DISCARD_CHANGES_PATH, null);
135 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
139 public ListenableFuture<DOMRpcResult> commit(final FutureCallback<DOMRpcResult> callback) {
140 Preconditions.checkNotNull(callback);
142 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NetconfMessageTransformUtil.NETCONF_COMMIT_PATH,
143 NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
144 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
148 public ListenableFuture<DOMRpcResult> validate(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
149 Preconditions.checkNotNull(callback);
150 Preconditions.checkNotNull(datastore);
152 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NetconfMessageTransformUtil.NETCONF_VALIDATE_PATH,
153 getValidateContent(datastore));
154 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
158 public ListenableFuture<DOMRpcResult> validateCandidate(final FutureCallback<DOMRpcResult> callback) {
159 return validate(callback, NETCONF_CANDIDATE_QNAME);
162 public ListenableFuture<DOMRpcResult> validateRunning(final FutureCallback<DOMRpcResult> callback) {
163 return validate(callback, NETCONF_RUNNING_QNAME);
166 public ListenableFuture<DOMRpcResult> copyConfig(final FutureCallback<DOMRpcResult> callback,
167 final QName source, final QName target) {
168 Preconditions.checkNotNull(callback);
169 Preconditions.checkNotNull(source);
170 Preconditions.checkNotNull(target);
172 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_COPY_CONFIG_PATH,
173 getCopyConfigContent(source, target));
174 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
178 public ListenableFuture<DOMRpcResult> copyRunningToCandidate(final FutureCallback<DOMRpcResult> callback) {
179 return copyConfig(callback, NETCONF_RUNNING_QNAME, NETCONF_CANDIDATE_QNAME);
182 public ListenableFuture<DOMRpcResult> getConfig(final FutureCallback<DOMRpcResult> callback, final QName datastore,
183 final Optional<YangInstanceIdentifier> filterPath) {
184 Preconditions.checkNotNull(callback);
185 Preconditions.checkNotNull(datastore);
187 final ListenableFuture<DOMRpcResult> future;
188 if (isFilterPresent(filterPath)) {
189 final DataContainerChild<?, ?> node = transformer.toFilterStructure(filterPath.get());
190 future = rpc.invokeRpc(NETCONF_GET_CONFIG_PATH,
191 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, getSourceNode(datastore), node));
193 future = rpc.invokeRpc(NETCONF_GET_CONFIG_PATH,
194 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, getSourceNode(datastore)));
197 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
201 public ListenableFuture<Optional<NormalizedNode<?, ?>>> getConfigRunningData(
202 final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
203 final ListenableFuture<DOMRpcResult> configRunning = getConfigRunning(callback, filterPath);
204 return extractData(filterPath, configRunning);
207 public ListenableFuture<Optional<NormalizedNode<?, ?>>> getData(final FutureCallback<DOMRpcResult> callback,
208 final Optional<YangInstanceIdentifier> filterPath) {
209 final ListenableFuture<DOMRpcResult> configRunning = get(callback, filterPath);
210 return extractData(filterPath, configRunning);
213 private ListenableFuture<Optional<NormalizedNode<?, ?>>> extractData(
214 final Optional<YangInstanceIdentifier> path, final ListenableFuture<DOMRpcResult> configRunning) {
215 return Futures.transform(configRunning, result -> {
216 Preconditions.checkArgument(result.getErrors().isEmpty(), "Unable to read data: %s, errors: %s", path,
218 final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataNode =
219 ((ContainerNode) result.getResult()).getChild(NetconfMessageTransformUtil.NETCONF_DATA_NODEID)
221 return transformer.selectFromDataStructure(dataNode, path.get());
222 }, MoreExecutors.directExecutor());
225 public ListenableFuture<DOMRpcResult> getConfigRunning(final FutureCallback<DOMRpcResult> callback,
226 final Optional<YangInstanceIdentifier> filterPath) {
227 return getConfig(callback, NETCONF_RUNNING_QNAME, filterPath);
230 public ListenableFuture<DOMRpcResult> getConfigCandidate(final FutureCallback<DOMRpcResult> callback,
231 final Optional<YangInstanceIdentifier> filterPath) {
232 return getConfig(callback, NETCONF_CANDIDATE_QNAME, filterPath);
235 public ListenableFuture<DOMRpcResult> get(final FutureCallback<DOMRpcResult> callback,
236 final Optional<YangInstanceIdentifier> filterPath) {
237 Preconditions.checkNotNull(callback);
239 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_GET_PATH, isFilterPresent(filterPath)
240 ? NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, toFilterStructure(filterPath.get(), schemaContext))
241 : NetconfMessageTransformUtil.GET_RPC_CONTENT);
242 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
246 private static boolean isFilterPresent(final Optional<YangInstanceIdentifier> filterPath) {
247 return filterPath.isPresent() && !filterPath.get().isEmpty();
250 public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
251 final DataContainerChild<?, ?> editStructure,
252 final ModifyAction modifyAction, final boolean rollback) {
253 return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.of(modifyAction), rollback);
256 public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
257 final DataContainerChild<?, ?> editStructure,
258 final boolean rollback) {
259 return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.empty(), rollback);
262 public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
263 final DataContainerChild<?, ?> editStructure,
264 final ModifyAction modifyAction, final boolean rollback) {
265 return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.of(modifyAction), rollback);
268 public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
269 final DataContainerChild<?, ?> editStructure,
270 final boolean rollback) {
271 return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.empty(), rollback);
274 public ListenableFuture<DOMRpcResult> editConfig(
275 final FutureCallback<? super DOMRpcResult> callback, final QName datastore,
276 final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> modifyAction,
277 final boolean rollback) {
278 Preconditions.checkNotNull(editStructure);
279 Preconditions.checkNotNull(callback);
280 Preconditions.checkNotNull(datastore);
282 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_EDIT_CONFIG_PATH,
283 getEditConfigContent(datastore, editStructure, modifyAction, rollback));
285 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
289 public DataContainerChild<?, ?> createEditConfigStrcture(final Optional<NormalizedNode<?, ?>> lastChild,
290 final Optional<ModifyAction> operation,
291 final YangInstanceIdentifier dataPath) {
292 final AnyXmlNode configContent = transformer.createEditConfigStructure(lastChild, dataPath, operation);
293 return Builders.choiceBuilder().withNodeIdentifier(EDIT_CONTENT_NODEID).withChild(configContent).build();
296 private static ContainerNode getEditConfigContent(
297 final QName datastore, final DataContainerChild<?, ?> editStructure,
298 final Optional<ModifyAction> defaultOperation, final boolean rollback) {
299 final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> editBuilder =
300 Builders.containerBuilder().withNodeIdentifier(NETCONF_EDIT_CONFIG_NODEID);
303 editBuilder.withChild(getTargetNode(datastore));
306 if (defaultOperation.isPresent()) {
307 final String opString = defaultOperation.get().name().toLowerCase(Locale.ROOT);
308 editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(NETCONF_DEFAULT_OPERATION_NODEID)
309 .withValue(opString).build());
314 editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(NETCONF_ERROR_OPTION_NODEID)
315 .withValue(ROLLBACK_ON_ERROR_OPTION).build());
319 editBuilder.withChild(editStructure);
320 return editBuilder.build();
323 public static DataContainerChild<?, ?> getSourceNode(final QName datastore) {
324 return Builders.containerBuilder().withNodeIdentifier(NETCONF_SOURCE_NODEID)
325 .withChild(Builders.choiceBuilder().withNodeIdentifier(CONFIG_SOURCE_NODEID).withChild(
326 Builders.leafBuilder().withNodeIdentifier(toId(datastore)).withValue(Empty.getInstance()).build())
330 public static ContainerNode getLockContent(final QName datastore) {
331 return Builders.containerBuilder().withNodeIdentifier(NETCONF_LOCK_NODEID)
332 .withChild(getTargetNode(datastore)).build();
335 public static DataContainerChild<?, ?> getTargetNode(final QName datastore) {
336 return Builders.containerBuilder().withNodeIdentifier(NETCONF_TARGET_NODEID)
337 .withChild(Builders.choiceBuilder().withNodeIdentifier(CONFIG_TARGET_NODEID).withChild(
338 Builders.leafBuilder().withNodeIdentifier(toId(datastore)).withValue(Empty.getInstance()).build())
342 public static NormalizedNode<?, ?> getCopyConfigContent(final QName source, final QName target) {
343 return Builders.containerBuilder().withNodeIdentifier(NETCONF_COPY_CONFIG_NODEID)
344 .withChild(getTargetNode(target)).withChild(getSourceNode(source)).build();
347 public static NormalizedNode<?, ?> getValidateContent(final QName source) {
348 return Builders.containerBuilder().withNodeIdentifier(NETCONF_VALIDATE_NODEID)
349 .withChild(getSourceNode(source)).build();
352 public static NormalizedNode<?, ?> getUnLockContent(final QName datastore) {
353 return Builders.containerBuilder().withNodeIdentifier(NETCONF_UNLOCK_NODEID)
354 .withChild(getTargetNode(datastore)).build();