opendaylight/switchmanager/implementation/src/main/java/org/opendaylight/controller/switchmanager/internal/SwitchManager.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.switchmanager.internal;
  10
  11 import java.io.FileNotFoundException;
  12 import java.io.IOException;
  13 import java.io.ObjectInputStream;
  14 import java.net.InetAddress;
  15 import java.net.NetworkInterface;
  16 import java.net.SocketException;
  17 import java.util.ArrayList;
  18 import java.util.Collections;
  19 import java.util.Dictionary;
  20 import java.util.EnumSet;
  21 import java.util.Enumeration;
  22 import java.util.HashMap;
  23 import java.util.HashSet;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.Set;
  27 import java.util.concurrent.ConcurrentHashMap;
  28 import java.util.concurrent.ConcurrentMap;
  29 import java.util.concurrent.CopyOnWriteArrayList;
  30
  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.IClusterContainerServices;
  37 import org.opendaylight.controller.clustering.services.IClusterServices;
  38 import org.opendaylight.controller.configuration.ConfigurationObject;
  39 import org.opendaylight.controller.configuration.IConfigurationContainerAware;
  40 import org.opendaylight.controller.configuration.IConfigurationContainerService;
  41 import org.opendaylight.controller.sal.core.Bandwidth;
  42 import org.opendaylight.controller.sal.core.Config;
  43 import org.opendaylight.controller.sal.core.ConstructionException;
  44 import org.opendaylight.controller.sal.core.Description;
  45 import org.opendaylight.controller.sal.core.ForwardingMode;
  46 import org.opendaylight.controller.sal.core.MacAddress;
  47 import org.opendaylight.controller.sal.core.Name;
  48 import org.opendaylight.controller.sal.core.Node;
  49 import org.opendaylight.controller.sal.core.NodeConnector;
  50 import org.opendaylight.controller.sal.core.NodeConnector.NodeConnectorIDType;
  51 import org.opendaylight.controller.sal.core.Property;
  52 import org.opendaylight.controller.sal.core.State;
  53 import org.opendaylight.controller.sal.core.Tier;
  54 import org.opendaylight.controller.sal.core.UpdateType;
  55 import org.opendaylight.controller.sal.inventory.IInventoryService;
  56 import org.opendaylight.controller.sal.inventory.IListenInventoryUpdates;
  57 import org.opendaylight.controller.sal.reader.NodeDescription;
  58 import org.opendaylight.controller.sal.utils.GlobalConstants;
  59 import org.opendaylight.controller.sal.utils.HexEncode;
  60 import org.opendaylight.controller.sal.utils.IObjectReader;
  61 import org.opendaylight.controller.sal.utils.Status;
  62 import org.opendaylight.controller.sal.utils.StatusCode;
  63 import org.opendaylight.controller.statisticsmanager.IStatisticsManager;
  64 import org.opendaylight.controller.switchmanager.IInventoryListener;
  65 import org.opendaylight.controller.switchmanager.ISpanAware;
  66 import org.opendaylight.controller.switchmanager.ISwitchManager;
  67 import org.opendaylight.controller.switchmanager.ISwitchManagerAware;
  68 import org.opendaylight.controller.switchmanager.SpanConfig;
  69 import org.opendaylight.controller.switchmanager.Subnet;
  70 import org.opendaylight.controller.switchmanager.SubnetConfig;
  71 import org.opendaylight.controller.switchmanager.Switch;
  72 import org.opendaylight.controller.switchmanager.SwitchConfig;
  73 import org.osgi.framework.BundleContext;
  74 import org.osgi.framework.FrameworkUtil;
  75 import org.slf4j.Logger;
  76 import org.slf4j.LoggerFactory;
  77
  78 /**
  79  * The class describes SwitchManager which is the central repository of all the
  80  * inventory data including nodes, node connectors, properties attached, Layer3
  81  * configurations, Span configurations, node configurations, network device
  82  * representations viewed by Controller Web applications. One SwitchManager
  83  * instance per container of the network. All the node/nodeConnector properties
  84  * are maintained in the default container only.
  85  */
  86 public class SwitchManager implements ISwitchManager, IConfigurationContainerAware,
  87                                       IObjectReader, IListenInventoryUpdates, CommandProvider {
  88     private static Logger log = LoggerFactory.getLogger(SwitchManager.class);
  89     private static final String SUBNETS_FILE_NAME = "subnets.conf";
  90     private static final String SPAN_FILE_NAME = "spanPorts.conf";
  91     private static final String SWITCH_CONFIG_FILE_NAME = "switchConfig.conf";
  92     private final List<NodeConnector> spanNodeConnectors = new CopyOnWriteArrayList<NodeConnector>();
  93     // Collection of Subnets keyed by the InetAddress
  94     private ConcurrentMap<InetAddress, Subnet> subnets;
  95     private ConcurrentMap<String, SubnetConfig> subnetsConfigList;
  96     private ConcurrentMap<SpanConfig, SpanConfig> spanConfigList;
  97     // manually configured parameters for the node such as name, tier, mode
  98     private ConcurrentMap<String, SwitchConfig> nodeConfigList;
  99     private ConcurrentMap<Node, Map<String, Property>> nodeProps;
 100     private ConcurrentMap<NodeConnector, Map<String, Property>> nodeConnectorProps;
 101     private ConcurrentMap<Node, Map<String, NodeConnector>> nodeConnectorNames;
 102     private ConcurrentMap<String, Property> controllerProps;
 103     private IInventoryService inventoryService;
 104     private IStatisticsManager statisticsManager;
 105     private IConfigurationContainerService configurationService;
 106     private final Set<ISwitchManagerAware> switchManagerAware = Collections
 107             .synchronizedSet(new HashSet<ISwitchManagerAware>());
 108     private final Set<IInventoryListener> inventoryListeners = Collections
 109             .synchronizedSet(new HashSet<IInventoryListener>());
 110     private final Set<ISpanAware> spanAware = Collections.synchronizedSet(new HashSet<ISpanAware>());
 111     private IClusterContainerServices clusterContainerService = null;
 112     private String containerName = null;
 113     private boolean isDefaultContainer = true;
 114     private static final int REPLACE_RETRY = 1;
 115
 116     /* Information about the default subnet. If there have been no configured subnets, i.e.,
 117      * subnets.size() == 0 or subnetsConfigList.size() == 0, then this subnet will be the
 118      * only subnet returned. As soon as a user-configured subnet is created this one will
 119      * vanish.
 120      */
 121     protected static final SubnetConfig DEFAULT_SUBNETCONFIG;
 122     protected static final Subnet DEFAULT_SUBNET;
 123     protected static final String DEFAULT_SUBNET_NAME = "default (cannot be modifed)";
 124     static{
 125         DEFAULT_SUBNETCONFIG = new SubnetConfig(DEFAULT_SUBNET_NAME, "0.0.0.0/0", new ArrayList<String>());
 126         DEFAULT_SUBNET = new Subnet(DEFAULT_SUBNETCONFIG);
 127     }
 128
 129     public void notifySubnetChange(Subnet sub, boolean add) {
 130         synchronized (switchManagerAware) {
 131             for (Object subAware : switchManagerAware) {
 132                 try {
 133                     ((ISwitchManagerAware) subAware).subnetNotify(sub, add);
 134                 } catch (Exception e) {
 135                     log.error("Failed to notify Subnet change {}",
 136                             e.getMessage());
 137                 }
 138             }
 139         }
 140     }
 141
 142     public void notifySpanPortChange(Node node, List<NodeConnector> ports, boolean add) {
 143         synchronized (spanAware) {
 144             for (Object sa : spanAware) {
 145                 try {
 146                     ((ISpanAware) sa).spanUpdate(node, ports, add);
 147                 } catch (Exception e) {
 148                     log.error("Failed to notify Span Interface change {}",
 149                             e.getMessage());
 150                 }
 151             }
 152         }
 153     }
 154
 155     private void notifyModeChange(Node node, boolean proactive) {
 156         synchronized (switchManagerAware) {
 157             for (ISwitchManagerAware service : switchManagerAware) {
 158                 try {
 159                     service.modeChangeNotify(node, proactive);
 160                 } catch (Exception e) {
 161                     log.error("Failed to notify Subnet change {}",
 162                             e.getMessage());
 163                 }
 164             }
 165         }
 166     }
 167
 168     public void startUp() {
 169         // Instantiate cluster synced variables
 170         allocateCaches();
 171         retrieveCaches();
 172
 173         // Add controller MAC, if first node in the cluster
 174         if (!controllerProps.containsKey(MacAddress.name)) {
 175             byte controllerMac[] = getHardwareMAC();
 176             if (controllerMac != null) {
 177                 Property existing = controllerProps.putIfAbsent(MacAddress.name, new MacAddress(controllerMac));
 178                 if (existing == null && log.isTraceEnabled()) {
 179                     log.trace("Container {}: Setting controller MAC address in the cluster: {}", getContainerName(),
 180                             HexEncode.bytesToHexStringFormat(controllerMac));
 181                 }
 182             }
 183         }
 184     }
 185
 186     public void shutDown() {
 187     }
 188
 189     private void allocateCaches() {
 190         if (this.clusterContainerService == null) {
 191             this.nonClusterObjectCreate();
 192             log.warn("un-initialized clusterContainerService, can't create cache");
 193             return;
 194         }
 195
 196         try {
 197             clusterContainerService.createCache(
 198                     "switchmanager.subnetsConfigList",
 199                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 200             clusterContainerService.createCache("switchmanager.spanConfigList",
 201                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 202             clusterContainerService.createCache("switchmanager.nodeConfigList",
 203                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 204             clusterContainerService.createCache("switchmanager.subnets",
 205                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 206             clusterContainerService.createCache("switchmanager.nodeProps",
 207                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 208             clusterContainerService.createCache(
 209                     "switchmanager.nodeConnectorProps",
 210                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 211             clusterContainerService.createCache(
 212                     "switchmanager.nodeConnectorNames",
 213                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 214             clusterContainerService.createCache(
 215                     "switchmanager.controllerProps",
 216                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
 217         } catch (CacheConfigException cce) {
 218             log.error("\nCache configuration invalid - check cache mode");
 219         } catch (CacheExistException ce) {
 220             log.error("\nCache already exits - destroy and recreate if needed");
 221         }
 222     }
 223
 224     @SuppressWarnings({ "unchecked" })
 225     private void retrieveCaches() {
 226         if (this.clusterContainerService == null) {
 227             log.warn("un-initialized clusterContainerService, can't create cache");
 228             return;
 229         }
 230
 231         subnetsConfigList = (ConcurrentMap<String, SubnetConfig>) clusterContainerService
 232                 .getCache("switchmanager.subnetsConfigList");
 233         if (subnetsConfigList == null) {
 234             log.error("\nFailed to get cache for subnetsConfigList");
 235         }
 236
 237         spanConfigList = (ConcurrentMap<SpanConfig, SpanConfig>) clusterContainerService
 238                 .getCache("switchmanager.spanConfigList");
 239         if (spanConfigList == null) {
 240             log.error("\nFailed to get cache for spanConfigList");
 241         }
 242
 243         nodeConfigList = (ConcurrentMap<String, SwitchConfig>) clusterContainerService
 244                 .getCache("switchmanager.nodeConfigList");
 245         if (nodeConfigList == null) {
 246             log.error("\nFailed to get cache for nodeConfigList");
 247         }
 248
 249         subnets = (ConcurrentMap<InetAddress, Subnet>) clusterContainerService
 250                 .getCache("switchmanager.subnets");
 251         if (subnets == null) {
 252             log.error("\nFailed to get cache for subnets");
 253         }
 254
 255         nodeProps = (ConcurrentMap<Node, Map<String, Property>>) clusterContainerService
 256                 .getCache("switchmanager.nodeProps");
 257         if (nodeProps == null) {
 258             log.error("\nFailed to get cache for nodeProps");
 259         }
 260
 261         nodeConnectorProps = (ConcurrentMap<NodeConnector, Map<String, Property>>) clusterContainerService
 262                 .getCache("switchmanager.nodeConnectorProps");
 263         if (nodeConnectorProps == null) {
 264             log.error("\nFailed to get cache for nodeConnectorProps");
 265         }
 266
 267         nodeConnectorNames = (ConcurrentMap<Node, Map<String, NodeConnector>>) clusterContainerService
 268                 .getCache("switchmanager.nodeConnectorNames");
 269         if (nodeConnectorNames == null) {
 270             log.error("\nFailed to get cache for nodeConnectorNames");
 271         }
 272
 273         controllerProps = (ConcurrentMap<String, Property>) clusterContainerService
 274                 .getCache("switchmanager.controllerProps");
 275         if (controllerProps == null) {
 276             log.error("\nFailed to get cache for controllerProps");
 277         }
 278     }
 279
 280     private void nonClusterObjectCreate() {
 281         subnetsConfigList = new ConcurrentHashMap<String, SubnetConfig>();
 282         spanConfigList = new ConcurrentHashMap<SpanConfig, SpanConfig>();
 283         nodeConfigList = new ConcurrentHashMap<String, SwitchConfig>();
 284         subnets = new ConcurrentHashMap<InetAddress, Subnet>();
 285         nodeProps = new ConcurrentHashMap<Node, Map<String, Property>>();
 286         nodeConnectorProps = new ConcurrentHashMap<NodeConnector, Map<String, Property>>();
 287         nodeConnectorNames = new ConcurrentHashMap<Node, Map<String, NodeConnector>>();
 288         controllerProps = new ConcurrentHashMap<String, Property>();
 289     }
 290
 291     @Override
 292     public List<SubnetConfig> getSubnetsConfigList() {
 293         // if there are no subnets, return the default subnet
 294         if(subnetsConfigList.size() == 0){
 295             return Collections.singletonList(DEFAULT_SUBNETCONFIG);
 296         }else{
 297             return new ArrayList<SubnetConfig>(subnetsConfigList.values());
 298         }
 299     }
 300
 301     @Override
 302     public SubnetConfig getSubnetConfig(String subnet) {
 303         // if there are no subnets, return the default subnet
 304         if(subnetsConfigList.isEmpty() && subnet.equalsIgnoreCase(DEFAULT_SUBNET_NAME)){
 305             return DEFAULT_SUBNETCONFIG;
 306         }else{
 307             return subnetsConfigList.get(subnet);
 308         }
 309     }
 310
 311     private List<SpanConfig> getSpanConfigList(Node node) {
 312         List<SpanConfig> confList = new ArrayList<SpanConfig>();
 313         String nodeId = node.toString();
 314         for (SpanConfig conf : spanConfigList.values()) {
 315             if (conf.matchNode(nodeId)) {
 316                 confList.add(conf);
 317             }
 318         }
 319         return confList;
 320     }
 321
 322     public List<SwitchConfig> getNodeConfigList() {
 323         return new ArrayList<SwitchConfig>(nodeConfigList.values());
 324     }
 325
 326     @Override
 327     public SwitchConfig getSwitchConfig(String switchId) {
 328         return nodeConfigList.get(switchId);
 329     }
 330
 331     public Switch getSwitchByNode(Node node) {
 332         Switch sw = new Switch(node);
 333         sw.setNode(node);
 334         MacAddress mac = (MacAddress) this.getNodeProp(node,
 335                 MacAddress.name);
 336         if (mac != null) {
 337             sw.setDataLayerAddress(mac.getMacAddress());
 338         }
 339         Set<NodeConnector> ncSet = getPhysicalNodeConnectors(node);
 340         sw.setNodeConnectors(ncSet);
 341
 342         List<NodeConnector> ncList = new ArrayList<NodeConnector>();
 343         for (NodeConnector nodeConnector : ncSet) {
 344             if (spanNodeConnectors.contains(nodeConnector)) {
 345                 ncList.add(nodeConnector);
 346             }
 347         }
 348         sw.addSpanPorts(ncList);
 349
 350         return sw;
 351     }
 352
 353     @Override
 354     public List<Switch> getNetworkDevices() {
 355         List<Switch> swList = new ArrayList<Switch>();
 356         for (Node node : getNodes()) {
 357             swList.add(getSwitchByNode(node));
 358         }
 359         return swList;
 360     }
 361
 362     private Status updateConfig(SubnetConfig conf, boolean add) {
 363         if (add) {
 364             if(subnetsConfigList.putIfAbsent(conf.getName(), conf) != null) {
 365                 String msg = "Cluster conflict: Subnet with name " + conf.getName() + "already exists.";
 366                 return new Status(StatusCode.CONFLICT, msg);
 367             }
 368         } else {
 369             subnetsConfigList.remove(conf.getName());
 370         }
 371         return new Status(StatusCode.SUCCESS);
 372     }
 373
 374     private Status updateDatabase(SubnetConfig conf, boolean add) {
 375         if (add) {
 376             Subnet subnetCurr = subnets.get(conf.getIPAddress());
 377             Subnet subnet;
 378             if (subnetCurr == null) {
 379                 subnet = new Subnet(conf);
 380             } else {
 381                 subnet = subnetCurr.clone();
 382             }
 383             // In case of API3 call we may receive the ports along with the
 384             // subnet creation
 385             if (!conf.isGlobal()) {
 386                 subnet.addNodeConnectors(conf.getNodeConnectors());
 387             }
 388             boolean putNewSubnet = false;
 389             if(subnetCurr == null) {
 390                 if(subnets.putIfAbsent(conf.getIPAddress(), subnet) == null) {
 391                     putNewSubnet = true;
 392                 }
 393             } else {
 394                 putNewSubnet = subnets.replace(conf.getIPAddress(), subnetCurr, subnet);
 395             }
 396             if(!putNewSubnet) {
 397                 String msg = "Cluster conflict: Conflict while adding the subnet " + conf.getIPAddress();
 398                 return new Status(StatusCode.CONFLICT, msg);
 399             }
 400
 401         // Subnet removal case
 402         } else {
 403             subnets.remove(conf.getIPAddress());
 404         }
 405         return new Status(StatusCode.SUCCESS);
 406     }
 407
 408     private Status semanticCheck(SubnetConfig conf) {
 409         Set<InetAddress> IPs = subnets.keySet();
 410         if (IPs == null) {
 411             return new Status(StatusCode.SUCCESS);
 412         }
 413         Subnet newSubnet = new Subnet(conf);
 414         for (InetAddress i : IPs) {
 415             Subnet existingSubnet = subnets.get(i);
 416             if ((existingSubnet != null) && !existingSubnet.isMutualExclusive(newSubnet)) {
 417                 return new Status(StatusCode.CONFLICT, "This subnet conflicts with an existing one.");
 418             }
 419         }
 420         return new Status(StatusCode.SUCCESS);
 421     }
 422
 423     private Status addRemoveSubnet(SubnetConfig conf, boolean isAdding) {
 424         // Valid configuration check
 425         Status status = conf.validate();
 426         if (!status.isSuccess()) {
 427             log.warn(status.getDescription());
 428             return status;
 429         }
 430
 431         if (isAdding) {
 432             // Presence check
 433             if (subnetsConfigList.containsKey(conf.getName())) {
 434                 return new Status(StatusCode.CONFLICT,
 435                         "Subnet with the specified name already exists.");
 436             }
 437             // Semantic check
 438             status = semanticCheck(conf);
 439             if (!status.isSuccess()) {
 440                 return status;
 441             }
 442         } else {
 443             if (conf.getName().equalsIgnoreCase(DEFAULT_SUBNET_NAME)) {
 444                 return new Status(StatusCode.NOTALLOWED, "The specified subnet gateway cannot be removed");
 445             }
 446         }
 447
 448         // Update Database
 449         status = updateDatabase(conf, isAdding);
 450
 451         if (status.isSuccess()) {
 452             // Update Configuration
 453             status = updateConfig(conf, isAdding);
 454             if(!status.isSuccess()) {
 455                 updateDatabase(conf, (!isAdding));
 456             } else {
 457                 // update the listeners
 458                 Subnet subnetCurr = subnets.get(conf.getIPAddress());
 459                 Subnet subnet;
 460                 if (subnetCurr == null) {
 461                     subnet = new Subnet(conf);
 462                 } else {
 463                     subnet = subnetCurr.clone();
 464                 }
 465                 notifySubnetChange(subnet, isAdding);
 466             }
 467         }
 468
 469         return status;
 470     }
 471
 472     /**
 473      * Adds Subnet configured in GUI or API3
 474      */
 475     @Override
 476     public Status addSubnet(SubnetConfig conf) {
 477         return this.addRemoveSubnet(conf, true);
 478     }
 479
 480     @Override
 481     public Status removeSubnet(SubnetConfig conf) {
 482         return this.addRemoveSubnet(conf, false);
 483     }
 484
 485     @Override
 486     public Status removeSubnet(String name) {
 487         if (name.equalsIgnoreCase(DEFAULT_SUBNET_NAME)) {
 488             return new Status(StatusCode.NOTALLOWED, "The specified subnet gateway cannot be removed");
 489         }
 490         SubnetConfig conf = subnetsConfigList.get(name);
 491         if (conf == null) {
 492             return new Status(StatusCode.SUCCESS, "Subnet not present");
 493         }
 494         return this.addRemoveSubnet(conf, false);
 495     }
 496
 497     @Override
 498     public Status modifySubnet(SubnetConfig conf) {
 499         // Sanity check
 500         if (conf == null) {
 501             return new Status(StatusCode.BADREQUEST, "Invalid Subnet configuration: null");
 502         }
 503
 504         // Valid configuration check
 505         Status status = conf.validate();
 506         if (!status.isSuccess()) {
 507             log.warn(status.getDescription());
 508             return status;
 509         }
 510
 511         // If a subnet configuration with this name does not exist, consider this is a creation
 512         SubnetConfig target = subnetsConfigList.get(conf.getName());
 513         if (target == null) {
 514             return this.addSubnet(conf);
 515         }
 516
 517         // No change
 518         if (target.equals(conf)) {
 519             return new Status(StatusCode.SUCCESS);
 520         }
 521
 522         // Check not allowed modifications
 523         if (!target.getSubnet().equals(conf.getSubnet())) {
 524             return new Status(StatusCode.BADREQUEST, "IP address change is not allowed");
 525         }
 526
 527         // Derive the set of node connectors that are being removed
 528         Set<NodeConnector> toRemove = target.getNodeConnectors();
 529         toRemove.removeAll(conf.getNodeConnectors());
 530         List<String> nodeConnectorStrings = null;
 531         if (!toRemove.isEmpty()) {
 532             nodeConnectorStrings = new ArrayList<String>();
 533             for (NodeConnector nc : toRemove) {
 534                 nodeConnectorStrings.add(nc.toString());
 535             }
 536             status = this.removePortsFromSubnet(conf.getName(), nodeConnectorStrings);
 537             if (!status.isSuccess()) {
 538                 return status;
 539             }
 540         }
 541
 542         // Derive the set of node connectors that are being added
 543         Set<NodeConnector> toAdd = conf.getNodeConnectors();
 544         toAdd.removeAll(target.getNodeConnectors());
 545         if (!toAdd.isEmpty()) {
 546             List<String> nodeConnectorStringRemoved = nodeConnectorStrings;
 547             nodeConnectorStrings = new ArrayList<String>();
 548             for (NodeConnector nc : toAdd) {
 549                 nodeConnectorStrings.add(nc.toString());
 550             }
 551             status = this.addPortsToSubnet(conf.getName(), nodeConnectorStrings);
 552             if (!status.isSuccess()) {
 553                 // If any port was removed, add it back as a best recovery effort
 554                 if (!toRemove.isEmpty()) {
 555                     this.addPortsToSubnet(conf.getName(), nodeConnectorStringRemoved);
 556                 }
 557                 return status;
 558             }
 559         }
 560
 561         // Update Configuration
 562         subnetsConfigList.put(conf.getName(), conf);
 563
 564         return new Status(StatusCode.SUCCESS);
 565     }
 566
 567     @Override
 568     public Status addPortsToSubnet(String name, List<String> switchPorts) {
 569         if (name == null) {
 570             return new Status(StatusCode.BADREQUEST, "Null subnet name");
 571         }
 572         SubnetConfig confCurr = subnetsConfigList.get(name);
 573         if (confCurr == null) {
 574             return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
 575         }
 576
 577         if (switchPorts == null || switchPorts.isEmpty()) {
 578             return new Status(StatusCode.BADREQUEST, "Null or empty port set");
 579         }
 580
 581         Subnet subCurr = subnets.get(confCurr.getIPAddress());
 582         if (subCurr == null) {
 583             log.debug("Cluster conflict: Subnet entry {} is not present in the subnets cache.", confCurr.getIPAddress());
 584             return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
 585         }
 586
 587         // Update Database
 588         Subnet sub = subCurr.clone();
 589         Set<NodeConnector> sp = NodeConnector.fromString(switchPorts);
 590         sub.addNodeConnectors(sp);
 591         boolean subnetsReplaced = subnets.replace(confCurr.getIPAddress(), subCurr, sub);
 592         if (!subnetsReplaced) {
 593             String msg = "Cluster conflict: Conflict while adding ports to the subnet " + name;
 594             return new Status(StatusCode.CONFLICT, msg);
 595         }
 596
 597         // Update Configuration
 598         SubnetConfig conf = confCurr.clone();
 599         conf.addNodeConnectors(switchPorts);
 600         boolean configReplaced = subnetsConfigList.replace(name, confCurr, conf);
 601         if (!configReplaced) {
 602             // TODO: recovery using Transactionality
 603             String msg = "Cluster conflict: Conflict while adding ports to the subnet " + name;
 604             return new Status(StatusCode.CONFLICT, msg);
 605         }
 606
 607         return new Status(StatusCode.SUCCESS);
 608     }
 609
 610     @Override
 611     public Status removePortsFromSubnet(String name, List<String> switchPorts) {
 612         if (name == null) {
 613             return new Status(StatusCode.BADREQUEST, "Null subnet name");
 614         }
 615         SubnetConfig confCurr = subnetsConfigList.get(name);
 616         if (confCurr == null) {
 617             return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
 618         }
 619
 620         if (switchPorts == null || switchPorts.isEmpty()) {
 621             return new Status(StatusCode.BADREQUEST, "Null or empty port set");
 622         }
 623
 624         Subnet subCurr = subnets.get(confCurr.getIPAddress());
 625         if (subCurr == null) {
 626             log.debug("Cluster conflict: Subnet entry {} is not present in the subnets cache.", confCurr.getIPAddress());
 627             return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
 628         }
 629
 630         // Validation check
 631         Status status = SubnetConfig.validatePorts(switchPorts);
 632         if (!status.isSuccess()) {
 633             return status;
 634         }
 635         // Update Database
 636         Subnet sub = subCurr.clone();
 637         Set<NodeConnector> sp = NodeConnector.fromString(switchPorts);
 638         sub.deleteNodeConnectors(sp);
 639         boolean subnetsReplace = subnets.replace(confCurr.getIPAddress(), subCurr, sub);
 640         if (!subnetsReplace) {
 641             String msg = "Cluster conflict: Conflict while removing ports from the subnet " + name;
 642             return new Status(StatusCode.CONFLICT, msg);
 643         }
 644
 645         // Update Configuration
 646         SubnetConfig conf = confCurr.clone();
 647         conf.removeNodeConnectors(switchPorts);
 648         boolean result = subnetsConfigList.replace(name, confCurr, conf);
 649         if (!result) {
 650             // TODO: recovery using Transactionality
 651             String msg = "Cluster conflict: Conflict while removing ports from " + conf;
 652             return new Status(StatusCode.CONFLICT, msg);
 653         }
 654
 655         return new Status(StatusCode.SUCCESS);
 656     }
 657
 658     public String getContainerName() {
 659         if (containerName == null) {
 660             return GlobalConstants.DEFAULT.toString();
 661         }
 662         return containerName;
 663     }
 664
 665     @Override
 666     public Subnet getSubnetByNetworkAddress(InetAddress networkAddress) {
 667         // if there are no subnets, return the default subnet
 668         if (subnets.size() == 0) {
 669             return DEFAULT_SUBNET;
 670         }
 671
 672         for(Map.Entry<InetAddress,Subnet> subnetEntry : subnets.entrySet()) {
 673             if(subnetEntry.getValue().isSubnetOf(networkAddress)) {
 674                 return subnetEntry.getValue();
 675             }
 676         }
 677         return null;
 678     }
 679
 680     @Override
 681     public Object readObject(ObjectInputStream ois)
 682             throws FileNotFoundException, IOException, ClassNotFoundException {
 683         // Perform the class deserialization locally, from inside the package
 684         // where the class is defined
 685         return ois.readObject();
 686     }
 687
 688     private void loadSubnetConfiguration() {
 689         for (ConfigurationObject conf : configurationService.retrieveConfiguration(this, SUBNETS_FILE_NAME)) {
 690             addSubnet((SubnetConfig) conf);
 691         }
 692     }
 693
 694     private void loadSpanConfiguration() {
 695         for (ConfigurationObject conf : configurationService.retrieveConfiguration(this, SPAN_FILE_NAME)) {
 696             addSpanConfig((SpanConfig) conf);
 697         }
 698     }
 699
 700     private void loadSwitchConfiguration() {
 701         for (ConfigurationObject conf : configurationService.retrieveConfiguration(this, SWITCH_CONFIG_FILE_NAME)) {
 702             updateNodeConfig((SwitchConfig) conf);
 703         }
 704     }
 705
 706     @SuppressWarnings("deprecation")
 707     @Override
 708     public void updateSwitchConfig(SwitchConfig cfgObject) {
 709         // update default container only
 710         if (!isDefaultContainer) {
 711             return;
 712         }
 713
 714         SwitchConfig sc = nodeConfigList.get(cfgObject.getNodeId());
 715         if (sc == null) {
 716             if (nodeConfigList.putIfAbsent(cfgObject.getNodeId(), cfgObject) != null) {
 717                 return;
 718             }
 719         } else {
 720             if (!nodeConfigList.replace(cfgObject.getNodeId(), sc, cfgObject)) {
 721                 return;
 722             }
 723         }
 724
 725         boolean modeChange = false;
 726
 727         if ((sc == null) || !cfgObject.getMode().equals(sc.getMode())) {
 728             modeChange = true;
 729         }
 730
 731         String nodeId = cfgObject.getNodeId();
 732         Node node = Node.fromString(nodeId);
 733         Map<String, Property> propMapCurr = nodeProps.get(node);
 734         if (propMapCurr == null) {
 735             return;
 736         }
 737         Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
 738         Property desc = new Description(cfgObject.getNodeDescription());
 739         propMap.put(desc.getName(), desc);
 740         Property tier = new Tier(Integer.parseInt(cfgObject.getTier()));
 741         propMap.put(tier.getName(), tier);
 742
 743         if (!nodeProps.replace(node, propMapCurr, propMap)) {
 744             // TODO rollback using Transactionality
 745             return;
 746         }
 747
 748         log.trace("Set Node {}'s Mode to {}", nodeId, cfgObject.getMode());
 749
 750         if (modeChange) {
 751             notifyModeChange(node, cfgObject.isProactive());
 752         }
 753     }
 754
 755     @Override
 756     public Status updateNodeConfig(SwitchConfig switchConfig) {
 757         Status status = switchConfig.validate();
 758         if (!status.isSuccess()) {
 759             return status;
 760         }
 761
 762         Map<String, Property> updateProperties = switchConfig.getNodeProperties();
 763         ForwardingMode mode = (ForwardingMode) updateProperties.get(ForwardingMode.name);
 764         if (mode != null) {
 765             if (isDefaultContainer) {
 766                 if (!mode.isValid()) {
 767                     return new Status(StatusCode.BADREQUEST, "Invalid Forwarding Mode Value");
 768                 }
 769             } else {
 770                 return new Status(StatusCode.NOTACCEPTABLE,
 771                         "Forwarding Mode modification is allowed only in default container");
 772             }
 773         }
 774
 775         Description description = (Description) switchConfig.getProperty(Description.propertyName);
 776         String nodeId = switchConfig.getNodeId();
 777         Node node = Node.fromString(nodeId);
 778         NodeDescription nodeDesc = (this.statisticsManager == null) ? null : this.statisticsManager
 779                 .getNodeDescription(node);
 780         String advertisedDesc = (nodeDesc == null) ? "" : nodeDesc.getDescription();
 781         if (description != null && description.getValue() != null) {
 782             if (description.getValue().isEmpty() || description.getValue().equals(advertisedDesc)) {
 783                 updateProperties.remove(Description.propertyName);
 784                 switchConfig = new SwitchConfig(nodeId, updateProperties);
 785             } else {
 786                 // check if description is configured or was published by any other node
 787                 for (Map.Entry<Node, Map<String, Property>> entry : nodeProps.entrySet()) {
 788                     Node n = entry.getKey();
 789                     Description desc = (Description) getNodeProp(n, Description.propertyName);
 790                     NodeDescription nDesc = (this.statisticsManager == null) ? null : this.statisticsManager
 791                             .getNodeDescription(n);
 792                     String advDesc = (nDesc == null) ? "" : nDesc.getDescription();
 793                     if ((description.equals(desc) || description.getValue().equals(advDesc)) && !node.equals(n)) {
 794                         return new Status(StatusCode.CONFLICT, "Node name already in use");
 795                     }
 796                 }
 797             }
 798         }
 799
 800         boolean modeChange = false;
 801         SwitchConfig sc = nodeConfigList.get(nodeId);
 802         Map<String, Property> prevNodeProperties = new HashMap<String, Property>();
 803         if (sc == null) {
 804             if ((mode != null) && mode.isProactive()) {
 805                 modeChange = true;
 806             }
 807             if (!updateProperties.isEmpty()) {
 808                 if (nodeConfigList.putIfAbsent(nodeId, switchConfig) != null) {
 809                     return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration");
 810                 }
 811             }
 812         } else {
 813             prevNodeProperties = new HashMap<String, Property>(sc.getNodeProperties());
 814             ForwardingMode prevMode = (ForwardingMode) sc.getProperty(ForwardingMode.name);
 815             if (mode == null) {
 816                 if ((prevMode != null) && (prevMode.isProactive())) {
 817                     modeChange = true;
 818                 }
 819             } else {
 820                 if (((prevMode != null) && (prevMode.getValue() != mode.getValue()))
 821                         || (prevMode == null && mode.isProactive())) {
 822                     modeChange = true;
 823                 }
 824             }
 825             if (updateProperties.isEmpty()) {
 826                 nodeConfigList.remove(nodeId);
 827             } else {
 828                 if (!nodeConfigList.replace(nodeId, sc, switchConfig)) {
 829                     return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration");
 830                 }
 831             }
 832         }
 833         Map<String, Property> propMapCurr = nodeProps.get(node);
 834         if (propMapCurr == null) {
 835             return new Status(StatusCode.SUCCESS);
 836         }
 837         Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
 838         for (Map.Entry<String, Property> entry : prevNodeProperties.entrySet()) {
 839             String prop = entry.getKey();
 840             if (!updateProperties.containsKey(prop)) {
 841                 if (prop.equals(Description.propertyName)) {
 842                     if (advertisedDesc != null) {
 843                         if (!advertisedDesc.isEmpty()) {
 844                             Property desc = new Description(advertisedDesc);
 845                             propMap.put(Description.propertyName, desc);
 846                         }
 847                     }
 848                     else {
 849                         propMap.remove(prop);
 850                     }
 851                     continue;
 852                 } else if (prop.equals(ForwardingMode.name)) {
 853                     Property defaultMode = new ForwardingMode(ForwardingMode.REACTIVE_FORWARDING);
 854                     propMap.put(ForwardingMode.name, defaultMode);
 855                     continue;
 856                 }
 857                 propMap.remove(prop);
 858             }
 859         }
 860         propMap.putAll(updateProperties);
 861         if (!nodeProps.replace(node, propMapCurr, propMap)) {
 862             // TODO rollback using Transactionality
 863             return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration");
 864         }
 865         if (modeChange) {
 866             notifyModeChange(node, (mode == null) ? false : mode.isProactive());
 867         }
 868         return new Status(StatusCode.SUCCESS);
 869     }
 870
 871     @Override
 872     public Status removeNodeConfig(String nodeId) {
 873         if ((nodeId == null) || (nodeId.isEmpty())) {
 874             return new Status(StatusCode.BADREQUEST, "nodeId cannot be empty.");
 875         }
 876         Map<String, Property> nodeProperties = getSwitchConfig(nodeId).getNodeProperties();
 877         Node node = Node.fromString(nodeId);
 878         Map<String, Property> propMapCurr = nodeProps.get(node);
 879         if ((propMapCurr != null) && (nodeProperties != null) && (!nodeProperties.isEmpty())) {
 880             Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
 881             for (Map.Entry<String, Property> entry : nodeProperties.entrySet()) {
 882                 String prop = entry.getKey();
 883                 if (prop.equals(Description.propertyName)) {
 884                     Map<Node, Map<String, Property>> nodeProp = this.inventoryService.getNodeProps();
 885                     if (nodeProp.get(node) != null) {
 886                         propMap.put(Description.propertyName, nodeProp.get(node).get(Description.propertyName));
 887                         continue;
 888                     }
 889                 }
 890                 propMap.remove(prop);
 891             }
 892             if (!nodeProps.replace(node, propMapCurr, propMap)) {
 893                 return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration.");
 894             }
 895         }
 896         if (nodeConfigList != null) {
 897             nodeConfigList.remove(nodeId);
 898         }
 899         return new Status(StatusCode.SUCCESS);
 900     }
 901
 902     @Override
 903     public Status saveSwitchConfig() {
 904         return saveSwitchConfigInternal();
 905     }
 906
 907     public Status saveSwitchConfigInternal() {
 908         Status status;
 909         short number = 0;
 910         status = configurationService.persistConfiguration(
 911                 new ArrayList<ConfigurationObject>(subnetsConfigList.values()), SUBNETS_FILE_NAME);
 912         if (status.isSuccess()) {
 913             number++;
 914         } else {
 915             log.warn("Failed to save subnet gateway configurations: " + status.getDescription());
 916         }
 917         status = configurationService.persistConfiguration(new ArrayList<ConfigurationObject>(spanConfigList.values()),
 918                 SPAN_FILE_NAME);
 919         if (status.isSuccess()) {
 920             number++;
 921         } else {
 922             log.warn("Failed to save span port configurations: " + status.getDescription());
 923         }
 924         status = configurationService.persistConfiguration(new ArrayList<ConfigurationObject>(nodeConfigList.values()),
 925                 SWITCH_CONFIG_FILE_NAME);
 926         if (status.isSuccess()) {
 927             number++;
 928         } else {
 929             log.warn("Failed to save node configurations: " + status.getDescription());
 930         }
 931         if (number == 0) {
 932             return new Status(StatusCode.INTERNALERROR, "Save failed");
 933         }
 934         if (number < 3) {
 935             return new Status(StatusCode.INTERNALERROR, "Partial save failure");
 936         }
 937         return status;
 938     }
 939
 940     @Override
 941     public List<SpanConfig> getSpanConfigList() {
 942         return new ArrayList<SpanConfig>(spanConfigList.values());
 943     }
 944
 945     @Override
 946     public Status addSpanConfig(SpanConfig conf) {
 947         // Valid config check
 948         if (!conf.isValidConfig()) {
 949             String msg = "Invalid Span configuration";
 950             log.warn(msg);
 951             return new Status(StatusCode.BADREQUEST, msg);
 952         }
 953
 954         // Presence check
 955         if (spanConfigList.containsKey(conf)) {
 956             return new Status(StatusCode.CONFLICT, "Same span config exists");
 957         }
 958
 959         // Update configuration
 960         if (spanConfigList.putIfAbsent(conf, conf) == null) {
 961             // Update database and notify clients
 962             addSpanPorts(conf.getNode(), conf.getPortArrayList());
 963         }
 964
 965         return new Status(StatusCode.SUCCESS);
 966     }
 967
 968     @Override
 969     public Status removeSpanConfig(SpanConfig conf) {
 970         removeSpanPorts(conf.getNode(), conf.getPortArrayList());
 971
 972         // Update configuration
 973         spanConfigList.remove(conf);
 974
 975         return new Status(StatusCode.SUCCESS);
 976     }
 977
 978     @Override
 979     public List<NodeConnector> getSpanPorts(Node node) {
 980         List<NodeConnector> ncList = new ArrayList<NodeConnector>();
 981
 982         for (NodeConnector nodeConnector : spanNodeConnectors) {
 983             if (nodeConnector.getNode().equals(node)) {
 984                 ncList.add(nodeConnector);
 985             }
 986         }
 987         return ncList;
 988     }
 989
 990     private void addNode(Node node, Set<Property> props) {
 991         log.trace("{} added, props: {}", node, props);
 992         if (nodeProps == null) {
 993             return;
 994         }
 995
 996         Map<String, Property> propMapCurr = nodeProps.get(node);
 997         Map<String, Property> propMap = (propMapCurr == null) ? new HashMap<String, Property>()
 998                 : new HashMap<String, Property>(propMapCurr);
 999
1000         // copy node properties from plugin
1001         if (props != null) {
1002             for (Property prop : props) {
1003                 propMap.put(prop.getName(), prop);
1004             }
1005         }
1006
1007         boolean proactiveForwarding = false;
1008         // copy node properties from config
1009         if (nodeConfigList != null) {
1010             String nodeId = node.toString();
1011             SwitchConfig conf = nodeConfigList.get(nodeId);
1012             if (conf != null && (conf.getNodeProperties() != null)) {
1013                 Map<String, Property> nodeProperties = conf.getNodeProperties();
1014                 propMap.putAll(nodeProperties);
1015                 if (nodeProperties.get(ForwardingMode.name) != null) {
1016                     ForwardingMode mode = (ForwardingMode) nodeProperties.get(ForwardingMode.name);
1017                     proactiveForwarding = mode.isProactive();
1018                 }
1019             }
1020         }
1021
1022         if (!propMap.containsKey(ForwardingMode.name)) {
1023             Property defaultMode = new ForwardingMode(ForwardingMode.REACTIVE_FORWARDING);
1024             propMap.put(ForwardingMode.name, defaultMode);
1025         }
1026         boolean result = false;
1027         if (propMapCurr == null) {
1028             if (nodeProps.putIfAbsent(node, propMap) == null) {
1029                 result = true;
1030             }
1031         } else {
1032             result = nodeProps.replace(node, propMapCurr, propMap);
1033         }
1034         if (!result) {
1035             log.debug("Cluster conflict: Conflict while adding the node properties. Node: {}  Properties: {}",
1036                     node.getID(), props);
1037             addNodeProps(node, propMap);
1038         }
1039
1040         // check if span ports are configed
1041         addSpanPorts(node);
1042
1043         // notify node listeners
1044         notifyNode(node, UpdateType.ADDED, propMap);
1045
1046         // notify proactive mode forwarding
1047         if (proactiveForwarding) {
1048             notifyModeChange(node, true);
1049         }
1050     }
1051
1052     private void removeNode(Node node) {
1053         log.trace("{} removed", node);
1054         if (nodeProps == null) {
1055             return;
1056         }
1057         nodeProps.remove(node);
1058         nodeConnectorNames.remove(node);
1059         Set<NodeConnector> removeNodeConnectorSet = new HashSet<NodeConnector>();
1060         for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1061             NodeConnector nodeConnector = entry.getKey();
1062             if (nodeConnector.getNode().equals(node)) {
1063                 removeNodeConnectorSet.add(nodeConnector);
1064             }
1065         }
1066         for (NodeConnector nc : removeNodeConnectorSet) {
1067             nodeConnectorProps.remove(nc);
1068         }
1069
1070         // check if span ports need to be cleaned up
1071         removeSpanPorts(node);
1072
1073         /* notify node listeners */
1074         notifyNode(node, UpdateType.REMOVED, null);
1075     }
1076
1077     private void updateNode(Node node, Set<Property> props) {
1078         log.trace("{} updated, props: {}", node, props);
1079         if (nodeProps == null || props == null) {
1080             return;
1081         }
1082
1083         Map<String, Property> propMapCurr = nodeProps.get(node);
1084         Map<String, Property> propMap = (propMapCurr == null) ? new HashMap<String, Property>()
1085                 : new HashMap<String, Property>(propMapCurr);
1086
1087         // copy node properties from plugin
1088         String nodeId = node.toString();
1089         for (Property prop : props) {
1090             if (nodeConfigList != null) {
1091                 SwitchConfig conf = nodeConfigList.get(nodeId);
1092                 if (conf != null && (conf.getNodeProperties() != null)
1093                         && conf.getNodeProperties().containsKey(prop.getName())) {
1094                     continue;
1095                 }
1096             }
1097             propMap.put(prop.getName(), prop);
1098         }
1099
1100         if (propMapCurr == null) {
1101             if (nodeProps.putIfAbsent(node, propMap) != null) {
1102                 log.debug("Cluster conflict: Conflict while updating the node. Node: {}  Properties: {}",
1103                         node.getID(), props);
1104                 addNodeProps(node, propMap);
1105             }
1106         } else {
1107             if (!nodeProps.replace(node, propMapCurr, propMap)) {
1108                 log.debug("Cluster conflict: Conflict while updating the node. Node: {}  Properties: {}",
1109                         node.getID(), props);
1110                 addNodeProps(node, propMap);
1111             }
1112         }
1113
1114         /* notify node listeners */
1115         notifyNode(node, UpdateType.CHANGED, propMap);
1116     }
1117
1118     @Override
1119     public void updateNode(Node node, UpdateType type, Set<Property> props) {
1120         log.debug("updateNode: {} type {} props {} for container {}",
1121                 new Object[] { node, type, props, containerName });
1122         switch (type) {
1123         case ADDED:
1124             addNode(node, props);
1125             break;
1126         case CHANGED:
1127             updateNode(node, props);
1128             break;
1129         case REMOVED:
1130             removeNode(node);
1131             break;
1132         default:
1133             break;
1134         }
1135     }
1136
1137     @Override
1138     public void updateNodeConnector(NodeConnector nodeConnector,
1139             UpdateType type, Set<Property> props) {
1140         Map<String, Property> propMap = new HashMap<String, Property>();
1141         boolean update = true;
1142
1143         log.debug("updateNodeConnector: {} type {} props {} for container {}",
1144                 new Object[] { nodeConnector, type, props, containerName });
1145
1146         if (nodeConnectorProps == null) {
1147             return;
1148         }
1149
1150         switch (type) {
1151         case ADDED:
1152             if (props != null) {
1153                 for (Property prop : props) {
1154                     addNodeConnectorProp(nodeConnector, prop);
1155                     propMap.put(prop.getName(), prop);
1156                 }
1157             } else {
1158                 addNodeConnectorProp(nodeConnector, null);
1159             }
1160
1161             addSpanPort(nodeConnector);
1162             break;
1163         case CHANGED:
1164             if (!nodeConnectorProps.containsKey(nodeConnector) || (props == null)) {
1165                 update = false;
1166             } else {
1167                 for (Property prop : props) {
1168                     addNodeConnectorProp(nodeConnector, prop);
1169                     propMap.put(prop.getName(), prop);
1170                 }
1171             }
1172             break;
1173         case REMOVED:
1174             if (!nodeConnectorProps.containsKey(nodeConnector)) {
1175                 update = false;
1176             }
1177             removeNodeConnectorAllProps(nodeConnector);
1178
1179             // clean up span config
1180             removeSpanPort(nodeConnector);
1181             break;
1182         default:
1183             update = false;
1184             break;
1185         }
1186
1187         if (update) {
1188             notifyNodeConnector(nodeConnector, type, propMap);
1189         }
1190     }
1191
1192     @Override
1193     public Set<Node> getNodes() {
1194         return (nodeProps != null) ? new HashSet<Node>(nodeProps.keySet()) : new HashSet<Node>();
1195     }
1196
1197     @Override
1198     public Map<String, Property> getControllerProperties() {
1199         return new HashMap<String, Property>(this.controllerProps);
1200     }
1201
1202     @Override
1203     public Property getControllerProperty(String propertyName) {
1204         if (propertyName != null) {
1205             HashMap<String, Property> propertyMap =  new HashMap<String, Property>(this.controllerProps);
1206             return propertyMap.get(propertyName);
1207         }
1208         return null;
1209     }
1210
1211     @Override
1212     public Status setControllerProperty(Property property) {
1213         if (property != null) {
1214             this.controllerProps.put(property.getName(), property);
1215             return new Status(StatusCode.SUCCESS);
1216         }
1217         return new Status(StatusCode.BADREQUEST, "Invalid property provided when setting property");
1218     }
1219
1220     @Override
1221     public Status removeControllerProperty(String propertyName) {
1222         if (propertyName != null) {
1223             if (this.controllerProps.containsKey(propertyName)) {
1224                 this.controllerProps.remove(propertyName);
1225                 if (!this.controllerProps.containsKey(propertyName)) {
1226                     return new Status(StatusCode.SUCCESS);
1227                 }
1228             }
1229             String msg = "Unable to remove property " + propertyName + " from Controller";
1230             return new Status(StatusCode.BADREQUEST, msg);
1231         }
1232         String msg = "Invalid property provided when removing property from Controller";
1233         return new Status(StatusCode.BADREQUEST, msg);
1234     }
1235
1236     /*
1237      * Returns a copy of a list of properties for a given node
1238      *
1239      * (non-Javadoc)
1240      *
1241      * @see
1242      * org.opendaylight.controller.switchmanager.ISwitchManager#getNodeProps
1243      * (org.opendaylight.controller.sal.core.Node)
1244      */
1245     @Override
1246     public Map<String, Property> getNodeProps(Node node) {
1247         Map<String, Property> rv = new HashMap<String, Property>();
1248         if (this.nodeProps != null) {
1249             rv = this.nodeProps.get(node);
1250             if (rv != null) {
1251                 /* make a copy of it */
1252                 rv = new HashMap<String, Property>(rv);
1253             }
1254         }
1255         return rv;
1256     }
1257
1258     @Override
1259     public Property getNodeProp(Node node, String propName) {
1260         Map<String, Property> propMap = getNodeProps(node);
1261         return (propMap != null) ? propMap.get(propName) : null;
1262     }
1263
1264     @Override
1265     public void setNodeProp(Node node, Property prop) {
1266
1267         for (int i = 0; i <= REPLACE_RETRY; i++) {
1268             /* Get a copy of the property map */
1269             Map<String, Property> propMapCurr = getNodeProps(node);
1270             if (propMapCurr == null) {
1271                 return;
1272             }
1273
1274             Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
1275             propMap.put(prop.getName(), prop);
1276
1277             if (nodeProps.replace(node, propMapCurr, propMap)) {
1278                 return;
1279             }
1280         }
1281         log.warn("Cluster conflict: Unable to add property {} to node {}.", prop.getName(), node.getID());
1282     }
1283
1284     @Override
1285     public Status removeNodeProp(Node node, String propName) {
1286         for (int i = 0; i <= REPLACE_RETRY; i++) {
1287             Map<String, Property> propMapCurr = getNodeProps(node);
1288             if (propMapCurr != null) {
1289                 if (!propMapCurr.containsKey(propName)) {
1290                     return new Status(StatusCode.SUCCESS);
1291                 }
1292                 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
1293                 propMap.remove(propName);
1294                 if (nodeProps.replace(node, propMapCurr, propMap)) {
1295                     return new Status(StatusCode.SUCCESS);
1296                 }
1297             } else {
1298                 return new Status(StatusCode.SUCCESS);
1299             }
1300         }
1301         String msg = "Cluster conflict: Unable to remove property " + propName + " for node " + node.getID();
1302         return new Status(StatusCode.CONFLICT, msg);
1303     }
1304
1305     @Override
1306     public Status removeNodeAllProps(Node node) {
1307         this.nodeProps.remove(node);
1308         return new Status(StatusCode.SUCCESS);
1309     }
1310
1311     @Override
1312     public Set<NodeConnector> getUpNodeConnectors(Node node) {
1313         if (nodeConnectorProps == null) {
1314             return null;
1315         }
1316
1317         Set<NodeConnector> nodeConnectorSet = new HashSet<NodeConnector>();
1318         for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1319             NodeConnector nodeConnector = entry.getKey();
1320             if (!nodeConnector.getNode().equals(node)) {
1321                 continue;
1322             }
1323             if (isNodeConnectorEnabled(nodeConnector)) {
1324                 nodeConnectorSet.add(nodeConnector);
1325             }
1326         }
1327
1328         return nodeConnectorSet;
1329     }
1330
1331     @Override
1332     public Set<NodeConnector> getNodeConnectors(Node node) {
1333         if (nodeConnectorProps == null) {
1334             return null;
1335         }
1336
1337         Set<NodeConnector> nodeConnectorSet = new HashSet<NodeConnector>();
1338         for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1339             NodeConnector nodeConnector = entry.getKey();
1340             if (!nodeConnector.getNode().equals(node)) {
1341                 continue;
1342             }
1343             nodeConnectorSet.add(nodeConnector);
1344         }
1345
1346         return nodeConnectorSet;
1347     }
1348
1349     @Override
1350     public Set<NodeConnector> getPhysicalNodeConnectors(Node node) {
1351         if (nodeConnectorProps == null) {
1352             return null;
1353         }
1354
1355         Set<NodeConnector> nodeConnectorSet = new HashSet<NodeConnector>();
1356         for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1357             NodeConnector nodeConnector = entry.getKey();
1358             if (!nodeConnector.getNode().equals(node)
1359                     || isSpecial(nodeConnector)) {
1360                 continue;
1361             }
1362             nodeConnectorSet.add(nodeConnector);
1363         }
1364
1365         return nodeConnectorSet;
1366     }
1367
1368     @Override
1369     public Map<String, Property> getNodeConnectorProps(NodeConnector nodeConnector) {
1370         Map<String, Property> rv = new HashMap<String, Property>();
1371         if (this.nodeConnectorProps != null) {
1372             rv = this.nodeConnectorProps.get(nodeConnector);
1373             if (rv != null) {
1374                 rv = new HashMap<String, Property>(rv);
1375             }
1376         }
1377         return rv;
1378     }
1379
1380     @Override
1381     public Property getNodeConnectorProp(NodeConnector nodeConnector,
1382             String propName) {
1383         Map<String, Property> propMap = getNodeConnectorProps(nodeConnector);
1384         return (propMap != null) ? propMap.get(propName) : null;
1385     }
1386
1387     private byte[] getHardwareMAC() {
1388         Enumeration<NetworkInterface> nis;
1389         byte[] macAddress = null;
1390
1391         try {
1392             nis = NetworkInterface.getNetworkInterfaces();
1393         } catch (SocketException e) {
1394             log.error("Failed to acquire controller MAC: ", e);
1395             return macAddress;
1396         }
1397
1398         while (nis.hasMoreElements()) {
1399             NetworkInterface ni = nis.nextElement();
1400             try {
1401                 macAddress = ni.getHardwareAddress();
1402             } catch (SocketException e) {
1403                 log.error("Failed to acquire controller MAC: ", e);
1404             }
1405             if (macAddress != null) {
1406                 break;
1407             }
1408         }
1409         if (macAddress == null) {
1410             log.warn("Failed to acquire controller MAC: No physical interface found");
1411             // This happens when running controller on windows VM, for example
1412             // Try parsing the OS command output
1413         }
1414         return macAddress;
1415     }
1416
1417     @Override
1418     public byte[] getControllerMAC() {
1419         MacAddress macProperty = (MacAddress)controllerProps.get(MacAddress.name);
1420         return (macProperty == null) ? null : macProperty.getMacAddress();
1421     }
1422
1423     @Override
1424     public NodeConnector getNodeConnector(Node node, String nodeConnectorName) {
1425         if (nodeConnectorNames == null) {
1426             return null;
1427         }
1428
1429         Map<String, NodeConnector> map = nodeConnectorNames.get(node);
1430         if (map == null) {
1431             return null;
1432         }
1433
1434         return map.get(nodeConnectorName);
1435     }
1436
1437     /**
1438      * Adds a node connector and its property if any
1439      *
1440      * @param nodeConnector
1441      *            {@link org.opendaylight.controller.sal.core.NodeConnector}
1442      * @param propName
1443      *            name of {@link org.opendaylight.controller.sal.core.Property}
1444      * @return success or failed reason
1445      */
1446     @Override
1447     public Status addNodeConnectorProp(NodeConnector nodeConnector,
1448             Property prop) {
1449         Map<String, Property> propMapCurr = getNodeConnectorProps(nodeConnector);
1450         Map<String, Property> propMap = (propMapCurr == null) ? new HashMap<String, Property>()
1451                 : new HashMap<String, Property>(propMapCurr);
1452
1453         String msg = "Cluster conflict: Unable to add NodeConnector Property.";
1454         // Just add the nodeConnector if prop is not available (in a non-default
1455         // container)
1456         if (prop == null) {
1457             if (propMapCurr == null) {
1458                 if (nodeConnectorProps.putIfAbsent(nodeConnector, propMap) != null) {
1459                     return new Status(StatusCode.CONFLICT, msg);
1460                 }
1461             } else {
1462                 if (!nodeConnectorProps.replace(nodeConnector, propMapCurr, propMap)) {
1463                     return new Status(StatusCode.CONFLICT, msg);
1464                 }
1465             }
1466             return new Status(StatusCode.SUCCESS);
1467         }
1468
1469         propMap.put(prop.getName(), prop);
1470         if (propMapCurr == null) {
1471             if (nodeConnectorProps.putIfAbsent(nodeConnector, propMap) != null) {
1472                 return new Status(StatusCode.CONFLICT, msg);
1473             }
1474         } else {
1475             if (!nodeConnectorProps.replace(nodeConnector, propMapCurr, propMap)) {
1476                 return new Status(StatusCode.CONFLICT, msg);
1477             }
1478         }
1479
1480         if (prop.getName().equals(Name.NamePropName)) {
1481             if (nodeConnectorNames != null) {
1482                 Node node = nodeConnector.getNode();
1483                 Map<String, NodeConnector> mapCurr = nodeConnectorNames.get(node);
1484                 Map<String, NodeConnector> map = new HashMap<String, NodeConnector>();
1485                 if (mapCurr != null) {
1486                     for (Map.Entry<String, NodeConnector> entry : mapCurr.entrySet()) {
1487                         String s = entry.getKey();
1488                         try {
1489                             map.put(s, new NodeConnector(entry.getValue()));
1490                         } catch (ConstructionException e) {
1491                             log.error("An error occured",e);
1492                         }
1493                     }
1494                 }
1495
1496                 map.put(((Name) prop).getValue(), nodeConnector);
1497                 if (mapCurr == null) {
1498                     if (nodeConnectorNames.putIfAbsent(node, map) != null) {
1499                         // TODO: recovery using Transactionality
1500                         return new Status(StatusCode.CONFLICT, msg);
1501                     }
1502                 } else {
1503                     if (!nodeConnectorNames.replace(node, mapCurr, map)) {
1504                         // TODO: recovery using Transactionality
1505                         return new Status(StatusCode.CONFLICT, msg);
1506                     }
1507                 }
1508             }
1509         }
1510
1511         return new Status(StatusCode.SUCCESS);
1512     }
1513
1514     /**
1515      * Removes one property of a node connector
1516      *
1517      * @param nodeConnector
1518      *            {@link org.opendaylight.controller.sal.core.NodeConnector}
1519      * @param propName
1520      *            name of {@link org.opendaylight.controller.sal.core.Property}
1521      * @return success or failed reason
1522      */
1523     @Override
1524     public Status removeNodeConnectorProp(NodeConnector nodeConnector, String propName) {
1525         Map<String, Property> propMapCurr = getNodeConnectorProps(nodeConnector);
1526
1527         if (propMapCurr == null) {
1528             /* Nothing to remove */
1529             return new Status(StatusCode.SUCCESS);
1530         }
1531
1532         Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
1533         propMap.remove(propName);
1534         boolean result = nodeConnectorProps.replace(nodeConnector, propMapCurr, propMap);
1535         String msg = "Cluster conflict: Unable to remove NodeConnector property.";
1536         if (!result) {
1537             return new Status(StatusCode.CONFLICT, msg);
1538         }
1539
1540         if (propName.equals(Name.NamePropName)) {
1541             if (nodeConnectorNames != null) {
1542                 Name name = ((Name) getNodeConnectorProp(nodeConnector, Name.NamePropName));
1543                 if (name != null) {
1544                     Node node = nodeConnector.getNode();
1545                     Map<String, NodeConnector> mapCurr = nodeConnectorNames.get(node);
1546                     if (mapCurr != null) {
1547                         Map<String, NodeConnector> map = new HashMap<String, NodeConnector>();
1548                         for (Map.Entry<String, NodeConnector> entry : mapCurr.entrySet()) {
1549                             String s = entry.getKey();
1550                             try {
1551                                 map.put(s, new NodeConnector(entry.getValue()));
1552                             } catch (ConstructionException e) {
1553                                 log.error("An error occured",e);
1554                             }
1555                         }
1556                         map.remove(name.getValue());
1557                         if (!nodeConnectorNames.replace(node, mapCurr, map)) {
1558                             // TODO: recovery using Transactionality
1559                             return new Status(StatusCode.CONFLICT, msg);
1560                         }
1561                     }
1562                 }
1563             }
1564         }
1565
1566         return new Status(StatusCode.SUCCESS);
1567     }
1568
1569     /**
1570      * Removes all the properties of a node connector
1571      *
1572      * @param nodeConnector
1573      *            {@link org.opendaylight.controller.sal.core.NodeConnector}
1574      * @return success or failed reason
1575      */
1576     @Override
1577     public Status removeNodeConnectorAllProps(NodeConnector nodeConnector) {
1578         if (nodeConnectorNames != null) {
1579             Name name = ((Name) getNodeConnectorProp(nodeConnector, Name.NamePropName));
1580             if (name != null) {
1581                 Node node = nodeConnector.getNode();
1582                 Map<String, NodeConnector> mapCurr = nodeConnectorNames.get(node);
1583                 if (mapCurr != null) {
1584                     Map<String, NodeConnector> map = new HashMap<String, NodeConnector>();
1585                     for (Map.Entry<String, NodeConnector> entry : mapCurr.entrySet()) {
1586                         String s = entry.getKey();
1587                         try {
1588                             map.put(s, new NodeConnector(entry.getValue()));
1589                         } catch (ConstructionException e) {
1590                             log.error("An error occured",e);
1591                         }
1592                     }
1593                     map.remove(name.getValue());
1594                     if (map.isEmpty()) {
1595                         nodeConnectorNames.remove(node);
1596                     } else {
1597                         if (!nodeConnectorNames.replace(node, mapCurr, map)) {
1598                             log.warn("Cluster conflict: Unable remove Name property of nodeconnector {}, skip.",
1599                                     nodeConnector.getID());
1600                         }
1601                     }
1602                 }
1603
1604             }
1605         }
1606         nodeConnectorProps.remove(nodeConnector);
1607
1608         return new Status(StatusCode.SUCCESS);
1609     }
1610
1611     /**
1612      * Function called by the dependency manager when all the required
1613      * dependencies are satisfied
1614      *
1615      */
1616     void init(Component c) {
1617         Dictionary<?, ?> props = c.getServiceProperties();
1618         if (props != null) {
1619             this.containerName = (String) props.get("containerName");
1620             log.trace("Running containerName: {}", this.containerName);
1621         } else {
1622             // In the Global instance case the containerName is empty
1623             this.containerName = "";
1624         }
1625         isDefaultContainer = containerName.equals(GlobalConstants.DEFAULT
1626                 .toString());
1627
1628     }
1629
1630     /**
1631      * Function called by the dependency manager when at least one dependency
1632      * become unsatisfied or when the component is shutting down because for
1633      * example bundle is being stopped.
1634      *
1635      */
1636     void destroy() {
1637         shutDown();
1638     }
1639
1640     /**
1641      * Function called by dependency manager after "init ()" is called and after
1642      * the services provided by the class are registered in the service registry
1643      *
1644      */
1645     void start() {
1646         startUp();
1647
1648         /*
1649          * Read startup and build database if we are the coordinator
1650          */
1651         loadSubnetConfiguration();
1652         loadSpanConfiguration();
1653         loadSwitchConfiguration();
1654
1655         // OSGI console
1656         registerWithOSGIConsole();
1657     }
1658
1659     /**
1660      * Function called after registered the service in OSGi service registry.
1661      */
1662     void started() {
1663         // solicit for existing inventories
1664         getInventories();
1665     }
1666
1667     /**
1668      * Function called by the dependency manager before the services exported by
1669      * the component are unregistered, this will be followed by a "destroy ()"
1670      * calls
1671      *
1672      */
1673     void stop() {
1674     }
1675
1676     public void setConfigurationContainerService(IConfigurationContainerService service) {
1677         log.trace("Got configuration service set request {}", service);
1678         this.configurationService = service;
1679     }
1680
1681     public void unsetConfigurationContainerService(IConfigurationContainerService service) {
1682         log.trace("Got configuration service UNset request");
1683         this.configurationService = null;
1684     }
1685
1686     public void setInventoryService(IInventoryService service) {
1687         log.trace("Got inventory service set request {}", service);
1688         this.inventoryService = service;
1689
1690         // solicit for existing inventories
1691         getInventories();
1692     }
1693
1694     public void unsetInventoryService(IInventoryService service) {
1695         log.trace("Got a service UNset request");
1696         this.inventoryService = null;
1697
1698         // clear existing inventories
1699         clearInventories();
1700     }
1701
1702     public void setStatisticsManager(IStatisticsManager statisticsManager) {
1703         log.trace("Got statistics manager set request {}", statisticsManager);
1704         this.statisticsManager = statisticsManager;
1705     }
1706
1707     public void unsetStatisticsManager(IStatisticsManager statisticsManager) {
1708         log.trace("Got statistics manager UNset request");
1709         this.statisticsManager = null;
1710     }
1711
1712     public void setSwitchManagerAware(ISwitchManagerAware service) {
1713         log.trace("Got inventory service set request {}", service);
1714         if (this.switchManagerAware != null) {
1715             this.switchManagerAware.add(service);
1716         }
1717
1718         // bulk update for newly joined
1719         switchManagerAwareNotify(service);
1720     }
1721
1722     public void unsetSwitchManagerAware(ISwitchManagerAware service) {
1723         log.trace("Got a service UNset request");
1724         if (this.switchManagerAware != null) {
1725             this.switchManagerAware.remove(service);
1726         }
1727     }
1728
1729     public void setInventoryListener(IInventoryListener service) {
1730         log.trace("Got inventory listener set request {}", service);
1731         if (this.inventoryListeners != null) {
1732             this.inventoryListeners.add(service);
1733         }
1734
1735         // bulk update for newly joined
1736         bulkUpdateService(service);
1737     }
1738
1739     public void unsetInventoryListener(IInventoryListener service) {
1740         log.trace("Got a service UNset request");
1741         if (this.inventoryListeners != null) {
1742             this.inventoryListeners.remove(service);
1743         }
1744     }
1745
1746     public void setSpanAware(ISpanAware service) {
1747         log.trace("Got SpanAware set request {}", service);
1748         if (this.spanAware != null) {
1749             this.spanAware.add(service);
1750         }
1751
1752         // bulk update for newly joined
1753         spanAwareNotify(service);
1754     }
1755
1756     public void unsetSpanAware(ISpanAware service) {
1757         log.trace("Got a service UNset request");
1758         if (this.spanAware != null) {
1759             this.spanAware.remove(service);
1760         }
1761     }
1762
1763     void setClusterContainerService(IClusterContainerServices s) {
1764         log.trace("Cluster Service set");
1765         this.clusterContainerService = s;
1766     }
1767
1768     void unsetClusterContainerService(IClusterContainerServices s) {
1769         if (this.clusterContainerService == s) {
1770             log.trace("Cluster Service removed!");
1771             this.clusterContainerService = null;
1772         }
1773     }
1774
1775     private void getInventories() {
1776         if (inventoryService == null) {
1777             log.trace("inventory service not avaiable");
1778             return;
1779         }
1780
1781         Map<Node, Map<String, Property>> nodeProp = this.inventoryService.getNodeProps();
1782         for (Map.Entry<Node, Map<String, Property>> entry : nodeProp.entrySet()) {
1783             Node node = entry.getKey();
1784             log.debug("getInventories: {} added for container {}", new Object[] { node, containerName });
1785             Map<String, Property> propMap = entry.getValue();
1786             Set<Property> props = new HashSet<Property>();
1787             for (Property property : propMap.values()) {
1788                 props.add(property);
1789             }
1790             addNode(node, props);
1791         }
1792
1793         Map<NodeConnector, Map<String, Property>> nodeConnectorProp = this.inventoryService.getNodeConnectorProps();
1794         for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProp.entrySet()) {
1795             Map<String, Property> propMap = entry.getValue();
1796             for (Property property : propMap.values()) {
1797                 addNodeConnectorProp(entry.getKey(), property);
1798             }
1799         }
1800     }
1801
1802     private void clearInventories() {
1803         nodeProps.clear();
1804         nodeConnectorProps.clear();
1805         nodeConnectorNames.clear();
1806         spanNodeConnectors.clear();
1807     }
1808
1809     private void notifyNode(Node node, UpdateType type,
1810             Map<String, Property> propMap) {
1811         synchronized (inventoryListeners) {
1812             for (IInventoryListener service : inventoryListeners) {
1813                 service.notifyNode(node, type, propMap);
1814             }
1815         }
1816     }
1817
1818     private void notifyNodeConnector(NodeConnector nodeConnector,
1819             UpdateType type, Map<String, Property> propMap) {
1820         synchronized (inventoryListeners) {
1821             for (IInventoryListener service : inventoryListeners) {
1822                 service.notifyNodeConnector(nodeConnector, type, propMap);
1823             }
1824         }
1825     }
1826
1827     /*
1828      * For those joined late, bring them up-to-date.
1829      */
1830     private void switchManagerAwareNotify(ISwitchManagerAware service) {
1831         for (Subnet sub : subnets.values()) {
1832             service.subnetNotify(sub, true);
1833         }
1834
1835         for (Node node : getNodes()) {
1836             SwitchConfig sc = getSwitchConfig(node.toString());
1837             if ((sc != null) && isDefaultContainer) {
1838                 ForwardingMode mode = (ForwardingMode) sc.getProperty(ForwardingMode.name);
1839                 service.modeChangeNotify(node, (mode == null) ? false : mode.isProactive());
1840             }
1841         }
1842     }
1843
1844     private void bulkUpdateService(IInventoryListener service) {
1845         Map<String, Property> propMap;
1846         UpdateType type = UpdateType.ADDED;
1847
1848         for (Node node : getNodes()) {
1849             propMap = nodeProps.get(node);
1850             service.notifyNode(node, type, propMap);
1851         }
1852
1853         for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1854             NodeConnector nodeConnector = entry.getKey();
1855             propMap = nodeConnectorProps.get(nodeConnector);
1856             service.notifyNodeConnector(nodeConnector, type, propMap);
1857         }
1858     }
1859
1860     private void spanAwareNotify(ISpanAware service) {
1861         for (Node node : getNodes()) {
1862             for (SpanConfig conf : getSpanConfigList(node)) {
1863                 service.spanUpdate(node, conf.getPortArrayList(), true);
1864             }
1865         }
1866     }
1867
1868     private void registerWithOSGIConsole() {
1869         BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass())
1870                 .getBundleContext();
1871         bundleContext.registerService(CommandProvider.class.getName(), this,
1872                 null);
1873     }
1874
1875     @Override
1876     public Boolean isNodeConnectorEnabled(NodeConnector nodeConnector) {
1877         if (nodeConnector == null) {
1878             return false;
1879         }
1880
1881         Config config = (Config) getNodeConnectorProp(nodeConnector,
1882                 Config.ConfigPropName);
1883         State state = (State) getNodeConnectorProp(nodeConnector,
1884                 State.StatePropName);
1885         return ((config != null) && (config.getValue() == Config.ADMIN_UP)
1886                 && (state != null) && (state.getValue() == State.EDGE_UP));
1887     }
1888
1889     @Override
1890     public boolean doesNodeConnectorExist(NodeConnector nc) {
1891         return (nc != null && nodeConnectorProps != null
1892                 && nodeConnectorProps.containsKey(nc));
1893     }
1894
1895     @Override
1896     public String getHelp() {
1897         StringBuffer help = new StringBuffer();
1898         help.append("---Switch Manager---\n");
1899         help.append("\t pencs <node id>        - Print enabled node connectors for a given node\n");
1900         help.append("\t pdm <node id>          - Print switch ports in device map\n");
1901         return help.toString();
1902     }
1903
1904     public void _pencs(CommandInterpreter ci) {
1905         String st = ci.nextArgument();
1906         if (st == null) {
1907             ci.println("Please enter node id");
1908             return;
1909         }
1910
1911         Node node = Node.fromString(st);
1912         if (node == null) {
1913             ci.println("Please enter node id");
1914             return;
1915         }
1916
1917         Set<NodeConnector> nodeConnectorSet = getUpNodeConnectors(node);
1918         if (nodeConnectorSet == null) {
1919             return;
1920         }
1921         for (NodeConnector nodeConnector : nodeConnectorSet) {
1922             if (nodeConnector == null) {
1923                 continue;
1924             }
1925             ci.println(nodeConnector);
1926         }
1927         ci.println("Total number of NodeConnectors: " + nodeConnectorSet.size());
1928     }
1929
1930     public void _pdm(CommandInterpreter ci) {
1931         String st = ci.nextArgument();
1932         if (st == null) {
1933             ci.println("Please enter node id");
1934             return;
1935         }
1936
1937         Node node = Node.fromString(st);
1938         if (node == null) {
1939             ci.println("Please enter node id");
1940             return;
1941         }
1942
1943         Switch sw = getSwitchByNode(node);
1944
1945         ci.println("          NodeConnector                        Name");
1946
1947         Set<NodeConnector> nodeConnectorSet = sw.getNodeConnectors();
1948         String nodeConnectorName;
1949         if (nodeConnectorSet != null && nodeConnectorSet.size() > 0) {
1950             for (NodeConnector nodeConnector : nodeConnectorSet) {
1951                 Map<String, Property> propMap = getNodeConnectorProps(nodeConnector);
1952                 nodeConnectorName = (propMap == null) ? null : ((Name) propMap
1953                         .get(Name.NamePropName)).getValue();
1954                 if (nodeConnectorName != null) {
1955                     Node nd = nodeConnector.getNode();
1956                     if (!nd.equals(node)) {
1957                         log.debug("node not match {} {}", nd, node);
1958                     }
1959                     Map<String, NodeConnector> map = nodeConnectorNames
1960                             .get(node);
1961                     if (map != null) {
1962                         NodeConnector nc = map.get(nodeConnectorName);
1963                         if (nc == null) {
1964                             log.debug("no nodeConnector named {}",
1965                                     nodeConnectorName);
1966                         } else if (!nc.equals(nodeConnector)) {
1967                             log.debug("nodeConnector not match {} {}", nc,
1968                                     nodeConnector);
1969                         }
1970                     }
1971                 }
1972
1973                 ci.println(nodeConnector
1974                         + "            "
1975                         + ((nodeConnectorName == null) ? "" : nodeConnectorName)
1976                         + "(" + nodeConnector.getID() + ")");
1977             }
1978             ci.println("Total number of NodeConnectors: "
1979                     + nodeConnectorSet.size());
1980         }
1981     }
1982
1983     @Override
1984     public byte[] getNodeMAC(Node node) {
1985         MacAddress mac = (MacAddress) this.getNodeProp(node,
1986                 MacAddress.name);
1987         return (mac != null) ? mac.getMacAddress() : null;
1988     }
1989
1990     @Override
1991     public boolean isSpecial(NodeConnector p) {
1992         if (p.getType().equals(NodeConnectorIDType.CONTROLLER)
1993                 || p.getType().equals(NodeConnectorIDType.ALL)
1994                 || p.getType().equals(NodeConnectorIDType.SWSTACK)
1995                 || p.getType().equals(NodeConnectorIDType.HWPATH)) {
1996             return true;
1997         }
1998         return false;
1999     }
2000
2001     /*
2002      * Add span configuration to local cache and notify clients
2003      */
2004     private void addSpanPorts(Node node, List<NodeConnector> nodeConnectors) {
2005         List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
2006
2007         for (NodeConnector nodeConnector : nodeConnectors) {
2008             if (!spanNodeConnectors.contains(nodeConnector)) {
2009                 ncLists.add(nodeConnector);
2010             }
2011         }
2012
2013         if (ncLists.size() > 0) {
2014             spanNodeConnectors.addAll(ncLists);
2015             notifySpanPortChange(node, ncLists, true);
2016         }
2017     }
2018
2019     private void addSpanPorts(Node node) {
2020         for (SpanConfig conf : getSpanConfigList(node)) {
2021             addSpanPorts(node, conf.getPortArrayList());
2022         }
2023     }
2024
2025     private void addSpanPort(NodeConnector nodeConnector) {
2026         // only add if span is configured on this nodeConnector
2027         for (SpanConfig conf : getSpanConfigList(nodeConnector.getNode())) {
2028             if (conf.getPortArrayList().contains(nodeConnector)) {
2029                 List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
2030                 ncLists.add(nodeConnector);
2031                 addSpanPorts(nodeConnector.getNode(), ncLists);
2032                 return;
2033             }
2034         }
2035     }
2036
2037     /*
2038      * Remove span configuration to local cache and notify clients
2039      */
2040     private void removeSpanPorts(Node node, List<NodeConnector> nodeConnectors) {
2041         List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
2042
2043         for (NodeConnector nodeConnector : nodeConnectors) {
2044             if (spanNodeConnectors.contains(nodeConnector)) {
2045                 ncLists.add(nodeConnector);
2046             }
2047         }
2048
2049         if (ncLists.size() > 0) {
2050             spanNodeConnectors.removeAll(ncLists);
2051             notifySpanPortChange(node, ncLists, false);
2052         }
2053     }
2054
2055     private void removeSpanPorts(Node node) {
2056         for (SpanConfig conf : getSpanConfigList(node)) {
2057             addSpanPorts(node, conf.getPortArrayList());
2058         }
2059     }
2060
2061     private void removeSpanPort(NodeConnector nodeConnector) {
2062         if (spanNodeConnectors.contains(nodeConnector)) {
2063             List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
2064             ncLists.add(nodeConnector);
2065             removeSpanPorts(nodeConnector.getNode(), ncLists);
2066         }
2067     }
2068
2069     private void addNodeProps(Node node, Map<String, Property> propMap) {
2070         if (propMap == null) {
2071             propMap = new HashMap<String, Property>();
2072         }
2073         nodeProps.put(node, propMap);
2074     }
2075
2076     @Override
2077     public Status saveConfiguration() {
2078         return saveSwitchConfig();
2079     }
2080
2081     /**
2082      * Creates a Name/Tier/Bandwidth/MacAddress(controller property) Property
2083      * object based on given property name and value. Other property types are
2084      * not supported yet.
2085      *
2086      * @param propName
2087      *            Name of the Property
2088      * @param propValue
2089      *            Value of the Property
2090      * @return {@link org.opendaylight.controller.sal.core.Property}
2091      */
2092     @Override
2093     public Property createProperty(String propName, String propValue) {
2094         if (propName == null) {
2095             log.debug("propName is null");
2096             return null;
2097         }
2098         if (propValue == null) {
2099             log.debug("propValue is null");
2100             return null;
2101         }
2102
2103         try {
2104             if (propName.equalsIgnoreCase(Description.propertyName)) {
2105                 return new Description(propValue);
2106             } else if (propName.equalsIgnoreCase(Tier.TierPropName)) {
2107                 int tier = Integer.parseInt(propValue);
2108                 return new Tier(tier);
2109             } else if (propName.equalsIgnoreCase(Bandwidth.BandwidthPropName)) {
2110                 long bw = Long.parseLong(propValue);
2111                 return new Bandwidth(bw);
2112             } else if (propName.equalsIgnoreCase(ForwardingMode.name)) {
2113                 int mode = Integer.parseInt(propValue);
2114                 return new ForwardingMode(mode);
2115             } else if (propName.equalsIgnoreCase(MacAddress.name)){
2116                 return new MacAddress(propValue);
2117             }
2118             else {
2119                 log.debug("Not able to create {} property", propName);
2120             }
2121         } catch (Exception e) {
2122             log.debug("createProperty caught exception {}", e.getMessage());
2123         }
2124
2125         return null;
2126     }
2127
2128
2129     @SuppressWarnings("deprecation")
2130     @Override
2131     public String getNodeDescription(Node node) {
2132         // Check first if user configured a name
2133         SwitchConfig config = getSwitchConfig(node.toString());
2134         if (config != null) {
2135             String configuredDesc = config.getNodeDescription();
2136             if (configuredDesc != null && !configuredDesc.isEmpty()) {
2137                 return configuredDesc;
2138             }
2139         }
2140
2141         // No name configured by user, get the node advertised name
2142         Description desc = (Description) getNodeProp(node,
2143                 Description.propertyName);
2144         return (desc == null /* || desc.getValue().equalsIgnoreCase("none") */) ? ""
2145                 : desc.getValue();
2146     }
2147
2148     @Override
2149     public Set<Switch> getConfiguredNotConnectedSwitches() {
2150         Set<Switch> configuredNotConnectedSwitches = new HashSet<Switch>();
2151         if (this.inventoryService == null) {
2152             log.trace("inventory service not avaiable");
2153             return configuredNotConnectedSwitches;
2154         }
2155
2156         Set<Node> configuredNotConnectedNodes = this.inventoryService.getConfiguredNotConnectedNodes();
2157         if (configuredNotConnectedNodes != null) {
2158             for (Node node : configuredNotConnectedNodes) {
2159                 Switch sw = getSwitchByNode(node);
2160                 configuredNotConnectedSwitches.add(sw);
2161             }
2162         }
2163         return configuredNotConnectedSwitches;
2164     }
2165
2166 }