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.controller.sal.connect.netconf;
10 import com.google.common.collect.Sets;
11 import io.netty.util.concurrent.Future;
12 import io.netty.util.concurrent.FutureListener;
14 import java.util.ArrayDeque;
15 import java.util.Collection;
16 import java.util.Collections;
17 import java.util.Iterator;
18 import java.util.Queue;
21 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
22 import org.opendaylight.controller.netconf.api.NetconfMessage;
23 import org.opendaylight.controller.netconf.api.NetconfTerminationReason;
24 import org.opendaylight.controller.netconf.client.NetconfClientSession;
25 import org.opendaylight.controller.netconf.client.NetconfClientSessionListener;
26 import org.opendaylight.controller.netconf.util.xml.XmlElement;
27 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
28 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
29 import org.opendaylight.controller.sal.common.util.Rpcs;
30 import org.opendaylight.controller.sal.core.api.mount.MountProvisionInstance;
31 import org.opendaylight.yangtools.yang.common.QName;
32 import org.opendaylight.yangtools.yang.common.RpcError;
33 import org.opendaylight.yangtools.yang.common.RpcResult;
34 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
35 import org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider;
36 import org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProviders;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
40 import com.google.common.base.Preconditions;
41 import com.google.common.util.concurrent.Futures;
42 import com.google.common.util.concurrent.ListenableFuture;
44 class NetconfDeviceListener implements NetconfClientSessionListener {
46 private static final class Request {
47 final UncancellableFuture<RpcResult<CompositeNode>> future;
48 final NetconfMessage request;
51 private Request(UncancellableFuture<RpcResult<CompositeNode>> future, NetconfMessage request, final QName rpc) {
53 this.request = request;
58 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceListener.class);
59 private final Queue<Request> requests = new ArrayDeque<>();
60 private final NetconfDevice device;
61 private NetconfClientSession session;
63 public NetconfDeviceListener(final NetconfDevice device) {
64 this.device = Preconditions.checkNotNull(device);
68 public synchronized void onSessionUp(final NetconfClientSession session) {
69 LOG.debug("Session with {} established as address {} session-id {}",
70 device.getName(), device.getSocketAddress(), session.getSessionId());
72 this.session = session;
74 final Set<QName> caps = device.getCapabilities(session.getServerCapabilities());
75 LOG.trace("Server {} advertized capabilities {}", device.getName(), caps);
77 // Select the appropriate provider
78 final SchemaSourceProvider<String> delegate;
79 if (NetconfRemoteSchemaSourceProvider.isSupportedFor(caps)) {
80 delegate = new NetconfRemoteSchemaSourceProvider(device);
81 // FIXME caps do not contain urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring, since it is filtered out in getCapabilitites
82 } else if(session.getServerCapabilities().contains(NetconfRemoteSchemaSourceProvider.IETF_NETCONF_MONITORING.getNamespace().toString())) {
83 delegate = new NetconfRemoteSchemaSourceProvider(device);
85 LOG.info("Netconf server {} does not support IETF Netconf Monitoring", device.getName());
86 delegate = SchemaSourceProviders.noopProvider();
89 device.bringUp(delegate, caps, isRollbackSupported(session.getServerCapabilities()));
93 private static boolean isRollbackSupported(final Collection<String> serverCapabilities) {
94 // TODO rollback capability cannot be searched for in Set<QName> caps
95 // since this set does not contain module-less capabilities
96 return Sets.newHashSet(serverCapabilities).contains(NetconfMapping.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
99 private synchronized void tearDown(final Exception e) {
103 * Walk all requests, check if they have been executing
104 * or cancelled and remove them from the queue.
106 final Iterator<Request> it = requests.iterator();
107 while (it.hasNext()) {
108 final Request r = it.next();
109 if (r.future.isUncancellable()) {
110 // FIXME: add a RpcResult instead?
111 r.future.setException(e);
113 } else if (r.future.isCancelled()) {
114 // This just does some house-cleaning
123 public void onSessionDown(final NetconfClientSession session, final Exception e) {
124 LOG.debug("Session with {} went down", device.getName(), e);
129 public void onSessionTerminated(final NetconfClientSession session, final NetconfTerminationReason reason) {
130 LOG.debug("Session with {} terminated {}", session, reason);
131 tearDown(new RuntimeException(reason.getErrorMessage()));
135 public void onMessage(final NetconfClientSession session, final NetconfMessage message) {
137 * Dispatch between notifications and messages. Messages need to be processed
138 * with lock held, notifications do not.
140 if (isNotification(message)) {
141 processNotification(message);
143 processMessage(message);
147 private synchronized void processMessage(final NetconfMessage message) {
148 final Request r = requests.peek();
149 if (r.future.isUncancellable()) {
151 LOG.debug("Matched {} to {}", r.request, message);
154 NetconfMapping.checkValidReply(r.request, message);
155 } catch (IllegalStateException e) {
156 LOG.warn("Invalid request-reply match, reply message contains different message-id", e);
157 r.future.setException(e);
162 NetconfMapping.checkSuccessReply(message);
163 } catch (NetconfDocumentedException | IllegalStateException e) {
164 LOG.warn("Error reply from remote device", e);
165 r.future.setException(e);
169 r.future.set(NetconfMapping.toRpcResult(message, r.rpc, device.getSchemaContext()));
171 LOG.warn("Ignoring unsolicited message", message);
175 synchronized ListenableFuture<RpcResult<CompositeNode>> sendRequest(final NetconfMessage message, final QName rpc) {
176 if (session == null) {
177 LOG.debug("Session to {} is disconnected, failing RPC request {}", device.getName(), message);
178 return Futures.<RpcResult<CompositeNode>>immediateFuture(new RpcResult<CompositeNode>() {
180 public boolean isSuccessful() {
185 public CompositeNode getResult() {
190 public Collection<RpcError> getErrors() {
191 // FIXME: indicate that the session is down
192 return Collections.emptySet();
197 final Request req = new Request(new UncancellableFuture<RpcResult<CompositeNode>>(true), message, rpc);
200 session.sendMessage(req.request).addListener(new FutureListener<Void>() {
202 public void operationComplete(final Future<Void> future) throws Exception {
203 if (!future.isSuccess()) {
204 // We expect that a session down will occur at this point
205 LOG.debug("Failed to send request {}", XmlUtil.toString(req.request.getDocument()), future.cause());
206 req.future.setException(future.cause());
208 LOG.trace("Finished sending request {}", req.request);
217 * Process an incoming notification.
219 * @param notification Notification message
221 private void processNotification(final NetconfMessage notification) {
222 this.device.logger.debug("Received NETCONF notification.", notification);
223 CompositeNode domNotification = NetconfMapping.toNotificationNode(notification, device.getSchemaContext());
224 if (domNotification == null) {
228 MountProvisionInstance mountInstance = this.device.getMountInstance();
229 if (mountInstance != null) {
230 mountInstance.publish(domNotification);
234 private static boolean isNotification(final NetconfMessage message) {
235 final XmlElement xmle = XmlElement.fromDomDocument(message.getDocument());
236 return XmlNetconfConstants.NOTIFICATION_ELEMENT_NAME.equals(xmle.getName()) ;