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.CheckedFuture;
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 javax.annotation.Nonnull;
18 import javax.annotation.Nullable;
19 import org.opendaylight.controller.md.sal.dom.api.DOMRpcAvailabilityListener;
20 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
21 import org.opendaylight.controller.md.sal.dom.api.DOMRpcIdentifier;
22 import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
23 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
24 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
25 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
26 import org.opendaylight.netconf.api.NetconfMessage;
27 import org.opendaylight.netconf.sal.connect.api.MessageTransformer;
28 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceCommunicator;
29 import org.opendaylight.yangtools.concepts.ListenerRegistration;
30 import org.opendaylight.yangtools.yang.common.RpcResult;
31 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
33 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
36 * Invokes RPC by sending netconf message via listener. Also transforms result from NetconfMessage to CompositeNode.
38 public final class NetconfDeviceRpc implements DOMRpcService {
40 private final RemoteDeviceCommunicator<NetconfMessage> communicator;
41 private final MessageTransformer<NetconfMessage> transformer;
42 private final SchemaContext schemaContext;
44 public NetconfDeviceRpc(final SchemaContext schemaContext,
45 final RemoteDeviceCommunicator<NetconfMessage> communicator,
46 final MessageTransformer<NetconfMessage> transformer) {
47 this.communicator = communicator;
48 this.transformer = transformer;
49 this.schemaContext = requireNonNull(schemaContext);
54 public CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(@Nonnull final SchemaPath type,
55 @Nullable final NormalizedNode<?, ?> input) {
56 final NetconfMessage message = transformer.toRpcRequest(type, input);
57 final ListenableFuture<RpcResult<NetconfMessage>> delegateFutureWithPureResult =
58 communicator.sendRequest(message, type.getLastComponent());
60 final ListenableFuture<DOMRpcResult> transformed =
61 Futures.transform(delegateFutureWithPureResult, input1 -> {
62 if (input1.isSuccessful()) {
63 return transformer.toRpcResult(input1.getResult(), type);
65 return new DefaultDOMRpcResult(input1.getErrors());
67 }, MoreExecutors.directExecutor());
69 return Futures.makeChecked(transformed, exception ->
70 new DOMRpcImplementationNotAvailableException(exception, "Unable to invoke rpc %s", type));
75 public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(
76 @Nonnull final T listener) {
78 listener.onRpcAvailable(Collections2.transform(schemaContext.getOperations(),
79 input -> DOMRpcIdentifier.create(input.getPath())));
81 return new ListenerRegistration<T>() {
84 // NOOP, no rpcs appear and disappear in this implementation
88 public T getInstance() {