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.sal;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.collect.Collections2;
13 import com.google.common.util.concurrent.FutureCallback;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import com.google.common.util.concurrent.MoreExecutors;
17 import com.google.common.util.concurrent.SettableFuture;
18 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
19 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
20 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
21 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
22 import org.opendaylight.mdsal.dom.api.DOMRpcService;
23 import org.opendaylight.mdsal.dom.api.DefaultDOMRpcException;
24 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
25 import org.opendaylight.netconf.api.NetconfMessage;
26 import org.opendaylight.netconf.sal.connect.api.MessageTransformer;
27 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceCommunicator;
28 import org.opendaylight.yangtools.concepts.ListenerRegistration;
29 import org.opendaylight.yangtools.concepts.NoOpListenerRegistration;
30 import org.opendaylight.yangtools.yang.common.QName;
31 import org.opendaylight.yangtools.yang.common.RpcResult;
32 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
33 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
36 * Invokes RPC by sending netconf message via listener. Also transforms result from NetconfMessage to CompositeNode.
38 public final class NetconfDeviceRpc implements DOMRpcService {
39 private final RemoteDeviceCommunicator communicator;
40 private final MessageTransformer transformer;
41 private final SchemaContext schemaContext;
43 public NetconfDeviceRpc(final SchemaContext schemaContext, final RemoteDeviceCommunicator communicator,
44 final MessageTransformer transformer) {
45 this.communicator = communicator;
46 this.transformer = transformer;
47 this.schemaContext = requireNonNull(schemaContext);
51 @SuppressWarnings("checkstyle:IllegalCatch")
52 public ListenableFuture<DOMRpcResult> invokeRpc(final QName type, final NormalizedNode input) {
53 final ListenableFuture<RpcResult<NetconfMessage>> delegateFuture = communicator.sendRequest(
54 transformer.toRpcRequest(type, input), type);
56 final SettableFuture<DOMRpcResult> ret = SettableFuture.create();
57 Futures.addCallback(delegateFuture, new FutureCallback<RpcResult<NetconfMessage>>() {
59 public void onSuccess(final RpcResult<NetconfMessage> result) {
61 ret.set(result.isSuccessful() ? transformer.toRpcResult(result.getResult(), type)
62 : new DefaultDOMRpcResult(result.getErrors()));
63 } catch (Exception cause) {
64 ret.setException(new DefaultDOMRpcException(
65 "Unable to parse rpc reply. type: " + type + " input: " + input, cause));
70 public void onFailure(final Throwable cause) {
71 ret.setException(new DOMRpcImplementationNotAvailableException(cause, "Unable to invoke rpc %s", type));
74 }, MoreExecutors.directExecutor());
79 public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(final T listener) {
80 listener.onRpcAvailable(Collections2.transform(schemaContext.getOperations(),
81 input -> DOMRpcIdentifier.create(input.getQName())));
83 // NOOP, no rpcs appear and disappear in this implementation
84 return NoOpListenerRegistration.of(listener);