2 * Copyright (c) 2013 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
9 package org.opendaylight.controller.protocol_plugin.openflow.internal;
11 import java.util.Collections;
12 import java.util.Date;
13 import java.util.Dictionary;
14 import java.util.HashMap;
15 import java.util.HashSet;
18 import java.util.concurrent.ConcurrentHashMap;
19 import java.util.concurrent.ConcurrentMap;
21 import org.apache.felix.dm.Component;
22 import org.opendaylight.controller.protocol_plugin.openflow.IInventoryProvider;
23 import org.opendaylight.controller.protocol_plugin.openflow.IInventoryShimInternalListener;
24 import org.opendaylight.controller.protocol_plugin.openflow.core.IController;
25 import org.opendaylight.controller.protocol_plugin.openflow.core.ISwitch;
26 import org.opendaylight.controller.sal.core.ConstructionException;
27 import org.opendaylight.controller.sal.core.Node;
28 import org.opendaylight.controller.sal.core.Node.NodeIDType;
29 import org.opendaylight.controller.sal.core.NodeConnector;
30 import org.opendaylight.controller.sal.core.Property;
31 import org.opendaylight.controller.sal.core.UpdateType;
32 import org.opendaylight.controller.sal.inventory.IPluginInInventoryService;
33 import org.opendaylight.controller.sal.inventory.IPluginOutInventoryService;
34 import org.opendaylight.controller.sal.utils.GlobalConstants;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
39 * The class describes inventory service protocol plugin. One instance per
40 * container of the network. Each instance gets container specific inventory
41 * events from InventoryServiceShim. It interacts with SAL to pass inventory
42 * data to the upper application.
46 public class InventoryService implements IInventoryShimInternalListener,
47 IPluginInInventoryService, IInventoryProvider {
48 protected static final Logger logger = LoggerFactory
49 .getLogger(InventoryService.class);
50 private Set<IPluginOutInventoryService> pluginOutInventoryServices = Collections
51 .synchronizedSet(new HashSet<IPluginOutInventoryService>());
52 private IController controller = null;
53 private ConcurrentMap<Node, Map<String, Property>> nodeProps; // properties are maintained in global container only
54 private ConcurrentMap<NodeConnector, Map<String, Property>> nodeConnectorProps; // properties are maintained in global container only
55 private boolean isDefaultContainer = false;
56 private String containerName = null;
58 void setController(IController s) {
62 void unsetController(IController s) {
63 if (this.controller == s) {
64 this.controller = null;
69 * Function called by the dependency manager when all the required
70 * dependencies are satisfied
73 @SuppressWarnings("rawtypes")
74 void init(Component c) {
75 logger.trace("INIT called!");
77 Dictionary props = c.getServiceProperties();
79 containerName = (String) props.get("containerName");
80 isDefaultContainer = containerName.equals(GlobalConstants.DEFAULT
84 nodeProps = new ConcurrentHashMap<Node, Map<String, Property>>();
85 nodeConnectorProps = new ConcurrentHashMap<NodeConnector, Map<String, Property>>();
89 * Function called by the dependency manager when at least one dependency
90 * become unsatisfied or when the component is shutting down because for
91 * example bundle is being stopped.
95 logger.trace("DESTROY called!");
99 * Function called by dependency manager after "init ()" is called and after
100 * the services provided by the class are registered in the service registry
104 logger.trace("START called!");
108 * Function called by the dependency manager before the services exported by
109 * the component are unregistered, this will be followed by a "destroy ()"
114 logger.trace("STOP called!");
117 public void setPluginOutInventoryServices(IPluginOutInventoryService service) {
118 logger.trace("Got a service set request {}", service);
119 if (this.pluginOutInventoryServices != null) {
120 this.pluginOutInventoryServices.add(service);
124 public void unsetPluginOutInventoryServices(
125 IPluginOutInventoryService service) {
126 logger.trace("Got a service UNset request");
127 if (this.pluginOutInventoryServices != null) {
128 this.pluginOutInventoryServices.remove(service);
132 protected Node OFSwitchToNode(ISwitch sw) {
134 Object id = sw.getId();
137 node = new Node(NodeIDType.OPENFLOW, id);
138 } catch (ConstructionException e) {
146 * Retrieve nodes from openflow
149 public ConcurrentMap<Node, Map<String, Property>> getNodeProps() {
150 logger.debug("getNodePros for container {}", containerName);
155 public ConcurrentMap<NodeConnector, Map<String, Property>> getNodeConnectorProps(
157 if (nodeConnectorProps == null) {
161 if (isDefaultContainer && refresh) {
162 Map<Long, ISwitch> switches = controller.getSwitches();
163 for (ISwitch sw : switches.values()) {
164 Map<NodeConnector, Set<Property>> ncProps = InventoryServiceHelper
165 .OFSwitchToProps(sw);
166 for (Map.Entry<NodeConnector, Set<Property>> entry : ncProps
168 updateNodeConnector(entry.getKey(), UpdateType.ADDED,
174 return nodeConnectorProps;
178 public void updateNodeConnector(NodeConnector nodeConnector,
179 UpdateType type, Set<Property> props) {
180 logger.trace("updateNodeConnector {} type {}", nodeConnector,
182 if (nodeConnectorProps == null) {
183 logger.trace("nodeConnectorProps is null");
187 Map<String, Property> propMap = nodeConnectorProps.get(nodeConnector);
191 if (propMap == null) {
192 propMap = new HashMap<String, Property>();
195 for (Property prop : props) {
196 propMap.put(prop.getName(), prop);
199 nodeConnectorProps.put(nodeConnector, propMap);
202 nodeConnectorProps.remove(nodeConnector);
208 // update sal and discovery
209 synchronized (pluginOutInventoryServices) {
210 for (IPluginOutInventoryService service : pluginOutInventoryServices) {
211 service.updateNodeConnector(nodeConnector, type, props);
216 private void addNode(Node node, Set<Property> props) {
217 if (nodeProps == null) {
221 Set<Node> nodeSet = nodeProps.keySet();
222 if (((props == null) || props.isEmpty()) && (nodeSet != null)
223 && nodeSet.contains(node)) {
224 // node already added
228 logger.trace("addNode: {} added, props: {} for container {}",
229 new Object[] { node, props, containerName });
231 // update local cache
232 Map<String, Property> propMap = nodeProps.get(node);
233 if (propMap == null) {
234 propMap = new HashMap<String, Property>();
238 for (Property prop : props) {
239 propMap.put(prop.getName(), prop);
242 nodeProps.put(node, propMap);
245 synchronized (pluginOutInventoryServices) {
246 for (IPluginOutInventoryService service : pluginOutInventoryServices) {
247 service.updateNode(node, UpdateType.ADDED, props);
252 private void removeNode(Node node) {
253 logger.trace("{} removed", node);
254 if (nodeProps == null)
257 // update local cache
258 nodeProps.remove(node);
260 Set<NodeConnector> removeSet = new HashSet<NodeConnector>();
261 for (NodeConnector nodeConnector : nodeConnectorProps.keySet()) {
262 if (nodeConnector.getNode().equals(node)) {
263 removeSet.add(nodeConnector);
266 for (NodeConnector nodeConnector : removeSet) {
267 nodeConnectorProps.remove(nodeConnector);
271 synchronized (pluginOutInventoryServices) {
272 for (IPluginOutInventoryService service : pluginOutInventoryServices) {
273 service.updateNode(node, UpdateType.REMOVED, null);
278 private void updateNode(Node node, Set<Property> properties) {
279 logger.trace("{} updated, props: {}", node, properties);
280 if (nodeProps == null || !nodeProps.containsKey(node) ||
281 properties == null || properties.isEmpty()) {
285 // Update local cache with new properties
286 Set<Property> newProperties = new HashSet<Property>(properties.size());
287 Map<String, Property> propertyMap = nodeProps.get(node);
288 for (Property property : properties) {
289 String name = property.getName();
290 Property currentProperty = propertyMap.get(name);
291 if (!property.equals(currentProperty)) {
292 propertyMap.put(name, property);
293 newProperties.add(property);
297 // Update SAL if we got new properties
298 if (!newProperties.isEmpty()) {
299 synchronized (pluginOutInventoryServices) {
300 for (IPluginOutInventoryService service : pluginOutInventoryServices) {
301 service.updateNode(node, UpdateType.CHANGED, newProperties);
308 public void updateNode(Node node, UpdateType type, Set<Property> props) {
311 addNode(node, props);
317 updateNode(node, props);