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
9 package org.opendaylight.netconf.sal.connect.netconf.util;
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;
30 import com.google.common.base.Optional;
31 import com.google.common.base.Preconditions;
32 import com.google.common.util.concurrent.FutureCallback;
33 import com.google.common.util.concurrent.Futures;
34 import com.google.common.util.concurrent.ListenableFuture;
35 import com.google.common.util.concurrent.MoreExecutors;
36 import java.util.Locale;
37 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
38 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
39 import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade.KeepaliveDOMRpcService;
40 import org.opendaylight.netconf.sal.connect.netconf.sal.SchemalessNetconfDeviceRpc;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.copy.config.input.target.ConfigTarget;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.edit.config.input.EditContent;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.get.config.input.source.ConfigSource;
44 import org.opendaylight.yangtools.yang.common.Empty;
45 import org.opendaylight.yangtools.yang.common.QName;
46 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
48 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
49 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
50 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
51 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
52 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
53 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
54 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
57 * Provides base operations for netconf e.g. get, get-config, edit-config, (un)lock, commit etc.
58 * According to RFC-6241
60 public final class NetconfBaseOps {
62 private final DOMRpcService rpc;
63 private final SchemaContext schemaContext;
64 private final RpcStructureTransformer transformer;
66 public NetconfBaseOps(final DOMRpcService rpc, final SchemaContext schemaContext) {
68 this.schemaContext = schemaContext;
70 if (rpc instanceof KeepaliveDOMRpcService
71 && ((KeepaliveDOMRpcService) rpc).getDeviceRpc() instanceof SchemalessNetconfDeviceRpc) {
72 this.transformer = new SchemalessRpcStructureTransformer();
74 this.transformer = new NetconfRpcStructureTransformer(schemaContext);
78 public ListenableFuture<DOMRpcResult> lock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
79 Preconditions.checkNotNull(callback);
80 Preconditions.checkNotNull(datastore);
82 final ListenableFuture<DOMRpcResult> future =
83 rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(datastore));
84 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
88 public ListenableFuture<DOMRpcResult> lockCandidate(final FutureCallback<DOMRpcResult> callback) {
89 final ListenableFuture<DOMRpcResult> future =
90 rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(NETCONF_CANDIDATE_QNAME));
91 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
96 public ListenableFuture<DOMRpcResult> lockRunning(final FutureCallback<DOMRpcResult> callback) {
97 final ListenableFuture<DOMRpcResult> future =
98 rpc.invokeRpc(toPath(NETCONF_LOCK_QNAME), getLockContent(NETCONF_RUNNING_QNAME));
99 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
103 public ListenableFuture<DOMRpcResult> unlock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
104 Preconditions.checkNotNull(callback);
105 Preconditions.checkNotNull(datastore);
107 final ListenableFuture<DOMRpcResult> future =
108 rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(datastore));
109 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
113 public ListenableFuture<DOMRpcResult> unlockRunning(final FutureCallback<DOMRpcResult> callback) {
114 final ListenableFuture<DOMRpcResult> future =
115 rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(NETCONF_RUNNING_QNAME));
116 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
120 public ListenableFuture<DOMRpcResult> unlockCandidate(final FutureCallback<DOMRpcResult> callback) {
121 final ListenableFuture<DOMRpcResult> future =
122 rpc.invokeRpc(toPath(NETCONF_UNLOCK_QNAME), getUnLockContent(NETCONF_CANDIDATE_QNAME));
123 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
127 public ListenableFuture<DOMRpcResult> discardChanges(final FutureCallback<DOMRpcResult> callback) {
128 Preconditions.checkNotNull(callback);
130 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_DISCARD_CHANGES_QNAME), null);
131 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
135 public ListenableFuture<DOMRpcResult> commit(final FutureCallback<DOMRpcResult> callback) {
136 Preconditions.checkNotNull(callback);
138 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(
139 toPath(NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME), NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
140 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
144 public ListenableFuture<DOMRpcResult> validate(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
145 Preconditions.checkNotNull(callback);
146 Preconditions.checkNotNull(datastore);
148 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(
149 toPath(NetconfMessageTransformUtil.NETCONF_VALIDATE_QNAME), getValidateContent(datastore));
150 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
154 public ListenableFuture<DOMRpcResult> validateCandidate(final FutureCallback<DOMRpcResult> callback) {
155 return validate(callback, NETCONF_CANDIDATE_QNAME);
159 public ListenableFuture<DOMRpcResult> validateRunning(final FutureCallback<DOMRpcResult> callback) {
160 return validate(callback, NETCONF_RUNNING_QNAME);
163 public ListenableFuture<DOMRpcResult> copyConfig(final FutureCallback<DOMRpcResult> callback,
164 final QName source, final QName target) {
165 Preconditions.checkNotNull(callback);
166 Preconditions.checkNotNull(source);
167 Preconditions.checkNotNull(target);
169 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(
170 toPath(NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_QNAME), getCopyConfigContent(source, target));
171 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
175 public ListenableFuture<DOMRpcResult> copyRunningToCandidate(final FutureCallback<DOMRpcResult> callback) {
176 return copyConfig(callback, NETCONF_RUNNING_QNAME, NETCONF_CANDIDATE_QNAME);
179 public ListenableFuture<DOMRpcResult> getConfig(final FutureCallback<DOMRpcResult> callback, final QName datastore,
180 final Optional<YangInstanceIdentifier> filterPath) {
181 Preconditions.checkNotNull(callback);
182 Preconditions.checkNotNull(datastore);
184 final ListenableFuture<DOMRpcResult> future;
185 if (isFilterPresent(filterPath)) {
186 final DataContainerChild<?, ?> node = transformer.toFilterStructure(filterPath.get());
187 future = rpc.invokeRpc(toPath(NETCONF_GET_CONFIG_QNAME),
188 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, getSourceNode(datastore), node));
190 future = rpc.invokeRpc(toPath(NETCONF_GET_CONFIG_QNAME),
191 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, getSourceNode(datastore)));
194 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
198 public ListenableFuture<Optional<NormalizedNode<?, ?>>> getConfigRunningData(
199 final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
200 final ListenableFuture<DOMRpcResult> configRunning = getConfigRunning(callback, filterPath);
201 return extractData(filterPath, configRunning);
204 public ListenableFuture<Optional<NormalizedNode<?, ?>>> getData(final FutureCallback<DOMRpcResult> callback,
205 final Optional<YangInstanceIdentifier> filterPath) {
206 final ListenableFuture<DOMRpcResult> configRunning = get(callback, filterPath);
207 return extractData(filterPath, configRunning);
210 private ListenableFuture<Optional<NormalizedNode<?, ?>>> extractData(
211 final Optional<YangInstanceIdentifier> path, final ListenableFuture<DOMRpcResult> configRunning) {
212 return Futures.transform(configRunning, result -> {
213 Preconditions.checkArgument(
214 result.getErrors().isEmpty(), "Unable to read data: %s, errors: %s", path, result.getErrors());
215 final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataNode =
216 ((ContainerNode) result.getResult()).getChild(
217 NetconfMessageTransformUtil.toId(NetconfMessageTransformUtil.NETCONF_DATA_QNAME)).get();
218 return transformer.selectFromDataStructure(dataNode, path.get());
219 }, MoreExecutors.directExecutor());
222 public ListenableFuture<DOMRpcResult> getConfigRunning(final FutureCallback<DOMRpcResult> callback,
223 final Optional<YangInstanceIdentifier> filterPath) {
224 return getConfig(callback, NETCONF_RUNNING_QNAME, filterPath);
227 public ListenableFuture<DOMRpcResult> getConfigCandidate(final FutureCallback<DOMRpcResult> callback,
228 final Optional<YangInstanceIdentifier> filterPath) {
229 return getConfig(callback, NETCONF_CANDIDATE_QNAME, filterPath);
232 public ListenableFuture<DOMRpcResult> get(final FutureCallback<DOMRpcResult> callback,
233 final Optional<YangInstanceIdentifier> filterPath) {
234 Preconditions.checkNotNull(callback);
236 final ListenableFuture<DOMRpcResult> future;
238 future = isFilterPresent(filterPath)
239 ? rpc.invokeRpc(toPath(NETCONF_GET_QNAME),
240 NetconfMessageTransformUtil.wrap(NETCONF_GET_QNAME, toFilterStructure(filterPath.get(), schemaContext)))
241 : rpc.invokeRpc(toPath(NETCONF_GET_QNAME), NetconfMessageTransformUtil.GET_RPC_CONTENT);
243 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
247 private static boolean isFilterPresent(final Optional<YangInstanceIdentifier> filterPath) {
248 return filterPath.isPresent() && !filterPath.get().isEmpty();
251 public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
252 final DataContainerChild<?, ?> editStructure,
253 final ModifyAction modifyAction, final boolean rollback) {
254 return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.of(modifyAction), rollback);
257 public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
258 final DataContainerChild<?, ?> editStructure,
259 final boolean rollback) {
260 return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.absent(), rollback);
263 public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
264 final DataContainerChild<?, ?> editStructure,
265 final ModifyAction modifyAction, final boolean rollback) {
266 return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.of(modifyAction), rollback);
269 public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
270 final DataContainerChild<?, ?> editStructure,
271 final boolean rollback) {
272 return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.absent(), rollback);
275 public ListenableFuture<DOMRpcResult> editConfig(
276 final FutureCallback<? super DOMRpcResult> callback, final QName datastore,
277 final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> modifyAction,
278 final boolean rollback) {
279 Preconditions.checkNotNull(editStructure);
280 Preconditions.checkNotNull(callback);
281 Preconditions.checkNotNull(datastore);
283 final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(toPath(NETCONF_EDIT_CONFIG_QNAME),
284 getEditConfigContent(datastore, editStructure, modifyAction, rollback));
286 Futures.addCallback(future, callback, MoreExecutors.directExecutor());
290 public DataContainerChild<?, ?> createEditConfigStrcture(final Optional<NormalizedNode<?, ?>> lastChild,
291 final Optional<ModifyAction> operation,
292 final YangInstanceIdentifier dataPath) {
293 final AnyXmlNode configContent = transformer.createEditConfigStructure(lastChild, dataPath, operation);
294 return Builders.choiceBuilder().withNodeIdentifier(toId(EditContent.QNAME)).withChild(configContent).build();
297 private static ContainerNode getEditConfigContent(
298 final QName datastore, final DataContainerChild<?, ?> editStructure,
299 final Optional<ModifyAction> defaultOperation, final boolean rollback) {
300 final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> editBuilder =
301 Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_EDIT_CONFIG_QNAME));
304 editBuilder.withChild(getTargetNode(datastore));
307 if (defaultOperation.isPresent()) {
308 final String opString = defaultOperation.get().name().toLowerCase(Locale.ROOT);
309 editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(toId(NETCONF_DEFAULT_OPERATION_QNAME))
310 .withValue(opString).build());
315 editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(toId(NETCONF_ERROR_OPTION_QNAME))
316 .withValue(ROLLBACK_ON_ERROR_OPTION).build());
320 editBuilder.withChild(editStructure);
321 return editBuilder.build();
324 public static DataContainerChild<?, ?> getSourceNode(final QName datastore) {
325 return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_SOURCE_QNAME))
326 .withChild(Builders.choiceBuilder().withNodeIdentifier(toId(ConfigSource.QNAME)).withChild(
327 Builders.leafBuilder().withNodeIdentifier(toId(datastore)).withValue(Empty.getInstance()).build())
331 public static ContainerNode getLockContent(final QName datastore) {
332 return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_LOCK_QNAME))
333 .withChild(getTargetNode(datastore)).build();
336 public static DataContainerChild<?, ?> getTargetNode(final QName datastore) {
337 return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_TARGET_QNAME))
338 .withChild(Builders.choiceBuilder().withNodeIdentifier(toId(ConfigTarget.QNAME)).withChild(
339 Builders.leafBuilder().withNodeIdentifier(toId(datastore)).withValue(Empty.getInstance()).build())
343 public static NormalizedNode<?, ?> getCopyConfigContent(final QName source, final QName target) {
344 return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_COPY_CONFIG_QNAME))
345 .withChild(getTargetNode(target)).withChild(getSourceNode(source)).build();
348 public static NormalizedNode<?, ?> getValidateContent(final QName source) {
349 return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_VALIDATE_QNAME))
350 .withChild(getSourceNode(source)).build();
353 public static NormalizedNode<?, ?> getUnLockContent(final QName datastore) {
354 return Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_UNLOCK_QNAME))
355 .withChild(getTargetNode(datastore)).build();