opendaylight/topologymanager/implementation/src/main/java/org/opendaylight/controller/topologymanager/internal/TopologyManagerImpl.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.topologymanager.internal;
  10
  11 import java.io.FileNotFoundException;
  12 import java.io.IOException;
  13 import java.io.ObjectInputStream;
  14 import java.util.ArrayList;
  15 import java.util.Dictionary;
  16 import java.util.EnumSet;
  17 import java.util.HashMap;
  18 import java.util.HashSet;
  19 import java.util.Iterator;
  20 import java.util.LinkedList;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.Set;
  24 import java.util.concurrent.BlockingQueue;
  25 import java.util.concurrent.ConcurrentHashMap;
  26 import java.util.concurrent.ConcurrentMap;
  27 import java.util.concurrent.CopyOnWriteArraySet;
  28 import java.util.concurrent.LinkedBlockingQueue;
  29
  30 import org.apache.commons.lang3.tuple.ImmutablePair;
  31 import org.apache.felix.dm.Component;
  32 import org.eclipse.osgi.framework.console.CommandInterpreter;
  33 import org.eclipse.osgi.framework.console.CommandProvider;
  34 import org.opendaylight.controller.clustering.services.CacheConfigException;
  35 import org.opendaylight.controller.clustering.services.CacheExistException;
  36 import org.opendaylight.controller.clustering.services.ICacheUpdateAware;
  37 import org.opendaylight.controller.clustering.services.IClusterContainerServices;
  38 import org.opendaylight.controller.clustering.services.IClusterServices;
  39 import org.opendaylight.controller.configuration.IConfigurationContainerAware;
  40 import org.opendaylight.controller.sal.core.Edge;
  41 import org.opendaylight.controller.sal.core.Host;
  42 import org.opendaylight.controller.sal.core.Node;
  43 import org.opendaylight.controller.sal.core.NodeConnector;
  44 import org.opendaylight.controller.sal.core.Property;
  45 import org.opendaylight.controller.sal.core.TimeStamp;
  46 import org.opendaylight.controller.sal.core.UpdateType;
  47 import org.opendaylight.controller.sal.topology.IListenTopoUpdates;
  48 import org.opendaylight.controller.sal.topology.ITopologyService;
  49 import org.opendaylight.controller.sal.topology.TopoEdgeUpdate;
  50 import org.opendaylight.controller.sal.utils.GlobalConstants;
  51 import org.opendaylight.controller.sal.utils.IObjectReader;
  52 import org.opendaylight.controller.sal.utils.ObjectReader;
  53 import org.opendaylight.controller.sal.utils.ObjectWriter;
  54 import org.opendaylight.controller.sal.utils.Status;
  55 import org.opendaylight.controller.sal.utils.StatusCode;
  56 import org.opendaylight.controller.switchmanager.ISwitchManager;
  57 import org.opendaylight.controller.topologymanager.ITopologyManager;
  58 import org.opendaylight.controller.topologymanager.ITopologyManagerAware;
  59 import org.opendaylight.controller.topologymanager.ITopologyManagerClusterWideAware;
  60 import org.opendaylight.controller.topologymanager.TopologyUserLinkConfig;
  61 import org.osgi.framework.BundleContext;
  62 import org.osgi.framework.FrameworkUtil;
  63 import org.slf4j.Logger;
  64 import org.slf4j.LoggerFactory;
  65
  66 /**
  67  * The class describes TopologyManager which is the central repository of the
  68  * network topology. It provides service for applications to interact with
  69  * topology database and notifies all the listeners of topology changes.
  70  */
  71 public class TopologyManagerImpl implements
  72         ICacheUpdateAware,
  73         ITopologyManager,
  74         IConfigurationContainerAware,
  75         IListenTopoUpdates,
  76         IObjectReader,
  77         CommandProvider {
  78     static final String TOPOEDGESDB = "topologymanager.edgesDB";
  79     static final String TOPOHOSTSDB = "topologymanager.hostsDB";
  80     static final String TOPONODECONNECTORDB = "topologymanager.nodeConnectorDB";
  81     static final String TOPOUSERLINKSDB = "topologymanager.userLinksDB";
  82     private static final Logger log = LoggerFactory.getLogger(TopologyManagerImpl.class);
  83     private ITopologyService topoService;
  84     private IClusterContainerServices clusterContainerService;
  85     private ISwitchManager switchManager;
  86     // DB of all the Edges with properties which constitute our topology
  87     private ConcurrentMap<Edge, Set<Property>> edgesDB;
  88     // DB of all NodeConnector which are part of ISL Edges, meaning they
  89     // are connected to another NodeConnector on the other side of an ISL link.
  90     // NodeConnector of a Production Edge is not part of this DB.
  91     private ConcurrentMap<NodeConnector, Set<Property>> nodeConnectorsDB;
  92     // DB of all the NodeConnectors with an Host attached to it
  93     private ConcurrentMap<NodeConnector, Set<ImmutablePair<Host, Set<Property>>>> hostsDB;
  94     // Topology Manager Aware listeners
  95     private Set<ITopologyManagerAware> topologyManagerAware = new CopyOnWriteArraySet<ITopologyManagerAware>();
  96     // Topology Manager Aware listeners - for clusterwide updates
  97     private Set<ITopologyManagerClusterWideAware> topologyManagerClusterWideAware =
  98             new CopyOnWriteArraySet<ITopologyManagerClusterWideAware>();
  99     private static String ROOT = GlobalConstants.STARTUPHOME.toString();
 100     private String userLinksFileName;
 101     private ConcurrentMap<String, TopologyUserLinkConfig> userLinksDB;
 102     private BlockingQueue<TopoEdgeUpdate> notifyQ = new LinkedBlockingQueue<TopoEdgeUpdate>();
 103     private volatile Boolean shuttingDown = false;
 104     private Thread notifyThread;
 105
 106
 107     void nonClusterObjectCreate() {
 108         edgesDB = new ConcurrentHashMap<Edge, Set<Property>>();
 109         hostsDB = new ConcurrentHashMap<NodeConnector, Set<ImmutablePair<Host, Set<Property>>>>();
 110         nodeConnectorsDB = new ConcurrentHashMap<NodeConnector, Set<Property>>();
 111         userLinksDB = new ConcurrentHashMap<String, TopologyUserLinkConfig>();
 112     }
 113
 114     void setTopologyManagerAware(ITopologyManagerAware s) {
 115         if (this.topologyManagerAware != null) {
 116             log.debug("Adding ITopologyManagerAware: {}", s);
 117             this.topologyManagerAware.add(s);
 118         }
 119     }
 120
 121     void unsetTopologyManagerAware(ITopologyManagerAware s) {
 122         if (this.topologyManagerAware != null) {
 123             log.debug("Removing ITopologyManagerAware: {}", s);
 124             this.topologyManagerAware.remove(s);
 125         }
 126     }
 127
 128     void setTopologyManagerClusterWideAware(ITopologyManagerClusterWideAware s) {
 129         if (this.topologyManagerClusterWideAware != null) {
 130             log.debug("Adding ITopologyManagerClusterWideAware: {}", s);
 131             this.topologyManagerClusterWideAware.add(s);
 132         }
 133     }
 134
 135     void unsetTopologyManagerClusterWideAware(ITopologyManagerClusterWideAware s) {
 136         if (this.topologyManagerClusterWideAware != null) {
 137             log.debug("Removing ITopologyManagerClusterWideAware: {}", s);
 138             this.topologyManagerClusterWideAware.remove(s);
 139         }
 140     }
 141
 142     void setTopoService(ITopologyService s) {
 143         log.debug("Adding ITopologyService: {}", s);
 144         this.topoService = s;
 145     }
 146
 147     void unsetTopoService(ITopologyService s) {
 148         if (this.topoService == s) {
 149             log.debug("Removing ITopologyService: {}", s);
 150             this.topoService = null;
 151         }
 152     }
 153
 154     void setClusterContainerService(IClusterContainerServices s) {
 155         log.debug("Cluster Service set");
 156         this.clusterContainerService = s;
 157     }
 158
 159     void unsetClusterContainerService(IClusterContainerServices s) {
 160         if (this.clusterContainerService == s) {
 161             log.debug("Cluster Service removed!");
 162             this.clusterContainerService = null;
 163         }
 164     }
 165
 166     void setSwitchManager(ISwitchManager s) {
 167         log.debug("Adding ISwitchManager: {}", s);
 168         this.switchManager = s;
 169     }
 170
 171     void unsetSwitchManager(ISwitchManager s) {
 172         if (this.switchManager == s) {
 173             log.debug("Removing ISwitchManager: {}", s);
 174             this.switchManager = null;
 175         }
 176     }
 177
 178     /**
 179      * Function called by the dependency manager when all the required
 180      * dependencies are satisfied
 181      *
 182      */
 183     void init(Component c) {
 184         allocateCaches();
 185         retrieveCaches();
 186         String containerName = null;
 187         Dictionary<?, ?> props = c.getServiceProperties();
 188         if (props != null) {
 189             containerName = (String) props.get("containerName");
 190         } else {
 191             // In the Global instance case the containerName is empty
 192             containerName = "UNKNOWN";
 193         }
 194
 195         userLinksFileName = ROOT + "userTopology_" + containerName + ".conf";
 196         registerWithOSGIConsole();
 197         loadConfiguration();
 198         // Restore the shuttingDown status on init of the component
 199         shuttingDown = false;
 200         notifyThread = new Thread(new TopologyNotify(notifyQ));
 201     }
 202
 203     @SuppressWarnings({ "unchecked", "deprecation" })
 204     private void allocateCaches() {
 205         try {
 206             this.edgesDB =
 207                     (ConcurrentMap<Edge, Set<Property>>) this.clusterContainerService.createCache(TOPOEDGESDB,
 208                             EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 209         } catch (CacheExistException cee) {
 210             log.debug(TOPOEDGESDB + " Cache already exists - destroy and recreate if needed");
 211         } catch (CacheConfigException cce) {
 212             log.error(TOPOEDGESDB + " Cache configuration invalid - check cache mode");
 213         }
 214
 215         try {
 216             this.hostsDB =
 217                     (ConcurrentMap<NodeConnector, Set<ImmutablePair<Host, Set<Property>>>>) this.clusterContainerService.createCache(
 218                             TOPOHOSTSDB, EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 219         } catch (CacheExistException cee) {
 220             log.debug(TOPOHOSTSDB + " Cache already exists - destroy and recreate if needed");
 221         } catch (CacheConfigException cce) {
 222             log.error(TOPOHOSTSDB + " Cache configuration invalid - check cache mode");
 223         }
 224
 225         try {
 226             this.nodeConnectorsDB =
 227                     (ConcurrentMap<NodeConnector, Set<Property>>) this.clusterContainerService.createCache(
 228                             TOPONODECONNECTORDB, EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 229         } catch (CacheExistException cee) {
 230             log.debug(TOPONODECONNECTORDB + " Cache already exists - destroy and recreate if needed");
 231         } catch (CacheConfigException cce) {
 232             log.error(TOPONODECONNECTORDB + " Cache configuration invalid - check cache mode");
 233         }
 234
 235         try {
 236             this.userLinksDB =
 237                     (ConcurrentMap<String, TopologyUserLinkConfig>) this.clusterContainerService.createCache(
 238                             TOPOUSERLINKSDB, EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 239         } catch (CacheExistException cee) {
 240             log.debug(TOPOUSERLINKSDB + " Cache already exists - destroy and recreate if needed");
 241         } catch (CacheConfigException cce) {
 242             log.error(TOPOUSERLINKSDB + " Cache configuration invalid - check cache mode");
 243         }
 244     }
 245
 246     @SuppressWarnings({ "unchecked", "deprecation" })
 247     private void retrieveCaches() {
 248         if (this.clusterContainerService == null) {
 249             log.error("Cluster Services is null, can't retrieve caches.");
 250             return;
 251         }
 252
 253         this.edgesDB = (ConcurrentMap<Edge, Set<Property>>) this.clusterContainerService.getCache(TOPOEDGESDB);
 254         if (edgesDB == null) {
 255             log.error("Failed to get cache for " + TOPOEDGESDB);
 256         }
 257
 258         this.hostsDB =
 259                 (ConcurrentMap<NodeConnector, Set<ImmutablePair<Host, Set<Property>>>>) this.clusterContainerService.getCache(TOPOHOSTSDB);
 260         if (hostsDB == null) {
 261             log.error("Failed to get cache for " + TOPOHOSTSDB);
 262         }
 263
 264         this.nodeConnectorsDB =
 265                 (ConcurrentMap<NodeConnector, Set<Property>>) this.clusterContainerService.getCache(TOPONODECONNECTORDB);
 266         if (nodeConnectorsDB == null) {
 267             log.error("Failed to get cache for " + TOPONODECONNECTORDB);
 268         }
 269
 270         this.userLinksDB =
 271                 (ConcurrentMap<String, TopologyUserLinkConfig>) this.clusterContainerService.getCache(TOPOUSERLINKSDB);
 272         if (userLinksDB == null) {
 273             log.error("Failed to get cache for " + TOPOUSERLINKSDB);
 274         }
 275     }
 276
 277     /**
 278      * Function called after the topology manager has registered the service in
 279      * OSGi service registry.
 280      *
 281      */
 282     void started() {
 283         // Start the batcher thread for the cluster wide topology updates
 284         notifyThread.start();
 285         // SollicitRefresh MUST be called here else if called at init
 286         // time it may sollicit refresh too soon.
 287         log.debug("Sollicit topology refresh");
 288         topoService.sollicitRefresh();
 289     }
 290
 291     void stop() {
 292         shuttingDown = true;
 293         notifyThread.interrupt();
 294     }
 295
 296     /**
 297      * Function called by the dependency manager when at least one dependency
 298      * become unsatisfied or when the component is shutting down because for
 299      * example bundle is being stopped.
 300      *
 301      */
 302     void destroy() {
 303         notifyQ.clear();
 304         notifyThread = null;
 305     }
 306
 307     @SuppressWarnings("unchecked")
 308     private void loadConfiguration() {
 309         ObjectReader objReader = new ObjectReader();
 310         ConcurrentMap<String, TopologyUserLinkConfig> confList =
 311                 (ConcurrentMap<String, TopologyUserLinkConfig>) objReader.read(this, userLinksFileName);
 312
 313         if (confList != null) {
 314             for (TopologyUserLinkConfig conf : confList.values()) {
 315                 addUserLink(conf);
 316             }
 317         }
 318     }
 319
 320     @Override
 321     public Status saveConfig() {
 322         return saveConfigInternal();
 323     }
 324
 325     public Status saveConfigInternal() {
 326         ObjectWriter objWriter = new ObjectWriter();
 327
 328         Status saveStatus = objWriter.write(
 329                 new ConcurrentHashMap<String, TopologyUserLinkConfig>(userLinksDB), userLinksFileName);
 330
 331         if (! saveStatus.isSuccess()) {
 332             return new Status(StatusCode.INTERNALERROR, "Topology save failed: " + saveStatus.getDescription());
 333         }
 334         return saveStatus;
 335     }
 336
 337     @Override
 338     public Map<Node, Set<Edge>> getNodeEdges() {
 339         if (this.edgesDB == null) {
 340             return null;
 341         }
 342
 343         Map<Node, Set<Edge>> res = new HashMap<Node, Set<Edge>>();
 344         for (Edge edge : this.edgesDB.keySet()) {
 345             // Lets analyze the tail
 346             Node node = edge.getTailNodeConnector().getNode();
 347             Set<Edge> nodeEdges = res.get(node);
 348             if (nodeEdges == null) {
 349                 nodeEdges = new HashSet<Edge>();
 350                 res.put(node, nodeEdges);
 351             }
 352             nodeEdges.add(edge);
 353
 354             // Lets analyze the head
 355             node = edge.getHeadNodeConnector().getNode();
 356             nodeEdges = res.get(node);
 357             if (nodeEdges == null) {
 358                 nodeEdges = new HashSet<Edge>();
 359                 res.put(node, nodeEdges);
 360             }
 361             nodeEdges.add(edge);
 362         }
 363
 364         return res;
 365     }
 366
 367     @Override
 368     public boolean isInternal(NodeConnector p) {
 369         if (this.nodeConnectorsDB == null) {
 370             return false;
 371         }
 372
 373         // This is an internal NodeConnector if is connected to
 374         // another Node i.e it's part of the nodeConnectorsDB
 375         return (this.nodeConnectorsDB.get(p) != null);
 376     }
 377
 378     /**
 379      * This method returns true if the edge is an ISL link.
 380      *
 381      * @param e
 382      *            The edge
 383      * @return true if it is an ISL link
 384      */
 385     public boolean isISLink(Edge e) {
 386         return (!isProductionLink(e));
 387     }
 388
 389     /**
 390      * This method returns true if the edge is a production link.
 391      *
 392      * @param e
 393      *            The edge
 394      * @return true if it is a production link
 395      */
 396     public boolean isProductionLink(Edge e) {
 397         return (e.getHeadNodeConnector().getType().equals(NodeConnector.NodeConnectorIDType.PRODUCTION)
 398                 || e.getTailNodeConnector().getType().equals(NodeConnector.NodeConnectorIDType.PRODUCTION));
 399     }
 400
 401     /**
 402      * The Map returned is a copy of the current topology hence if the topology
 403      * changes the copy doesn't
 404      *
 405      * @return A Map representing the current topology expressed as edges of the
 406      *         network
 407      */
 408     @Override
 409     public Map<Edge, Set<Property>> getEdges() {
 410         if (this.edgesDB == null) {
 411             return null;
 412         }
 413
 414         Map<Edge, Set<Property>> edgeMap = new HashMap<Edge, Set<Property>>();
 415         Set<Property> props;
 416         for (Map.Entry<Edge, Set<Property>> edgeEntry : edgesDB.entrySet()) {
 417             // Sets of props are copied because the composition of
 418             // those properties could change with time
 419             props = new HashSet<Property>(edgeEntry.getValue());
 420             // We can simply reuse the key because the object is
 421             // immutable so doesn't really matter that we are
 422             // referencing the only owned by a different table, the
 423             // meaning is the same because doesn't change with time.
 424             edgeMap.put(edgeEntry.getKey(), props);
 425         }
 426
 427         return edgeMap;
 428     }
 429
 430     @Override
 431     public Set<NodeConnector> getNodeConnectorWithHost() {
 432         if (this.hostsDB == null) {
 433             return null;
 434         }
 435
 436         return (new HashSet<NodeConnector>(this.hostsDB.keySet()));
 437     }
 438
 439     @Override
 440     public Map<Node, Set<NodeConnector>> getNodesWithNodeConnectorHost() {
 441         if (this.hostsDB == null) {
 442             return null;
 443         }
 444         HashMap<Node, Set<NodeConnector>> res = new HashMap<Node, Set<NodeConnector>>();
 445         Node node;
 446         Set<NodeConnector> portSet;
 447         for (NodeConnector nc : this.hostsDB.keySet()) {
 448             node = nc.getNode();
 449             portSet = res.get(node);
 450             if (portSet == null) {
 451                 // Create the HashSet if null
 452                 portSet = new HashSet<NodeConnector>();
 453                 res.put(node, portSet);
 454             }
 455
 456             // Keep updating the HashSet, given this is not a
 457             // clustered map we can just update the set without
 458             // worrying to update the hashmap.
 459             portSet.add(nc);
 460         }
 461
 462         return (res);
 463     }
 464
 465     @Override
 466     public Host getHostAttachedToNodeConnector(NodeConnector port) {
 467         List<Host> hosts = getHostsAttachedToNodeConnector(port);
 468         if(hosts != null && !hosts.isEmpty()){
 469             return hosts.get(0);
 470         }
 471         return null;
 472     }
 473
 474     @Override
 475     public List<Host> getHostsAttachedToNodeConnector(NodeConnector p) {
 476         Set<ImmutablePair<Host, Set<Property>>> hosts;
 477         if (this.hostsDB == null || (hosts = this.hostsDB.get(p)) == null) {
 478             return null;
 479         }
 480         // create a list of hosts
 481         List<Host> retHosts = new LinkedList<Host>();
 482         for(ImmutablePair<Host, Set<Property>> host : hosts) {
 483             retHosts.add(host.getLeft());
 484         }
 485         return retHosts;
 486     }
 487
 488     @Override
 489     public void updateHostLink(NodeConnector port, Host h, UpdateType t, Set<Property> props) {
 490
 491         // Clone the property set in case non null else just
 492         // create an empty one. Caches allocated via infinispan
 493         // don't allow null values
 494         if (props == null) {
 495             props = new HashSet<Property>();
 496         } else {
 497             props = new HashSet<Property>(props);
 498         }
 499         ImmutablePair<Host, Set<Property>> thisHost = new ImmutablePair<Host, Set<Property>>(h, props);
 500
 501         // get the host list
 502         Set<ImmutablePair<Host, Set<Property>>> hostSet = this.hostsDB.get(port);
 503         if(hostSet == null) {
 504             hostSet = new HashSet<ImmutablePair<Host, Set<Property>>>();
 505         }
 506         switch (t) {
 507         case ADDED:
 508         case CHANGED:
 509             hostSet.add(thisHost);
 510             this.hostsDB.put(port, hostSet);
 511             break;
 512         case REMOVED:
 513             hostSet.remove(thisHost);
 514             if(hostSet.isEmpty()) {
 515                 //remove only if hasn't been concurrently modified
 516                 this.hostsDB.remove(port, hostSet);
 517             } else {
 518                 this.hostsDB.put(port, hostSet);
 519             }
 520             break;
 521         }
 522     }
 523
 524     private boolean nodeConnectorsExist(Edge e) {
 525         NodeConnector head = e.getHeadNodeConnector();
 526         NodeConnector tail = e.getTailNodeConnector();
 527         return (switchManager.doesNodeConnectorExist(head) &&
 528                 switchManager.doesNodeConnectorExist(tail));
 529     }
 530
 531     private TopoEdgeUpdate edgeUpdate(Edge e, UpdateType type, Set<Property> props) {
 532         switch (type) {
 533         case ADDED:
 534             // Ensure that both tail and head node connectors exist.
 535             if (!nodeConnectorsExist(e)) {
 536                 log.warn("Ignore edge that contains invalid node connector: {}", e);
 537                 return null;
 538             }
 539
 540             // Make sure the props are non-null
 541             if (props == null) {
 542                 props = new HashSet<Property>();
 543             } else {
 544                 props = new HashSet<Property>(props);
 545             }
 546
 547             //in case of node switch-over to a different cluster controller,
 548             //let's retain edge props
 549             Set<Property> currentProps = this.edgesDB.get(e);
 550             if (currentProps != null){
 551                 props.addAll(currentProps);
 552             }
 553
 554             // Now make sure there is the creation timestamp for the
 555             // edge, if not there, stamp with the first update
 556             boolean found_create = false;
 557             for (Property prop : props) {
 558                 if (prop instanceof TimeStamp) {
 559                     TimeStamp t = (TimeStamp) prop;
 560                     if (t.getTimeStampName().equals("creation")) {
 561                         found_create = true;
 562                         break;
 563                     }
 564                 }
 565             }
 566
 567             if (!found_create) {
 568                 TimeStamp t = new TimeStamp(System.currentTimeMillis(), "creation");
 569                 props.add(t);
 570             }
 571
 572             // Now add this in the database eventually overriding
 573             // something that may have been already existing
 574             this.edgesDB.put(e, props);
 575
 576             // Now populate the DB of NodeConnectors
 577             // NOTE WELL: properties are empty sets, not really needed
 578             // for now.
 579             // The DB only contains ISL ports
 580             if (isISLink(e)) {
 581                 this.nodeConnectorsDB.put(e.getHeadNodeConnector(), new HashSet<Property>(1));
 582                 this.nodeConnectorsDB.put(e.getTailNodeConnector(), new HashSet<Property>(1));
 583             }
 584             log.trace("Edge {}  {}", e.toString(), type.name());
 585             break;
 586         case REMOVED:
 587             // Now remove the edge from edgesDB
 588             this.edgesDB.remove(e);
 589
 590             // Now lets update the NodeConnectors DB, the assumption
 591             // here is that two NodeConnector are exclusively
 592             // connected by 1 and only 1 edge, this is reasonable in
 593             // the same plug (virtual of phisical) we can assume two
 594             // cables won't be plugged. This could break only in case
 595             // of devices in the middle that acts as hubs, but it
 596             // should be safe to assume that won't happen.
 597             this.nodeConnectorsDB.remove(e.getHeadNodeConnector());
 598             this.nodeConnectorsDB.remove(e.getTailNodeConnector());
 599             log.trace("Edge {}  {}", e.toString(), type.name());
 600             break;
 601         case CHANGED:
 602             Set<Property> oldProps = this.edgesDB.get(e);
 603
 604             // When property changes lets make sure we can change it
 605             // all except the creation time stamp because that should
 606             // be changed only when the edge is destroyed and created
 607             // again
 608             TimeStamp timeStamp = null;
 609             for (Property prop : oldProps) {
 610                 if (prop instanceof TimeStamp) {
 611                     TimeStamp tsProp = (TimeStamp) prop;
 612                     if (tsProp.getTimeStampName().equals("creation")) {
 613                         timeStamp = tsProp;
 614                         break;
 615                     }
 616                 }
 617             }
 618
 619             // Now lets make sure new properties are non-null
 620             if (props == null) {
 621                 props = new HashSet<Property>();
 622             } else {
 623                 // Copy the set so noone is going to change the content
 624                 props = new HashSet<Property>(props);
 625             }
 626
 627             // Now lets remove the creation property if exist in the
 628             // new props
 629             for (Iterator<Property> i = props.iterator(); i.hasNext();) {
 630                 Property prop = i.next();
 631                 if (prop instanceof TimeStamp) {
 632                     TimeStamp t = (TimeStamp) prop;
 633                     if (t.getTimeStampName().equals("creation")) {
 634                         i.remove();
 635                         break;
 636                     }
 637                 }
 638             }
 639
 640             // Now lets add the creation timestamp in it
 641             if (timeStamp != null) {
 642                 props.add(timeStamp);
 643             }
 644
 645             // Finally update
 646             this.edgesDB.put(e, props);
 647             log.trace("Edge {}  {}", e.toString(), type.name());
 648             break;
 649         }
 650         return new TopoEdgeUpdate(e, props, type);
 651     }
 652
 653     @Override
 654     public void edgeUpdate(List<TopoEdgeUpdate> topoedgeupdateList) {
 655         List<TopoEdgeUpdate> teuList = new ArrayList<TopoEdgeUpdate>();
 656         for (int i = 0; i < topoedgeupdateList.size(); i++) {
 657             Edge e = topoedgeupdateList.get(i).getEdge();
 658             Set<Property> p = topoedgeupdateList.get(i).getProperty();
 659             UpdateType type = topoedgeupdateList.get(i).getUpdateType();
 660             TopoEdgeUpdate teu = edgeUpdate(e, type, p);
 661             if (teu != null) {
 662                 teuList.add(teu);
 663             }
 664         }
 665
 666         if (!teuList.isEmpty()) {
 667             // Now update the listeners
 668             for (ITopologyManagerAware s : this.topologyManagerAware) {
 669                 try {
 670                     s.edgeUpdate(teuList);
 671                 } catch (Exception exc) {
 672                     log.error("Exception on edge update:", exc);
 673                 }
 674             }
 675         }
 676     }
 677
 678     private Edge getReverseLinkTuple(TopologyUserLinkConfig link) {
 679         TopologyUserLinkConfig rLink = new TopologyUserLinkConfig(
 680                 link.getName(), link.getDstNodeConnector(), link.getSrcNodeConnector());
 681         return getLinkTuple(rLink);
 682     }
 683
 684
 685     private Edge getLinkTuple(TopologyUserLinkConfig link) {
 686         NodeConnector srcNodeConnector = NodeConnector.fromString(link.getSrcNodeConnector());
 687         NodeConnector dstNodeConnector = NodeConnector.fromString(link.getDstNodeConnector());
 688         try {
 689             return new Edge(srcNodeConnector, dstNodeConnector);
 690         } catch (Exception e) {
 691             return null;
 692         }
 693     }
 694
 695     @Override
 696     public ConcurrentMap<String, TopologyUserLinkConfig> getUserLinks() {
 697         return new ConcurrentHashMap<String, TopologyUserLinkConfig>(userLinksDB);
 698     }
 699
 700     @Override
 701     public Status addUserLink(TopologyUserLinkConfig userLink) {
 702         if (!userLink.isValid()) {
 703             return new Status(StatusCode.BADREQUEST,
 704                     "User link configuration invalid.");
 705         }
 706         userLink.setStatus(TopologyUserLinkConfig.STATUS.LINKDOWN);
 707
 708         //Check if this link already configured
 709         //NOTE: infinispan cache doesn't support Map.containsValue()
 710         // (which is linear time in most ConcurrentMap impl anyway)
 711         for (TopologyUserLinkConfig existingLink : userLinksDB.values()) {
 712             if (existingLink.equals(userLink)) {
 713                 return new Status(StatusCode.CONFLICT, "Link configuration exists");
 714             }
 715         }
 716         //attempt put, if mapping for this key already existed return conflict
 717         if (userLinksDB.putIfAbsent(userLink.getName(), userLink) != null) {
 718             return new Status(StatusCode.CONFLICT, "Link with name : " + userLink.getName()
 719                     + " already exists. Please use another name");
 720         }
 721
 722         Edge linkTuple = getLinkTuple(userLink);
 723         if (linkTuple != null) {
 724             if (!isProductionLink(linkTuple)) {
 725                 TopoEdgeUpdate teu = edgeUpdate(linkTuple, UpdateType.ADDED,
 726                                                 new HashSet<Property>());
 727                 if (teu == null) {
 728                     userLinksDB.remove(userLink.getName());
 729                     return new Status(StatusCode.NOTFOUND,
 730                            "Link configuration contains invalid node connector: "
 731                            + userLink);
 732                 }
 733             }
 734
 735             linkTuple = getReverseLinkTuple(userLink);
 736             if (linkTuple != null) {
 737                 userLink.setStatus(TopologyUserLinkConfig.STATUS.SUCCESS);
 738                 if (!isProductionLink(linkTuple)) {
 739                     edgeUpdate(linkTuple, UpdateType.ADDED, new HashSet<Property>());
 740                 }
 741             }
 742         }
 743         return new Status(StatusCode.SUCCESS);
 744     }
 745
 746     @Override
 747     public Status deleteUserLink(String linkName) {
 748         if (linkName == null) {
 749             return new Status(StatusCode.BADREQUEST, "User link name cannot be null.");
 750         }
 751
 752         TopologyUserLinkConfig link = userLinksDB.remove(linkName);
 753         Edge linkTuple;
 754         if ((link != null) && ((linkTuple = getLinkTuple(link)) != null)) {
 755             if (! isProductionLink(linkTuple)) {
 756                 edgeUpdate(linkTuple, UpdateType.REMOVED, null);
 757             }
 758
 759             linkTuple = getReverseLinkTuple(link);
 760             if (! isProductionLink(linkTuple)) {
 761                 edgeUpdate(linkTuple, UpdateType.REMOVED, null);
 762             }
 763         }
 764         return new Status(StatusCode.SUCCESS);
 765     }
 766
 767     private void registerWithOSGIConsole() {
 768         BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass())
 769                 .getBundleContext();
 770         bundleContext.registerService(CommandProvider.class.getName(), this,
 771                 null);
 772     }
 773
 774     @Override
 775     public String getHelp() {
 776         StringBuffer help = new StringBuffer();
 777         help.append("---Topology Manager---\n");
 778         help.append("\t addUserLink <name> <node connector string> <node connector string>\n");
 779         help.append("\t deleteUserLink <name>\n");
 780         help.append("\t printUserLink\n");
 781         help.append("\t printNodeEdges\n");
 782         return help.toString();
 783     }
 784
 785     public void _printUserLink(CommandInterpreter ci) {
 786         for (String name : this.userLinksDB.keySet()) {
 787             TopologyUserLinkConfig linkConfig = userLinksDB.get(name);
 788             ci.println("Name : " + name);
 789             ci.println(linkConfig);
 790             ci.println("Edge " + getLinkTuple(linkConfig));
 791             ci.println("Reverse Edge " + getReverseLinkTuple(linkConfig));
 792         }
 793     }
 794
 795     public void _addUserLink(CommandInterpreter ci) {
 796         String name = ci.nextArgument();
 797         if ((name == null)) {
 798             ci.println("Please enter a valid Name");
 799             return;
 800         }
 801
 802         String ncStr1 = ci.nextArgument();
 803         if (ncStr1 == null) {
 804             ci.println("Please enter two node connector strings");
 805             return;
 806         }
 807         String ncStr2 = ci.nextArgument();
 808         if (ncStr2 == null) {
 809             ci.println("Please enter second node connector string");
 810             return;
 811         }
 812
 813         NodeConnector nc1 = NodeConnector.fromString(ncStr1);
 814         if (nc1 == null) {
 815             ci.println("Invalid input node connector 1 string: " + ncStr1);
 816             return;
 817         }
 818         NodeConnector nc2 = NodeConnector.fromString(ncStr2);
 819         if (nc2 == null) {
 820             ci.println("Invalid input node connector 2 string: " + ncStr2);
 821             return;
 822         }
 823
 824         TopologyUserLinkConfig config = new TopologyUserLinkConfig(name, ncStr1, ncStr2);
 825         ci.println(this.addUserLink(config));
 826     }
 827
 828     public void _deleteUserLink(CommandInterpreter ci) {
 829         String name = ci.nextArgument();
 830         if ((name == null)) {
 831             ci.println("Please enter a valid Name");
 832             return;
 833         }
 834         this.deleteUserLink(name);
 835     }
 836
 837     public void _printNodeEdges(CommandInterpreter ci) {
 838         Map<Node, Set<Edge>> nodeEdges = getNodeEdges();
 839         if (nodeEdges == null) {
 840             return;
 841         }
 842         Set<Node> nodeSet = nodeEdges.keySet();
 843         if (nodeSet == null) {
 844             return;
 845         }
 846         ci.println("        Node                                         Edge");
 847         for (Node node : nodeSet) {
 848             Set<Edge> edgeSet = nodeEdges.get(node);
 849             if (edgeSet == null) {
 850                 continue;
 851             }
 852             for (Edge edge : edgeSet) {
 853                 ci.println(node + "             " + edge);
 854             }
 855         }
 856     }
 857
 858     @Override
 859     public Object readObject(ObjectInputStream ois)
 860             throws FileNotFoundException, IOException, ClassNotFoundException {
 861         return ois.readObject();
 862     }
 863
 864     @Override
 865     public Status saveConfiguration() {
 866         return saveConfig();
 867     }
 868
 869     @Override
 870     public void edgeOverUtilized(Edge edge) {
 871         log.warn("Link Utilization above normal: {}", edge);
 872     }
 873
 874     @Override
 875     public void edgeUtilBackToNormal(Edge edge) {
 876         log.warn("Link Utilization back to normal: {}", edge);
 877     }
 878
 879     private void edgeUpdateClusterWide(Edge e, UpdateType type, Set<Property> props, boolean isLocal) {
 880         TopoEdgeUpdate upd = new TopoEdgeUpdate(e, props, type);
 881         upd.setLocal(isLocal);
 882         notifyQ.add(upd);
 883     }
 884
 885     @Override
 886     public void entryCreated(final Object key, final String cacheName, final boolean originLocal) {
 887         if (cacheName.equals(TOPOEDGESDB)) {
 888             // This is the case of an Edge being added to the topology DB
 889             final Edge e = (Edge) key;
 890             log.trace("Edge {} CREATED isLocal:{}", e, originLocal);
 891             edgeUpdateClusterWide(e, UpdateType.ADDED, null, originLocal);
 892         }
 893     }
 894
 895     @Override
 896     public void entryUpdated(final Object key, final Object new_value, final String cacheName, final boolean originLocal) {
 897         if (cacheName.equals(TOPOEDGESDB)) {
 898             final Edge e = (Edge) key;
 899             log.trace("Edge {} CHANGED isLocal:{}", e, originLocal);
 900             final Set<Property> props = (Set<Property>) new_value;
 901             edgeUpdateClusterWide(e, UpdateType.CHANGED, props, originLocal);
 902         }
 903     }
 904
 905     @Override
 906     public void entryDeleted(final Object key, final String cacheName, final boolean originLocal) {
 907         if (cacheName.equals(TOPOEDGESDB)) {
 908             final Edge e = (Edge) key;
 909             log.trace("Edge {} DELETED isLocal:{}", e, originLocal);
 910             edgeUpdateClusterWide(e, UpdateType.REMOVED, null, originLocal);
 911         }
 912     }
 913
 914     class TopologyNotify implements Runnable {
 915         private final BlockingQueue<TopoEdgeUpdate> notifyQ;
 916         private TopoEdgeUpdate entry;
 917         private List<TopoEdgeUpdate> teuList = new ArrayList<TopoEdgeUpdate>();
 918         private boolean notifyListeners;
 919
 920         TopologyNotify(BlockingQueue<TopoEdgeUpdate> notifyQ) {
 921             this.notifyQ = notifyQ;
 922         }
 923
 924         @Override
 925         public void run() {
 926             while (true) {
 927                 try {
 928                     log.trace("New run of TopologyNotify");
 929                     notifyListeners = false;
 930                     // First we block waiting for an element to get in
 931                     entry = notifyQ.take();
 932                     // Then we drain the whole queue if elements are
 933                     // in it without getting into any blocking condition
 934                     for (; entry != null; entry = notifyQ.poll()) {
 935                         teuList.add(entry);
 936                         notifyListeners = true;
 937                     }
 938
 939                     // Notify listeners only if there were updates drained else
 940                     // give up
 941                     if (notifyListeners) {
 942                         log.trace("Notifier thread, notified a listener");
 943                         // Now update the listeners
 944                         for (ITopologyManagerClusterWideAware s : topologyManagerClusterWideAware) {
 945                             try {
 946                                 s.edgeUpdate(teuList);
 947                             } catch (Exception exc) {
 948                                 log.error("Exception on edge update:", exc);
 949                             }
 950                         }
 951                     }
 952                     teuList.clear();
 953
 954                     // Lets sleep for sometime to allow aggregation of event
 955                     Thread.sleep(100);
 956                 } catch (InterruptedException e1) {
 957                     if (shuttingDown) {
 958                         return;
 959                     }
 960                     log.warn("TopologyNotify interrupted {}", e1.getMessage());
 961                 } catch (Exception e2) {
 962                     log.error("", e2);
 963                 }
 964             }
 965         }
 966     }
 967 }