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.sal;
10 import com.google.common.collect.Lists;
11 import com.google.common.collect.Maps;
12 import java.util.Collections;
13 import java.util.List;
15 import java.util.concurrent.ExecutorService;
16 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
17 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
18 import org.opendaylight.controller.sal.connect.api.RemoteDeviceHandler;
19 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionCapabilities;
20 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
21 import org.opendaylight.controller.sal.core.api.Broker;
22 import org.opendaylight.controller.sal.core.api.RpcImplementation;
23 import org.opendaylight.controller.sal.core.api.RpcProvisionRegistry;
24 import org.opendaylight.controller.sal.core.api.notify.NotificationListener;
25 import org.opendaylight.controller.sal.core.api.notify.NotificationPublishService;
26 import org.opendaylight.controller.sal.dom.broker.impl.NotificationRouterImpl;
27 import org.opendaylight.controller.sal.dom.broker.impl.SchemaAwareRpcBroker;
28 import org.opendaylight.controller.sal.dom.broker.spi.NotificationRouter;
29 import org.opendaylight.yangtools.concepts.ListenerRegistration;
30 import org.opendaylight.yangtools.yang.common.QName;
31 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
32 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
33 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
34 import org.osgi.framework.BundleContext;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
38 public final class NetconfDeviceSalFacade implements AutoCloseable, RemoteDeviceHandler<NetconfSessionCapabilities> {
40 private static final Logger logger= LoggerFactory.getLogger(NetconfDeviceSalFacade.class);
42 private final RemoteDeviceId id;
43 private final NetconfDeviceSalProvider salProvider;
45 private final List<AutoCloseable> salRegistrations = Lists.newArrayList();
47 public NetconfDeviceSalFacade(final RemoteDeviceId id, final Broker domBroker, final BindingAwareBroker bindingBroker, final BundleContext bundleContext, final ExecutorService executor) {
49 this.salProvider = new NetconfDeviceSalProvider(id, executor);
50 registerToSal(domBroker, bindingBroker, bundleContext);
53 public void registerToSal(final Broker domRegistryDependency, final BindingAwareBroker bindingBroker, final BundleContext bundleContext) {
54 domRegistryDependency.registerProvider(salProvider, bundleContext);
55 bindingBroker.registerProvider(salProvider, bundleContext);
59 public synchronized void onNotification(final CompositeNode domNotification) {
60 salProvider.getMountInstance().publish(domNotification);
64 public synchronized void onDeviceConnected(final SchemaContext schemaContext,
65 final NetconfSessionCapabilities netconfSessionPreferences, final RpcImplementation deviceRpc) {
67 // TODO move SchemaAwareRpcBroker from sal-broker-impl, now we have depend on the whole sal-broker-impl
68 final RpcProvisionRegistry rpcRegistry = new SchemaAwareRpcBroker(id.getPath().toString(), new org.opendaylight.controller.sal.dom.broker.impl.SchemaContextProvider() {
70 public SchemaContext getSchemaContext() {
74 registerRpcsToSal(schemaContext, rpcRegistry, deviceRpc);
75 final DOMDataBroker domBroker = new NetconfDeviceDataBroker(id, deviceRpc, schemaContext, netconfSessionPreferences);
77 // TODO NotificationPublishService and NotificationRouter have the same interface
78 final NotificationPublishService notificationService = new NotificationPublishService() {
80 private final NotificationRouter innerRouter = new NotificationRouterImpl();
83 public void publish(final CompositeNode notification) {
84 innerRouter.publish(notification);
88 public ListenerRegistration<NotificationListener> addNotificationListener(final QName notification, final NotificationListener listener) {
89 return innerRouter.addNotificationListener(notification, listener);
93 salProvider.getMountInstance().onDeviceConnected(schemaContext, domBroker, rpcRegistry, notificationService);
94 salProvider.getDatastoreAdapter().updateDeviceState(true, netconfSessionPreferences.getModuleBasedCaps());
98 public void onDeviceDisconnected() {
99 salProvider.getDatastoreAdapter().updateDeviceState(false, Collections.<QName>emptySet());
100 salProvider.getMountInstance().onDeviceDisconnected();
103 private void registerRpcsToSal(final SchemaContext schemaContext, final RpcProvisionRegistry rpcRegistry, final RpcImplementation deviceRpc) {
104 final Map<QName, String> failedRpcs = Maps.newHashMap();
105 for (final RpcDefinition rpcDef : schemaContext.getOperations()) {
107 salRegistrations.add(rpcRegistry.addRpcImplementation(rpcDef.getQName(), deviceRpc));
108 logger.debug("{}: Rpc {} from netconf registered successfully", id, rpcDef.getQName());
109 } catch (final Exception e) {
110 // Only debug per rpc, warn for all of them at the end to pollute log a little less (e.g. routed rpcs)
111 logger.debug("{}: Unable to register rpc {} from netconf device. This rpc will not be available", id,
112 rpcDef.getQName(), e);
113 failedRpcs.put(rpcDef.getQName(), e.getClass() + ":" + e.getMessage());
117 if (failedRpcs.isEmpty() == false) {
118 if (logger.isDebugEnabled()) {
119 logger.warn("{}: Some rpcs from netconf device were not registered: {}", id, failedRpcs);
121 logger.warn("{}: Some rpcs from netconf device were not registered: {}", id, failedRpcs.keySet());
127 public void close() {
128 for (final AutoCloseable reg : Lists.reverse(salRegistrations)) {
129 closeGracefully(reg);
131 closeGracefully(salProvider);
134 private void closeGracefully(final AutoCloseable resource) {
135 if (resource != null) {
138 } catch (final Exception e) {
139 logger.warn("{}: Ignoring exception while closing {}", id, resource, e);