2 * Copyright (c) 2015 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 org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps.getSourceNode;
11 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME;
12 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME;
13 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toPath;
15 import com.google.common.base.Preconditions;
16 import com.google.common.util.concurrent.CheckedFuture;
17 import com.google.common.util.concurrent.FutureCallback;
18 import com.google.common.util.concurrent.Futures;
19 import com.google.common.util.concurrent.MoreExecutors;
20 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
21 import java.util.concurrent.ScheduledExecutorService;
22 import java.util.concurrent.ScheduledFuture;
23 import java.util.concurrent.TimeUnit;
24 import java.util.concurrent.atomic.AtomicBoolean;
25 import javax.annotation.Nonnull;
26 import javax.annotation.Nullable;
27 import org.opendaylight.controller.md.sal.dom.api.DOMActionService;
28 import org.opendaylight.controller.md.sal.dom.api.DOMNotification;
29 import org.opendaylight.controller.md.sal.dom.api.DOMRpcAvailabilityListener;
30 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
31 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
32 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
33 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
34 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator;
35 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
36 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
37 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
38 import org.opendaylight.yangtools.concepts.ListenerRegistration;
39 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
41 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
42 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
47 * SalFacade proxy that invokes keepalive RPCs to prevent session shutdown from remote device
48 * and to detect incorrect session drops (netconf session is inactive, but TCP/SSH connection is still present).
49 * The keepalive RPC is a get-config with empty filter.
51 public final class KeepaliveSalFacade implements RemoteDeviceHandler<NetconfSessionPreferences> {
53 private static final Logger LOG = LoggerFactory.getLogger(KeepaliveSalFacade.class);
55 // 2 minutes keepalive delay by default
56 private static final long DEFAULT_DELAY = TimeUnit.MINUTES.toSeconds(2);
58 // 1 minute transaction timeout by default
59 private static final long DEFAULT_TRANSACTION_TIMEOUT_MILLI = TimeUnit.MILLISECONDS.toMillis(60000);
61 private final RemoteDeviceId id;
62 private final RemoteDeviceHandler<NetconfSessionPreferences> salFacade;
63 private final ScheduledExecutorService executor;
64 private final long keepaliveDelaySeconds;
65 private final ResetKeepalive resetKeepaliveTask;
66 private final long defaultRequestTimeoutMillis;
68 private volatile NetconfDeviceCommunicator listener;
69 private volatile ScheduledFuture<?> currentKeepalive;
70 private volatile DOMRpcService currentDeviceRpc;
71 private final AtomicBoolean lastKeepAliveSucceeded = new AtomicBoolean(false);
73 public KeepaliveSalFacade(final RemoteDeviceId id, final RemoteDeviceHandler<NetconfSessionPreferences> salFacade,
74 final ScheduledExecutorService executor, final long keepaliveDelaySeconds,
75 final long defaultRequestTimeoutMillis) {
77 this.salFacade = salFacade;
78 this.executor = executor;
79 this.keepaliveDelaySeconds = keepaliveDelaySeconds;
80 this.defaultRequestTimeoutMillis = defaultRequestTimeoutMillis;
81 this.resetKeepaliveTask = new ResetKeepalive();
84 public KeepaliveSalFacade(final RemoteDeviceId id, final RemoteDeviceHandler<NetconfSessionPreferences> salFacade,
85 final ScheduledExecutorService executor) {
86 this(id, salFacade, executor, DEFAULT_DELAY, DEFAULT_TRANSACTION_TIMEOUT_MILLI);
90 * Set the netconf session listener whenever ready.
92 * @param listener netconf session listener
94 public void setListener(final NetconfDeviceCommunicator listener) {
95 this.listener = listener;
99 * Just cancel current keepalive task.
100 * If its already started, let it finish ... not such a big deal.
103 * Then schedule next keepalive.
105 void resetKeepalive() {
106 LOG.trace("{}: Resetting netconf keepalive timer", id);
107 if (currentKeepalive != null) {
108 currentKeepalive.cancel(false);
110 scheduleKeepalives();
114 * Cancel current keepalive and also reset current deviceRpc.
116 private void stopKeepalives() {
117 if (currentKeepalive != null) {
118 currentKeepalive.cancel(false);
120 currentDeviceRpc = null;
124 Preconditions.checkState(listener != null, "%s: Unable to reconnect, session listener is missing", id);
126 LOG.info("{}: Reconnecting inactive netconf session", id);
127 listener.disconnect();
131 public void onDeviceConnected(final SchemaContext remoteSchemaContext,
132 final NetconfSessionPreferences netconfSessionPreferences, final DOMRpcService deviceRpc) {
133 onDeviceConnected(remoteSchemaContext, netconfSessionPreferences, deviceRpc, null);
137 public void onDeviceConnected(SchemaContext remoteSchemaContext,
138 NetconfSessionPreferences netconfSessionPreferences, DOMRpcService deviceRpc,
139 DOMActionService deviceAction) {
140 this.currentDeviceRpc = deviceRpc;
141 final DOMRpcService deviceRpc1 =
142 new KeepaliveDOMRpcService(deviceRpc, resetKeepaliveTask, defaultRequestTimeoutMillis, executor);
144 salFacade.onDeviceConnected(remoteSchemaContext, netconfSessionPreferences, deviceRpc1, deviceAction);
146 LOG.debug("{}: Netconf session initiated, starting keepalives", id);
147 scheduleKeepalives();
150 private void scheduleKeepalives() {
151 lastKeepAliveSucceeded.set(true);
152 Preconditions.checkState(currentDeviceRpc != null);
153 LOG.trace("{}: Scheduling keepalives every {} {}", id, keepaliveDelaySeconds, TimeUnit.SECONDS);
154 currentKeepalive = executor.scheduleWithFixedDelay(new Keepalive(),
155 keepaliveDelaySeconds, keepaliveDelaySeconds, TimeUnit.SECONDS);
159 public void onDeviceDisconnected() {
161 salFacade.onDeviceDisconnected();
165 public void onDeviceFailed(final Throwable throwable) {
167 salFacade.onDeviceFailed(throwable);
171 public void onNotification(final DOMNotification domNotification) {
173 salFacade.onNotification(domNotification);
177 public void close() {
182 // Keepalive RPC static resources
183 private static final SchemaPath PATH = toPath(NETCONF_GET_CONFIG_QNAME);
184 private static final ContainerNode KEEPALIVE_PAYLOAD = NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME,
185 getSourceNode(NETCONF_RUNNING_QNAME), NetconfMessageTransformUtil.EMPTY_FILTER);
188 * Invoke keepalive RPC and check the response. In case of any received response the keepalive
189 * is considered successful and schedules next keepalive with a fixed delay. If the response is unsuccessful (no
190 * response received, or the rcp could not even be sent) immediate reconnect is triggered as netconf session
191 * is considered inactive/failed.
193 private class Keepalive implements Runnable, FutureCallback<DOMRpcResult> {
197 LOG.trace("{}: Invoking keepalive RPC", id);
200 boolean lastJobSucceeded = lastKeepAliveSucceeded.getAndSet(false);
201 if (!lastJobSucceeded) {
202 onFailure(new IllegalStateException("Previous keepalive timed out"));
204 Futures.addCallback(currentDeviceRpc.invokeRpc(PATH, KEEPALIVE_PAYLOAD), this,
205 MoreExecutors.directExecutor());
207 } catch (NullPointerException e) {
208 LOG.debug("{}: Skipping keepalive while reconnecting", id);
209 // Empty catch block intentional
210 // Do nothing. The currentDeviceRpc was null and it means we hit the reconnect window and
211 // attempted to send keepalive while we were reconnecting. Next keepalive will be scheduled
212 // after reconnect so no action necessary here.
216 @SuppressFBWarnings(value = "RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE",
217 justification = "Unrecognised NullableDecl")
219 public void onSuccess(final DOMRpcResult result) {
220 // No matter what response we got, rpc-reply or rpc-error,
221 // we got it from device so the netconf session is OK
222 if (result != null && result.getResult() != null) {
223 lastKeepAliveSucceeded.set(true);
224 } else if (result != null && result.getErrors() != null) {
225 LOG.warn("{}: Keepalive RPC failed with error: {}", id, result.getErrors());
226 lastKeepAliveSucceeded.set(true);
228 LOG.warn("{} Keepalive RPC returned null with response. Reconnecting netconf session", id);
234 public void onFailure(@Nonnull final Throwable throwable) {
235 LOG.warn("{}: Keepalive RPC failed. Reconnecting netconf session.", id, throwable);
241 * Reset keepalive after each RPC response received.
243 private class ResetKeepalive implements FutureCallback<DOMRpcResult> {
245 public void onSuccess(@Nullable final DOMRpcResult result) {
246 // No matter what response we got,
247 // rpc-reply or rpc-error, we got it from device so the netconf session is OK.
252 public void onFailure(@Nonnull final Throwable throwable) {
253 // User/Application RPC failed (The RPC did not reach the remote device or ..
254 // TODO what other reasons could cause this ?)
255 // There is no point in keeping this session. Reconnect.
256 LOG.warn("{}: Rpc failure detected. Reconnecting netconf session", id, throwable);
262 * Request timeout task is called once the defaultRequestTimeoutMillis is
263 * reached. At this moment, if the request is not yet finished, we cancel
266 private static final class RequestTimeoutTask implements Runnable {
268 private final CheckedFuture<DOMRpcResult, DOMRpcException> rpcResultFuture;
270 RequestTimeoutTask(final CheckedFuture<DOMRpcResult, DOMRpcException> rpcResultFuture) {
271 this.rpcResultFuture = rpcResultFuture;
276 if (!rpcResultFuture.isDone()) {
277 rpcResultFuture.cancel(true);
283 * DOMRpcService proxy that attaches reset-keepalive-task and schedule
284 * request-timeout-task to each RPC invocation.
286 public static final class KeepaliveDOMRpcService implements DOMRpcService {
288 private final DOMRpcService deviceRpc;
289 private final ResetKeepalive resetKeepaliveTask;
290 private final long defaultRequestTimeoutMillis;
291 private final ScheduledExecutorService executor;
293 KeepaliveDOMRpcService(final DOMRpcService deviceRpc, final ResetKeepalive resetKeepaliveTask,
294 final long defaultRequestTimeoutMillis, final ScheduledExecutorService executor) {
295 this.deviceRpc = deviceRpc;
296 this.resetKeepaliveTask = resetKeepaliveTask;
297 this.defaultRequestTimeoutMillis = defaultRequestTimeoutMillis;
298 this.executor = executor;
301 public DOMRpcService getDeviceRpc() {
307 public CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(@Nonnull final SchemaPath type,
308 final NormalizedNode<?, ?> input) {
309 final CheckedFuture<DOMRpcResult, DOMRpcException> domRpcResultDOMRpcExceptionCheckedFuture =
310 deviceRpc.invokeRpc(type, input);
311 Futures.addCallback(domRpcResultDOMRpcExceptionCheckedFuture, resetKeepaliveTask,
312 MoreExecutors.directExecutor());
314 final RequestTimeoutTask timeoutTask = new RequestTimeoutTask(domRpcResultDOMRpcExceptionCheckedFuture);
315 executor.schedule(timeoutTask, defaultRequestTimeoutMillis, TimeUnit.MILLISECONDS);
317 return domRpcResultDOMRpcExceptionCheckedFuture;
321 public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(
322 @Nonnull final T listener) {
323 // There is no real communication with the device (yet), no reset here
324 return deviceRpc.registerRpcListener(listener);