opendaylight/forwardingrulesmanager/implementation/src/main/java/org/opendaylight/controller/forwardingrulesmanager/internal/ForwardingRulesManager.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.forwardingrulesmanager.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.UnknownHostException;
  16 import java.util.ArrayList;
  17 import java.util.Collections;
  18 import java.util.EnumSet;
  19 import java.util.HashSet;
  20 import java.util.List;
  21 import java.util.Map;
  22 import java.util.Map.Entry;
  23 import java.util.Set;
  24 import java.util.concurrent.BlockingQueue;
  25 import java.util.concurrent.Callable;
  26 import java.util.concurrent.ConcurrentHashMap;
  27 import java.util.concurrent.ConcurrentMap;
  28 import java.util.concurrent.ExecutionException;
  29 import java.util.concurrent.ExecutorService;
  30 import java.util.concurrent.Executors;
  31 import java.util.concurrent.LinkedBlockingQueue;
  32
  33 import org.eclipse.osgi.framework.console.CommandInterpreter;
  34 import org.eclipse.osgi.framework.console.CommandProvider;
  35 import org.opendaylight.controller.clustering.services.CacheConfigException;
  36 import org.opendaylight.controller.clustering.services.CacheExistException;
  37 import org.opendaylight.controller.clustering.services.ICacheUpdateAware;
  38 import org.opendaylight.controller.clustering.services.IClusterContainerServices;
  39 import org.opendaylight.controller.clustering.services.IClusterServices;
  40 import org.opendaylight.controller.configuration.IConfigurationContainerAware;
  41 import org.opendaylight.controller.connectionmanager.ConnectionLocality;
  42 import org.opendaylight.controller.connectionmanager.IConnectionManager;
  43 import org.opendaylight.controller.forwardingrulesmanager.FlowConfig;
  44 import org.opendaylight.controller.forwardingrulesmanager.FlowEntry;
  45 import org.opendaylight.controller.forwardingrulesmanager.FlowEntryInstall;
  46 import org.opendaylight.controller.forwardingrulesmanager.IForwardingRulesManager;
  47 import org.opendaylight.controller.forwardingrulesmanager.IForwardingRulesManagerAware;
  48 import org.opendaylight.controller.forwardingrulesmanager.PortGroup;
  49 import org.opendaylight.controller.forwardingrulesmanager.PortGroupChangeListener;
  50 import org.opendaylight.controller.forwardingrulesmanager.PortGroupConfig;
  51 import org.opendaylight.controller.forwardingrulesmanager.PortGroupProvider;
  52 import org.opendaylight.controller.forwardingrulesmanager.implementation.data.FlowEntryDistributionOrder;
  53 import org.opendaylight.controller.sal.action.Action;
  54 import org.opendaylight.controller.sal.action.ActionType;
  55 import org.opendaylight.controller.sal.action.Controller;
  56 import org.opendaylight.controller.sal.action.Flood;
  57 import org.opendaylight.controller.sal.action.Output;
  58 import org.opendaylight.controller.sal.action.PopVlan;
  59 import org.opendaylight.controller.sal.core.Config;
  60 import org.opendaylight.controller.sal.core.ContainerFlow;
  61 import org.opendaylight.controller.sal.core.IContainer;
  62 import org.opendaylight.controller.sal.core.IContainerListener;
  63 import org.opendaylight.controller.sal.core.Node;
  64 import org.opendaylight.controller.sal.core.NodeConnector;
  65 import org.opendaylight.controller.sal.core.Property;
  66 import org.opendaylight.controller.sal.core.UpdateType;
  67 import org.opendaylight.controller.sal.flowprogrammer.Flow;
  68 import org.opendaylight.controller.sal.flowprogrammer.IFlowProgrammerListener;
  69 import org.opendaylight.controller.sal.flowprogrammer.IFlowProgrammerService;
  70 import org.opendaylight.controller.sal.match.Match;
  71 import org.opendaylight.controller.sal.match.MatchType;
  72 import org.opendaylight.controller.sal.utils.EtherTypes;
  73 import org.opendaylight.controller.sal.utils.GlobalConstants;
  74 import org.opendaylight.controller.sal.utils.HexEncode;
  75 import org.opendaylight.controller.sal.utils.IObjectReader;
  76 import org.opendaylight.controller.sal.utils.IPProtocols;
  77 import org.opendaylight.controller.sal.utils.NodeConnectorCreator;
  78 import org.opendaylight.controller.sal.utils.NodeCreator;
  79 import org.opendaylight.controller.sal.utils.ObjectReader;
  80 import org.opendaylight.controller.sal.utils.ObjectWriter;
  81 import org.opendaylight.controller.sal.utils.Status;
  82 import org.opendaylight.controller.sal.utils.StatusCode;
  83 import org.opendaylight.controller.switchmanager.IInventoryListener;
  84 import org.opendaylight.controller.switchmanager.ISwitchManager;
  85 import org.opendaylight.controller.switchmanager.ISwitchManagerAware;
  86 import org.opendaylight.controller.switchmanager.Subnet;
  87 import org.osgi.framework.BundleContext;
  88 import org.osgi.framework.FrameworkUtil;
  89 import org.slf4j.Logger;
  90 import org.slf4j.LoggerFactory;
  91
  92 /**
  93  * Class that manages forwarding rule installation and removal per container of
  94  * the network. It also maintains the central repository of all the forwarding
  95  * rules installed on the network nodes.
  96  */
  97 public class ForwardingRulesManager implements
  98         IForwardingRulesManager,
  99         PortGroupChangeListener,
 100         IContainerListener,
 101         ISwitchManagerAware,
 102         IConfigurationContainerAware,
 103         IInventoryListener,
 104         IObjectReader,
 105         ICacheUpdateAware<Object,Object>,
 106         CommandProvider,
 107         IFlowProgrammerListener {
 108     private static final String NODEDOWN = "Node is Down";
 109     private static final String SUCCESS = StatusCode.SUCCESS.toString();
 110     private static final Logger log = LoggerFactory.getLogger(ForwardingRulesManager.class);
 111     private static final String PORTREMOVED = "Port removed";
 112     private static final Logger logsync = LoggerFactory.getLogger("FRMsync");
 113     private String frmFileName;
 114     private String portGroupFileName;
 115     private ConcurrentMap<Integer, FlowConfig> staticFlows;
 116     private ConcurrentMap<Integer, Integer> staticFlowsOrdinal;
 117     private ConcurrentMap<String, PortGroupConfig> portGroupConfigs;
 118     private ConcurrentMap<PortGroupConfig, Map<Node, PortGroup>> portGroupData;
 119     private ConcurrentMap<String, Object> TSPolicies;
 120     private boolean inContainerMode; // being used by global instance only
 121     private boolean stopping;
 122
 123     /*
 124      * Flow database. It's the software view of what was requested to install
 125      * and what is installed on the switch. It is indexed by the entry itself.
 126      * The entry's hashcode resumes the network node index, the flow's priority
 127      * and the flow's match. The value element is a class which contains the
 128      * flow entry pushed by the applications modules and the respective
 129      * container flow merged version. In absence of container flows, the two
 130      * flow entries are the same.
 131      */
 132     private ConcurrentMap<FlowEntry, FlowEntry> originalSwView;
 133     private ConcurrentMap<FlowEntryInstall, FlowEntryInstall> installedSwView;
 134     /*
 135      * Per node and per group indexing
 136      */
 137     private ConcurrentMap<Node, List<FlowEntryInstall>> nodeFlows;
 138     private ConcurrentMap<String, List<FlowEntryInstall>> groupFlows;
 139
 140     /*
 141      * Inactive flow list. This is for the global instance of FRM It will
 142      * contain all the flow entries which were installed on the global container
 143      * when the first container is created.
 144      */
 145     private ConcurrentMap<FlowEntry, FlowEntry> inactiveFlows;
 146
 147     private IContainer container;
 148     private Set<IForwardingRulesManagerAware> frmAware =
 149         Collections.synchronizedSet(new HashSet<IForwardingRulesManagerAware>());
 150     private PortGroupProvider portGroupProvider;
 151     private IFlowProgrammerService programmer;
 152     private IClusterContainerServices clusterContainerService = null;
 153     private ISwitchManager switchManager;
 154     private Thread frmEventHandler;
 155     protected BlockingQueue<FRMEvent> pendingEvents;
 156
 157     // Distributes FRM programming in the cluster
 158     private IConnectionManager connectionManager;
 159
 160     /*
 161      * Name clustered caches used to support FRM entry distribution these are by
 162      * necessity non-transactional as long as need to be able to synchronize
 163      * states also while a transaction is in progress
 164      */
 165     static final String WORKORDERCACHE = "frm.workOrder";
 166     static final String WORKSTATUSCACHE = "frm.workStatus";
 167
 168     /*
 169      * Data structure responsible for distributing the FlowEntryInstall requests
 170      * in the cluster. The key value is entry that is being either Installed or
 171      * Updated or Delete. The value field is the same of the key value in case
 172      * of Installation or Deletion, it's the new entry in case of Modification,
 173      * this because the clustering caches don't allow null values.
 174      *
 175      * The logic behind this data structure is that the controller that initiate
 176      * the request will place the order here, someone will pick it and then will
 177      * remove from this data structure because is being served.
 178      *
 179      * TODO: We need to have a way to cleanup this data structure if entries are
 180      * not picked by anyone, which is always a case can happen especially on
 181      * Node disconnect cases.
 182      */
 183     private ConcurrentMap<FlowEntryDistributionOrder, FlowEntryInstall> workOrder;
 184
 185     /*
 186      * Data structure responsible for retrieving the results of the workOrder
 187      * submitted to the cluster.
 188      *
 189      * The logic behind this data structure is that the controller that has
 190      * executed the order will then place the result in workStatus signaling
 191      * that there was a success or a failure.
 192      *
 193      * TODO: The workStatus entries need to have a lifetime associated in case
 194      * of requestor controller leaving the cluster.
 195      */
 196     private ConcurrentMap<FlowEntryDistributionOrder, Status> workStatus;
 197
 198     /*
 199      * Local Map used to hold the Future which a caller can use to monitor for
 200      * completion
 201      */
 202     private ConcurrentMap<FlowEntryDistributionOrder, FlowEntryDistributionOrderFutureTask> workMonitor =
 203             new ConcurrentHashMap<FlowEntryDistributionOrder, FlowEntryDistributionOrderFutureTask>();
 204
 205     /**
 206      * @param e
 207      *            Entry being installed/updated/removed
 208      * @param u
 209      *            New entry will be placed after the update operation. Valid
 210      *            only for UpdateType.CHANGED, null for all the other cases
 211      * @param t
 212      *            Type of update
 213      * @return a Future object for monitoring the progress of the result, or
 214      *         null in case the processing should take place locally
 215      */
 216     private FlowEntryDistributionOrderFutureTask distributeWorkOrder(FlowEntryInstall e, FlowEntryInstall u,
 217             UpdateType t) {
 218         // A null entry it's an unexpected condition, anyway it's safe to keep
 219         // the handling local
 220         if (e == null) {
 221             return null;
 222         }
 223
 224         Node n = e.getNode();
 225         if (connectionManager.getLocalityStatus(n) == ConnectionLocality.NOT_LOCAL) {
 226             // Create the work order and distribute it
 227             FlowEntryDistributionOrder fe =
 228                     new FlowEntryDistributionOrder(e, t, clusterContainerService.getMyAddress());
 229             // First create the monitor job
 230             FlowEntryDistributionOrderFutureTask ret = new FlowEntryDistributionOrderFutureTask(fe);
 231             logsync.trace("Node {} not local so sending fe {}", n, fe);
 232             workMonitor.put(fe, ret);
 233             if (t.equals(UpdateType.CHANGED)) {
 234                 // Then distribute the work
 235                 workOrder.put(fe, u);
 236             } else {
 237                 // Then distribute the work
 238                 workOrder.put(fe, e);
 239             }
 240             logsync.trace("WorkOrder requested");
 241             // Now create an Handle to monitor the execution of the operation
 242             return ret;
 243         }
 244
 245         logsync.trace("Node {} could be local. so processing Entry:{} UpdateType:{}", n, e, t);
 246         return null;
 247     }
 248
 249     /**
 250      * Adds a flow entry onto the network node It runs various validity checks
 251      * and derive the final container flows merged entries that will be
 252      * attempted to be installed
 253      *
 254      * @param flowEntry
 255      *            the original flow entry application requested to add
 256      * @param async
 257      *            the flag indicating if this is a asynchronous request
 258      * @return the status of this request. In case of asynchronous call, it will
 259      *         contain the unique id assigned to this request
 260      */
 261     private Status addEntry(FlowEntry flowEntry, boolean async) {
 262
 263         // Sanity Check
 264         if (flowEntry == null || flowEntry.getNode() == null) {
 265             String msg = "Invalid FlowEntry";
 266             String logMsg = msg + ": {}";
 267             log.warn(logMsg, flowEntry);
 268             return new Status(StatusCode.NOTACCEPTABLE, msg);
 269         }
 270
 271         /*
 272          * Derive the container flow merged entries to install In presence of N
 273          * container flows, we may end up with N different entries to install...
 274          */
 275         List<FlowEntryInstall> toInstallList = deriveInstallEntries(flowEntry.clone(), container.getContainerFlows());
 276
 277         // Container Flow conflict Check
 278         if (toInstallList.isEmpty()) {
 279             String msg = "Flow Entry conflicts with all Container Flows";
 280             String logMsg = msg + ": {}";
 281             log.warn(logMsg, flowEntry);
 282             return new Status(StatusCode.CONFLICT, msg);
 283         }
 284
 285         // Derive the list of entries good to be installed
 286         List<FlowEntryInstall> toInstallSafe = new ArrayList<FlowEntryInstall>();
 287         for (FlowEntryInstall entry : toInstallList) {
 288             // Conflict Check: Verify new entry would not overwrite existing
 289             // ones
 290             if (this.installedSwView.containsKey(entry)) {
 291                 log.warn("Operation Rejected: A flow with same match and priority exists on the target node");
 292                 log.trace("Aborting to install {}", entry);
 293                 continue;
 294             }
 295             toInstallSafe.add(entry);
 296         }
 297
 298         // Declare failure if all the container flow merged entries clash with
 299         // existing entries
 300         if (toInstallSafe.size() == 0) {
 301             String msg = "A flow with same match and priority exists on the target node";
 302             String logMsg = msg + ": {}";
 303             log.warn(logMsg, flowEntry);
 304             return new Status(StatusCode.CONFLICT, msg);
 305         }
 306
 307         // Try to install an entry at the time
 308         Status error = new Status(null, null);
 309         Status succeded = null;
 310         boolean oneSucceded = false;
 311         for (FlowEntryInstall installEntry : toInstallSafe) {
 312
 313             // Install and update database
 314             Status ret = addEntriesInternal(installEntry, async);
 315
 316             if (ret.isSuccess()) {
 317                 oneSucceded = true;
 318                 /*
 319                  * The first successful status response will be returned For the
 320                  * asynchronous call, we can discard the container flow
 321                  * complication for now and assume we will always deal with one
 322                  * flow only per request
 323                  */
 324                 succeded = ret;
 325             } else {
 326                 error = ret;
 327                 log.warn("Failed to install the entry: {}. The failure is: {}", installEntry, ret.getDescription());
 328             }
 329         }
 330
 331         return (oneSucceded) ? succeded : error;
 332     }
 333
 334     /**
 335      * Given a flow entry and the list of container flows, it returns the list
 336      * of container flow merged flow entries good to be installed on this
 337      * container. If the list of container flows is null or empty, the install
 338      * entry list will contain only one entry, the original flow entry. If the
 339      * flow entry is congruent with all the N container flows, then the output
 340      * install entry list will contain N entries. If the output list is empty,
 341      * it means the passed flow entry conflicts with all the container flows.
 342      *
 343      * @param cFlowList
 344      *            The list of container flows
 345      * @return the list of container flow merged entries good to be installed on
 346      *         this container
 347      */
 348     private List<FlowEntryInstall> deriveInstallEntries(FlowEntry request, List<ContainerFlow> cFlowList) {
 349         List<FlowEntryInstall> toInstallList = new ArrayList<FlowEntryInstall>(1);
 350
 351         if (container.getContainerFlows() == null || container.getContainerFlows().isEmpty()) {
 352             // No container flows => entry good to be installed unchanged
 353             toInstallList.add(new FlowEntryInstall(request.clone(), null));
 354         } else {
 355             // Create the list of entries to be installed. If the flow entry is
 356             // not congruent with any container flow, no install entries will be
 357             // created
 358             for (ContainerFlow cFlow : container.getContainerFlows()) {
 359                 if (cFlow.allowsFlow(request.getFlow())) {
 360                     toInstallList.add(new FlowEntryInstall(request.clone(), cFlow));
 361                 }
 362             }
 363         }
 364         return toInstallList;
 365     }
 366
 367     /**
 368      * Modify a flow entry with a new one It runs various validity check and
 369      * derive the final container flows merged flow entries to work with
 370      *
 371      * @param currentFlowEntry
 372      * @param newFlowEntry
 373      * @param async
 374      *            the flag indicating if this is a asynchronous request
 375      * @return the status of this request. In case of asynchronous call, it will
 376      *         contain the unique id assigned to this request
 377      */
 378     private Status modifyEntry(FlowEntry currentFlowEntry, FlowEntry newFlowEntry, boolean async) {
 379         Status retExt;
 380
 381         // Sanity checks
 382         if (currentFlowEntry == null || currentFlowEntry.getNode() == null || newFlowEntry == null
 383                 || newFlowEntry.getNode() == null) {
 384             String msg = "Modify: Invalid FlowEntry";
 385             String logMsg = msg + ": {} or {}";
 386             log.warn(logMsg, currentFlowEntry, newFlowEntry);
 387             return new Status(StatusCode.NOTACCEPTABLE, msg);
 388         }
 389         if (!currentFlowEntry.getNode().equals(newFlowEntry.getNode())
 390                 || !currentFlowEntry.getFlowName().equals(newFlowEntry.getFlowName())) {
 391             String msg = "Modify: Incompatible Flow Entries";
 392             String logMsg = msg + ": {} and {}";
 393             log.warn(logMsg, currentFlowEntry, newFlowEntry);
 394             return new Status(StatusCode.NOTACCEPTABLE, msg);
 395         }
 396
 397         // Equality Check
 398         if (currentFlowEntry.getFlow().equals(newFlowEntry.getFlow())) {
 399             String msg = "Modify skipped as flows are the same";
 400             String logMsg = msg + ": {} and {}";
 401             log.debug(logMsg, currentFlowEntry, newFlowEntry);
 402             return new Status(StatusCode.SUCCESS, msg);
 403         }
 404
 405         /*
 406          * Conflict Check: Verify the new entry would not conflict with an
 407          * existing one. This is a loose check on the previous original flow
 408          * entry requests. No check on the container flow merged flow entries
 409          * (if any) yet
 410          */
 411         FlowEntry sameMatchOriginalEntry = originalSwView.get(newFlowEntry);
 412         if (sameMatchOriginalEntry != null && !sameMatchOriginalEntry.equals(currentFlowEntry)) {
 413             String msg = "Operation Rejected: Another flow with same match and priority exists on the target node";
 414             String logMsg = msg + ": {}";
 415             log.warn(logMsg, currentFlowEntry);
 416             return new Status(StatusCode.CONFLICT, msg);
 417         }
 418
 419         // Derive the installed and toInstall entries
 420         List<FlowEntryInstall> installedList = deriveInstallEntries(currentFlowEntry.clone(),
 421                 container.getContainerFlows());
 422         List<FlowEntryInstall> toInstallList = deriveInstallEntries(newFlowEntry.clone(), container.getContainerFlows());
 423
 424         if (toInstallList.isEmpty()) {
 425             String msg = "Modify Operation Rejected: The new entry conflicts with all the container flows";
 426             String logMsg = msg + ": {}";
 427             log.warn(logMsg, newFlowEntry);
 428             log.warn(msg);
 429             return new Status(StatusCode.CONFLICT, msg);
 430         }
 431
 432         /*
 433          * If the two list sizes differ, it means the new flow entry does not
 434          * satisfy the same number of container flows the current entry does.
 435          * This is only possible when the new entry and current entry have
 436          * different match. In this scenario the modification would ultimately
 437          * be handled as a remove and add operations in the protocol plugin.
 438          *
 439          * Also, if any of the new flow entries would clash with an existing
 440          * one, we cannot proceed with the modify operation, because it would
 441          * fail for some entries and leave stale entries on the network node.
 442          * Modify path can be taken only if it can be performed completely, for
 443          * all entries.
 444          *
 445          * So, for the above two cases, to simplify, let's decouple the modify
 446          * in: 1) remove current entries 2) install new entries
 447          */
 448         Status succeeded = null;
 449         boolean decouple = false;
 450         if (installedList.size() != toInstallList.size()) {
 451             log.info("Modify: New flow entry does not satisfy the same "
 452                     + "number of container flows as the original entry does");
 453             decouple = true;
 454         }
 455         List<FlowEntryInstall> toInstallSafe = new ArrayList<FlowEntryInstall>();
 456         for (FlowEntryInstall installEntry : toInstallList) {
 457             /*
 458              * Conflict Check: Verify the new entry would not overwrite another
 459              * existing one
 460              */
 461             FlowEntryInstall sameMatchEntry = installedSwView.get(installEntry);
 462             if (sameMatchEntry != null && !sameMatchEntry.getOriginal().equals(currentFlowEntry)) {
 463                 log.info("Modify: new container flow merged flow entry clashes with existing flow");
 464                 decouple = true;
 465             } else {
 466                 toInstallSafe.add(installEntry);
 467             }
 468         }
 469
 470         if (decouple) {
 471             // Remove current entries
 472             for (FlowEntryInstall currEntry : installedList) {
 473                 this.removeEntryInternal(currEntry, async);
 474             }
 475             // Install new entries
 476             for (FlowEntryInstall newEntry : toInstallSafe) {
 477                 succeeded = this.addEntriesInternal(newEntry, async);
 478             }
 479         } else {
 480             /*
 481              * The two list have the same size and the entries to install do not
 482              * clash with any existing flow on the network node. We assume here
 483              * (and might be wrong) that the same container flows that were
 484              * satisfied by the current entries are the same that are satisfied
 485              * by the new entries. Let's take the risk for now.
 486              *
 487              * Note: modification has to be complete. If any entry modification
 488              * fails, we need to stop, restore the already modified entries, and
 489              * declare failure.
 490              */
 491             Status retModify = null;
 492             int i = 0;
 493             int size = toInstallList.size();
 494             while (i < size) {
 495                 // Modify and update database
 496                 retModify = modifyEntryInternal(installedList.get(i), toInstallList.get(i), async);
 497                 if (retModify.isSuccess()) {
 498                     i++;
 499                 } else {
 500                     break;
 501                 }
 502             }
 503             // Check if uncompleted modify
 504             if (i < size) {
 505                 log.warn("Unable to perform a complete modify for all  the container flows merged entries");
 506                 // Restore original entries
 507                 int j = 0;
 508                 while (j < i) {
 509                     log.info("Attempting to restore initial entries");
 510                     retExt = modifyEntryInternal(toInstallList.get(i), installedList.get(i), async);
 511                     if (retExt.isSuccess()) {
 512                         j++;
 513                     } else {
 514                         break;
 515                     }
 516                 }
 517                 // Fatal error, recovery failed
 518                 if (j < i) {
 519                     String msg = "Flow recovery failed ! Unrecoverable Error";
 520                     log.error(msg);
 521                     return new Status(StatusCode.INTERNALERROR, msg);
 522                 }
 523             }
 524             succeeded = retModify;
 525         }
 526         /*
 527          * The first successful status response will be returned. For the
 528          * asynchronous call, we can discard the container flow complication for
 529          * now and assume we will always deal with one flow only per request
 530          */
 531         return succeeded;
 532     }
 533
 534     /**
 535      * This is the function that modifies the final container flows merged
 536      * entries on the network node and update the database. It expects that all
 537      * the validity checks are passed
 538      *
 539      * @param currentEntries
 540      * @param newEntries
 541      * @param async
 542      *            the flag indicating if this is a asynchronous request
 543      * @return the status of this request. In case of asynchronous call, it will
 544      *         contain the unique id assigned to this request
 545      */
 546     private Status modifyEntryInternal(FlowEntryInstall currentEntries, FlowEntryInstall newEntries, boolean async) {
 547         FlowEntryDistributionOrderFutureTask futureStatus =
 548                 distributeWorkOrder(currentEntries, newEntries, UpdateType.CHANGED);
 549         if (futureStatus != null) {
 550             Status retStatus = new Status(StatusCode.UNDEFINED);
 551             try {
 552                 retStatus = futureStatus.get();
 553                 if (retStatus.getCode()
 554                         .equals(StatusCode.TIMEOUT)) {
 555                     // A timeout happened, lets cleanup the workMonitor
 556                     workMonitor.remove(futureStatus.getOrder());
 557                 }
 558             } catch (InterruptedException e) {
 559                 log.error("", e);
 560             } catch (ExecutionException e) {
 561                 log.error("", e);
 562             }
 563             return retStatus;
 564         } else {
 565             // Modify the flow on the network node
 566             Status status = async ? programmer.modifyFlowAsync(currentEntries.getNode(), currentEntries.getInstall()
 567                     .getFlow(), newEntries.getInstall()
 568                     .getFlow()) : programmer.modifyFlow(currentEntries.getNode(), currentEntries.getInstall()
 569                     .getFlow(), newEntries.getInstall()
 570                     .getFlow());
 571
 572             if (!status.isSuccess()) {
 573                 log.warn("SDN Plugin failed to program the flow: {}. The failure is: {}", newEntries.getInstall(),
 574                         status.getDescription());
 575                 return status;
 576             }
 577
 578             log.trace("Modified {} => {}", currentEntries.getInstall(), newEntries.getInstall());
 579
 580             // Update DB
 581             newEntries.setRequestId(status.getRequestId());
 582             updateLocalDatabase(currentEntries, false);
 583             updateLocalDatabase(newEntries, true);
 584
 585             return status;
 586         }
 587     }
 588
 589     /**
 590      * Remove a flow entry. If the entry is not present in the software view
 591      * (entry or node not present), it return successfully
 592      *
 593      * @param flowEntry
 594      *            the flow entry to remove
 595      * @param async
 596      *            the flag indicating if this is a asynchronous request
 597      * @return the status of this request. In case of asynchronous call, it will
 598      *         contain the unique id assigned to this request
 599      */
 600     private Status removeEntry(FlowEntry flowEntry, boolean async) {
 601         Status error = new Status(null, null);
 602
 603         // Sanity Check
 604         if (flowEntry == null || flowEntry.getNode() == null) {
 605             String msg = "Invalid FlowEntry";
 606             String logMsg = msg + ": {}";
 607             log.warn(logMsg, flowEntry);
 608             return new Status(StatusCode.NOTACCEPTABLE, msg);
 609         }
 610
 611         // Derive the container flows merged installed entries
 612         List<FlowEntryInstall> installedList = deriveInstallEntries(flowEntry.clone(), container.getContainerFlows());
 613
 614         Status succeeded = null;
 615         boolean atLeastOneRemoved = false;
 616         for (FlowEntryInstall entry : installedList) {
 617             if (!installedSwView.containsKey(entry)) {
 618                 String logMsg = "Removal skipped (not present in software view) for flow entry: {}";
 619                 log.debug(logMsg, flowEntry);
 620                 if (installedList.size() == 1) {
 621                     // If we had only one entry to remove, we are done
 622                     return new Status(StatusCode.SUCCESS);
 623                 } else {
 624                     continue;
 625                 }
 626             }
 627
 628             // Remove and update DB
 629             Status ret = removeEntryInternal(entry, async);
 630
 631             if (!ret.isSuccess()) {
 632                 error = ret;
 633                 log.warn("Failed to remove the entry: {}. The failure is: {}", entry.getInstall(), ret.getDescription());
 634                 if (installedList.size() == 1) {
 635                     // If we had only one entry to remove, this is fatal failure
 636                     return error;
 637                 }
 638             } else {
 639                 succeeded = ret;
 640                 atLeastOneRemoved = true;
 641             }
 642         }
 643
 644         /*
 645          * No worries if full removal failed. Consistency checker will take care
 646          * of removing the stale entries later, or adjusting the software
 647          * database if not in sync with hardware
 648          */
 649         return (atLeastOneRemoved) ? succeeded : error;
 650     }
 651
 652     /**
 653      * This is the function that removes the final container flows merged entry
 654      * from the network node and update the database. It expects that all the
 655      * validity checks are passed
 656      *
 657      * @param entry
 658      *            the flow entry to remove
 659      * @param async
 660      *            the flag indicating if this is a asynchronous request
 661      * @return the status of this request. In case of asynchronous call, it will
 662      *         contain the unique id assigned to this request
 663      */
 664     private Status removeEntryInternal(FlowEntryInstall entry, boolean async) {
 665         FlowEntryDistributionOrderFutureTask futureStatus = distributeWorkOrder(entry, null, UpdateType.REMOVED);
 666         if (futureStatus != null) {
 667             Status retStatus = new Status(StatusCode.UNDEFINED);
 668             try {
 669                 retStatus = futureStatus.get();
 670                 if (retStatus.getCode()
 671                         .equals(StatusCode.TIMEOUT)) {
 672                     // A timeout happened, lets cleanup the workMonitor
 673                     workMonitor.remove(futureStatus.getOrder());
 674                 }
 675             } catch (InterruptedException e) {
 676                 log.error("", e);
 677             } catch (ExecutionException e) {
 678                 log.error("", e);
 679             }
 680             return retStatus;
 681         } else {
 682             // Mark the entry to be deleted (for CC just in case we fail)
 683             entry.toBeDeleted();
 684
 685             // Remove from node
 686             Status status = async ? programmer.removeFlowAsync(entry.getNode(), entry.getInstall()
 687                     .getFlow()) : programmer.removeFlow(entry.getNode(), entry.getInstall()
 688                     .getFlow());
 689
 690             if (!status.isSuccess()) {
 691                 log.warn("SDN Plugin failed to program the flow: {}. The failure is: {}", entry.getInstall(),
 692                         status.getDescription());
 693                 return status;
 694             }
 695             log.trace("Removed  {}", entry.getInstall());
 696
 697             // Update DB
 698             updateLocalDatabase(entry, false);
 699
 700             return status;
 701         }
 702     }
 703
 704     /**
 705      * This is the function that installs the final container flow merged entry
 706      * on the network node and updates the database. It expects that all the
 707      * validity and conflict checks are passed. That means it does not check
 708      * whether this flow would conflict or overwrite an existing one.
 709      *
 710      * @param entry
 711      *            the flow entry to install
 712      * @param async
 713      *            the flag indicating if this is a asynchronous request
 714      * @return the status of this request. In case of asynchronous call, it will
 715      *         contain the unique id assigned to this request
 716      */
 717     private Status addEntriesInternal(FlowEntryInstall entry, boolean async) {
 718         FlowEntryDistributionOrderFutureTask futureStatus = distributeWorkOrder(entry, null, UpdateType.ADDED);
 719         if (futureStatus != null) {
 720             Status retStatus = new Status(StatusCode.UNDEFINED);
 721             try {
 722                 retStatus = futureStatus.get();
 723                 if (retStatus.getCode()
 724                         .equals(StatusCode.TIMEOUT)) {
 725                     // A timeout happened, lets cleanup the workMonitor
 726                     workMonitor.remove(futureStatus.getOrder());
 727                 }
 728             } catch (InterruptedException e) {
 729                 log.error("", e);
 730             } catch (ExecutionException e) {
 731                 log.error("", e);
 732             }
 733             return retStatus;
 734         } else {
 735             // Install the flow on the network node
 736             Status status = async ? programmer.addFlowAsync(entry.getNode(), entry.getInstall()
 737                     .getFlow()) : programmer.addFlow(entry.getNode(), entry.getInstall()
 738                     .getFlow());
 739
 740             if (!status.isSuccess()) {
 741                 log.warn("SDN Plugin failed to program the flow: {}. The failure is: {}", entry.getInstall(),
 742                         status.getDescription());
 743                 return status;
 744             }
 745
 746             log.trace("Added    {}", entry.getInstall());
 747
 748             // Update DB
 749             entry.setRequestId(status.getRequestId());
 750             updateLocalDatabase(entry, true);
 751
 752             return status;
 753         }
 754     }
 755
 756     /**
 757      * Returns true if the flow conflicts with all the container's flows. This
 758      * means that if the function returns true, the passed flow entry is
 759      * congruent with at least one container flow, hence it is good to be
 760      * installed on this container.
 761      *
 762      * @param flowEntry
 763      * @return true if flow conflicts with all the container flows, false
 764      *         otherwise
 765      */
 766     private boolean entryConflictsWithContainerFlows(FlowEntry flowEntry) {
 767         List<ContainerFlow> cFlowList = container.getContainerFlows();
 768
 769         // Validity check and avoid unnecessary computation
 770         // Also takes care of default container where no container flows are
 771         // present
 772         if (cFlowList == null || cFlowList.isEmpty()) {
 773             return false;
 774         }
 775
 776         for (ContainerFlow cFlow : cFlowList) {
 777             if (cFlow.allowsFlow(flowEntry.getFlow())) {
 778                 // Entry is allowed by at least one container flow: good to go
 779                 return false;
 780             }
 781         }
 782         return true;
 783     }
 784
 785     private ConcurrentMap.Entry<Integer, FlowConfig> getStaticFlowEntry(String name, Node node) {
 786         for (ConcurrentMap.Entry<Integer, FlowConfig> flowEntry : staticFlows.entrySet()) {
 787             FlowConfig flowConfig = flowEntry.getValue();
 788             if (flowConfig.isByNameAndNodeIdEqual(name, node)) {
 789                 return flowEntry;
 790             }
 791         }
 792         return null;
 793     }
 794
 795     private void updateLocalDatabase(FlowEntryInstall entry, boolean add) {
 796         // Update the software view
 797         updateSwViewes(entry, add);
 798
 799         // Update node indexed flow database
 800         updateNodeFlowsDB(entry, add);
 801
 802         // Update group indexed flow database
 803         updateGroupFlowsDB(entry, add);
 804     }
 805
 806     /*
 807      * Update the node mapped flows database
 808      */
 809     private void updateSwViewes(FlowEntryInstall flowEntries, boolean add) {
 810         if (add) {
 811             originalSwView.put(flowEntries.getOriginal(), flowEntries.getOriginal());
 812             installedSwView.put(flowEntries, flowEntries);
 813         } else {
 814             originalSwView.remove(flowEntries.getOriginal());
 815             installedSwView.remove(flowEntries);
 816         }
 817     }
 818
 819     /*
 820      * Update the node mapped flows database
 821      */
 822     private void updateNodeFlowsDB(FlowEntryInstall flowEntries, boolean add) {
 823         Node node = flowEntries.getNode();
 824
 825         List<FlowEntryInstall> nodeIndeces = this.nodeFlows.get(node);
 826         if (nodeIndeces == null) {
 827             if (!add) {
 828                 return;
 829             } else {
 830                 nodeIndeces = new ArrayList<FlowEntryInstall>();
 831             }
 832         }
 833
 834         if (add) {
 835             nodeIndeces.add(flowEntries);
 836         } else {
 837             nodeIndeces.remove(flowEntries);
 838         }
 839
 840         // Update cache across cluster
 841         if (nodeIndeces.isEmpty()) {
 842             this.nodeFlows.remove(node);
 843         } else {
 844             this.nodeFlows.put(node, nodeIndeces);
 845         }
 846     }
 847
 848     /*
 849      * Update the group name mapped flows database
 850      */
 851     private void updateGroupFlowsDB(FlowEntryInstall flowEntries, boolean add) {
 852         String groupName = flowEntries.getGroupName();
 853
 854         // Flow may not be part of a group
 855         if (groupName == null) {
 856             return;
 857         }
 858
 859         List<FlowEntryInstall> indices = this.groupFlows.get(groupName);
 860         if (indices == null) {
 861             if (!add) {
 862                 return;
 863             } else {
 864                 indices = new ArrayList<FlowEntryInstall>();
 865             }
 866         }
 867
 868         if (add) {
 869             indices.add(flowEntries);
 870         } else {
 871             indices.remove(flowEntries);
 872         }
 873
 874         // Update cache across cluster
 875         if (indices.isEmpty()) {
 876             this.groupFlows.remove(groupName);
 877         } else {
 878             this.groupFlows.put(groupName, indices);
 879         }
 880     }
 881
 882     /**
 883      * Remove a flow entry that has been added previously First checks if the
 884      * entry is effectively present in the local database
 885      */
 886     @SuppressWarnings("unused")
 887     private Status removeEntry(Node node, String flowName) {
 888         FlowEntryInstall target = null;
 889
 890         // Find in database
 891         for (FlowEntryInstall entry : installedSwView.values()) {
 892             if (entry.equalsByNodeAndName(node, flowName)) {
 893                 target = entry;
 894                 break;
 895             }
 896         }
 897
 898         // If it is not there, stop any further processing
 899         if (target == null) {
 900             return new Status(StatusCode.SUCCESS, "Entry is not present");
 901         }
 902
 903         // Remove from node
 904         Status status = programmer.removeFlow(target.getNode(), target.getInstall().getFlow());
 905
 906         // Update DB
 907         if (status.isSuccess()) {
 908             updateLocalDatabase(target, false);
 909         } else {
 910             // log the error
 911             log.warn("SDN Plugin failed to remove the flow: {}. The failure is: {}", target.getInstall(),
 912                     status.getDescription());
 913         }
 914
 915         return status;
 916     }
 917
 918     @Override
 919     public Status installFlowEntry(FlowEntry flowEntry) {
 920         Status status;
 921         if (isContainerModeAllowed(flowEntry)) {
 922             status = addEntry(flowEntry, false);
 923         } else {
 924             String msg = "Controller in container mode: Install Refused";
 925             String logMsg = msg + ": {}";
 926             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 927             log.warn(logMsg, flowEntry);
 928         }
 929         return status;
 930     }
 931
 932     @Override
 933     public Status installFlowEntryAsync(FlowEntry flowEntry) {
 934         Status status;
 935         if (isContainerModeAllowed(flowEntry)) {
 936             status = addEntry(flowEntry, true);
 937         } else {
 938             String msg = "Controller in container mode: Install Refused";
 939             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 940             log.warn(msg);
 941         }
 942         return status;
 943     }
 944
 945     @Override
 946     public Status uninstallFlowEntry(FlowEntry flowEntry) {
 947         Status status;
 948         if (isContainerModeAllowed(flowEntry)) {
 949             status = removeEntry(flowEntry, false);
 950         } else {
 951             String msg = "Controller in container mode: Uninstall Refused";
 952             String logMsg = msg + ": {}";
 953             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 954             log.warn(logMsg, flowEntry);
 955         }
 956         return status;
 957     }
 958
 959     @Override
 960     public Status uninstallFlowEntryAsync(FlowEntry flowEntry) {
 961         Status status;
 962         if (isContainerModeAllowed(flowEntry)) {
 963             status = removeEntry(flowEntry, true);
 964         } else {
 965             String msg = "Controller in container mode: Uninstall Refused";
 966             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 967             log.warn(msg);
 968         }
 969         return status;
 970     }
 971
 972     @Override
 973     public Status modifyFlowEntry(FlowEntry currentFlowEntry, FlowEntry newFlowEntry) {
 974         Status status = null;
 975         if (isContainerModeAllowed(currentFlowEntry)) {
 976             status = modifyEntry(currentFlowEntry, newFlowEntry, false);
 977         } else {
 978             String msg = "Controller in container mode: Modify Refused";
 979             String logMsg = msg + ": {}";
 980             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 981             log.warn(logMsg, newFlowEntry);
 982         }
 983         return status;
 984     }
 985
 986     @Override
 987     public Status modifyFlowEntryAsync(FlowEntry currentFlowEntry, FlowEntry newFlowEntry) {
 988         Status status = null;
 989         if (isContainerModeAllowed(currentFlowEntry)) {
 990             status = modifyEntry(currentFlowEntry, newFlowEntry, true);
 991         } else {
 992             String msg = "Controller in container mode: Modify Refused";
 993             status = new Status(StatusCode.NOTACCEPTABLE, msg);
 994             log.warn(msg);
 995         }
 996         return status;
 997     }
 998
 999     /**
1000      * Returns whether the specified flow entry is allowed to be
1001      * installed/removed/modified based on the current container mode status.
1002      * This call always returns true in the container instance of forwarding
1003      * rules manager. It is meant for the global instance only (default
1004      * container) of forwarding rules manager. Idea is that for assuring
1005      * container isolation of traffic, flow installation in default container is
1006      * blocked when in container mode (containers are present). The only flows
1007      * that are allowed in container mode in the default container are the
1008      * proactive flows, the ones automatically installed on the network node
1009      * which forwarding mode has been configured to "proactive". These flows are
1010      * needed by controller to discover the nodes topology and to discover the
1011      * attached hosts for some SDN switches.
1012      *
1013      * @param flowEntry
1014      *            The flow entry to be installed/removed/modified
1015      * @return true if not in container mode or if flowEntry is internally
1016      *         generated
1017      */
1018     private boolean isContainerModeAllowed(FlowEntry flowEntry) {
1019         return (!inContainerMode) ? true : flowEntry.isInternal();
1020     }
1021
1022     @Override
1023     public Status modifyOrAddFlowEntry(FlowEntry newFlowEntry) {
1024         /*
1025          * Run a check on the original entries to decide whether to go with a
1026          * add or modify method. A loose check means only check against the
1027          * original flow entry requests and not against the installed flow
1028          * entries which are the result of the original entry merged with the
1029          * container flow(s) (if any). The modifyFlowEntry method in presence of
1030          * conflicts with the Container flows (if any) would revert back to a
1031          * delete + add pattern
1032          */
1033         FlowEntry currentFlowEntry = originalSwView.get(newFlowEntry);
1034
1035         if (currentFlowEntry != null) {
1036             return modifyFlowEntry(currentFlowEntry, newFlowEntry);
1037         } else {
1038             return installFlowEntry(newFlowEntry);
1039         }
1040     }
1041
1042     @Override
1043     public Status modifyOrAddFlowEntryAsync(FlowEntry newFlowEntry) {
1044         /*
1045          * Run a check on the original entries to decide whether to go with a
1046          * add or modify method. A loose check means only check against the
1047          * original flow entry requests and not against the installed flow
1048          * entries which are the result of the original entry merged with the
1049          * container flow(s) (if any). The modifyFlowEntry method in presence of
1050          * conflicts with the Container flows (if any) would revert back to a
1051          * delete + add pattern
1052          */
1053         FlowEntry currentFlowEntry = originalSwView.get(newFlowEntry);
1054
1055         if (currentFlowEntry != null) {
1056             return modifyFlowEntryAsync(currentFlowEntry, newFlowEntry);
1057         } else {
1058             return installFlowEntryAsync(newFlowEntry);
1059         }
1060     }
1061
1062     @Override
1063     public Status uninstallFlowEntryGroup(String groupName) {
1064         if (groupName == null || groupName.isEmpty()) {
1065             return new Status(StatusCode.BADREQUEST, "Invalid group name");
1066         }
1067         if (groupName.equals(FlowConfig.INTERNALSTATICFLOWGROUP)) {
1068             return new Status(StatusCode.BADREQUEST, "Internal static flows group cannot be deleted through this api");
1069         }
1070         if (inContainerMode) {
1071             String msg = "Controller in container mode: Group Uninstall Refused";
1072             String logMsg = msg + ": {}";
1073             log.warn(logMsg, groupName);
1074             return new Status(StatusCode.NOTACCEPTABLE, msg);
1075         }
1076         int toBeRemoved = 0;
1077         String error = "";
1078         if (groupFlows.containsKey(groupName)) {
1079             List<FlowEntryInstall> list = new ArrayList<FlowEntryInstall>(groupFlows.get(groupName));
1080             toBeRemoved = list.size();
1081             for (FlowEntryInstall entry : list) {
1082                 Status status = this.removeEntry(entry.getOriginal(), false);
1083                 if (status.isSuccess()) {
1084                     toBeRemoved -= 1;
1085                 } else {
1086                     error = status.getDescription();
1087                 }
1088             }
1089         }
1090         return (toBeRemoved == 0) ? new Status(StatusCode.SUCCESS) : new Status(StatusCode.INTERNALERROR,
1091                 "Not all the flows were removed: " + error);
1092     }
1093
1094     @Override
1095     public Status uninstallFlowEntryGroupAsync(String groupName) {
1096         if (groupName == null || groupName.isEmpty()) {
1097             return new Status(StatusCode.BADREQUEST, "Invalid group name");
1098         }
1099         if (groupName.equals(FlowConfig.INTERNALSTATICFLOWGROUP)) {
1100             return new Status(StatusCode.BADREQUEST, "Static flows group cannot be deleted through this api");
1101         }
1102         if (inContainerMode) {
1103             String msg = "Controller in container mode: Group Uninstall Refused";
1104             String logMsg = msg + ": {}";
1105             log.warn(logMsg, groupName);
1106             return new Status(StatusCode.NOTACCEPTABLE, msg);
1107         }
1108         if (groupFlows.containsKey(groupName)) {
1109             List<FlowEntryInstall> list = new ArrayList<FlowEntryInstall>(groupFlows.get(groupName));
1110             for (FlowEntryInstall entry : list) {
1111                 this.removeEntry(entry.getOriginal(), true);
1112             }
1113         }
1114         return new Status(StatusCode.SUCCESS);
1115     }
1116
1117     @Override
1118     public boolean checkFlowEntryConflict(FlowEntry flowEntry) {
1119         return entryConflictsWithContainerFlows(flowEntry);
1120     }
1121
1122     /**
1123      * Updates all installed flows because the container flow got updated This
1124      * is obtained in two phases on per node basis: 1) Uninstall of all flows 2)
1125      * Reinstall of all flows This is needed because a new container flows
1126      * merged flow may conflict with an existing old container flows merged flow
1127      * on the network node
1128      */
1129     private void updateFlowsContainerFlow() {
1130         Set<FlowEntry> toReInstall = new HashSet<FlowEntry>();
1131         // First remove all installed entries
1132         for (ConcurrentMap.Entry<FlowEntryInstall, FlowEntryInstall> entry : installedSwView.entrySet()) {
1133             FlowEntryInstall current = entry.getValue();
1134             // Store the original entry
1135             toReInstall.add(current.getOriginal());
1136             // Remove the old couples. No validity checks to be run, use the
1137             // internal remove
1138             this.removeEntryInternal(current, false);
1139         }
1140         // Then reinstall the original entries
1141         for (FlowEntry entry : toReInstall) {
1142             // Reinstall the original flow entries, via the regular path: new
1143             // cFlow merge + validations
1144             this.installFlowEntry(entry);
1145         }
1146     }
1147
1148     private void nonClusterObjectCreate() {
1149         originalSwView = new ConcurrentHashMap<FlowEntry, FlowEntry>();
1150         installedSwView = new ConcurrentHashMap<FlowEntryInstall, FlowEntryInstall>();
1151         nodeFlows = new ConcurrentHashMap<Node, List<FlowEntryInstall>>();
1152         groupFlows = new ConcurrentHashMap<String, List<FlowEntryInstall>>();
1153         TSPolicies = new ConcurrentHashMap<String, Object>();
1154         staticFlowsOrdinal = new ConcurrentHashMap<Integer, Integer>();
1155         portGroupConfigs = new ConcurrentHashMap<String, PortGroupConfig>();
1156         portGroupData = new ConcurrentHashMap<PortGroupConfig, Map<Node, PortGroup>>();
1157         staticFlows = new ConcurrentHashMap<Integer, FlowConfig>();
1158         inactiveFlows = new ConcurrentHashMap<FlowEntry, FlowEntry>();
1159     }
1160
1161     private void registerWithOSGIConsole() {
1162         BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass()).getBundleContext();
1163         bundleContext.registerService(CommandProvider.class.getName(), this, null);
1164     }
1165
1166     @Override
1167     public void setTSPolicyData(String policyname, Object o, boolean add) {
1168
1169         if (add) {
1170             /* Check if this policy already exists */
1171             if (!(TSPolicies.containsKey(policyname))) {
1172                 TSPolicies.put(policyname, o);
1173             }
1174         } else {
1175             TSPolicies.remove(policyname);
1176         }
1177         if (frmAware != null) {
1178             synchronized (frmAware) {
1179                 for (IForwardingRulesManagerAware frma : frmAware) {
1180                     try {
1181                         frma.policyUpdate(policyname, add);
1182                     } catch (Exception e) {
1183                         log.warn("Exception on callback", e);
1184                     }
1185                 }
1186             }
1187         }
1188     }
1189
1190     @Override
1191     public Map<String, Object> getTSPolicyData() {
1192         return TSPolicies;
1193     }
1194
1195     @Override
1196     public Object getTSPolicyData(String policyName) {
1197         if (TSPolicies.containsKey(policyName)) {
1198             return TSPolicies.get(policyName);
1199         } else {
1200             return null;
1201         }
1202     }
1203
1204     @Override
1205     public List<FlowEntry> getFlowEntriesForGroup(String policyName) {
1206         List<FlowEntry> list = new ArrayList<FlowEntry>();
1207         if (policyName != null && !policyName.trim().isEmpty()) {
1208             for (Map.Entry<FlowEntry, FlowEntry> entry : this.originalSwView.entrySet()) {
1209                 if (policyName.equals(entry.getKey().getGroupName())) {
1210                     list.add(entry.getKey().clone());
1211                 }
1212             }
1213         }
1214         return list;
1215     }
1216
1217     @Override
1218     public List<FlowEntry> getInstalledFlowEntriesForGroup(String policyName) {
1219         List<FlowEntry> list = new ArrayList<FlowEntry>();
1220         if (policyName != null && !policyName.trim().isEmpty()) {
1221             for (Map.Entry<FlowEntryInstall, FlowEntryInstall> entry : this.installedSwView.entrySet()) {
1222                 if (policyName.equals(entry.getKey().getGroupName())) {
1223                     list.add(entry.getKey().getInstall().clone());
1224                 }
1225             }
1226         }
1227         return list;
1228     }
1229
1230     @Override
1231     public void addOutputPort(Node node, String flowName, List<NodeConnector> portList) {
1232
1233         for (FlowEntryInstall flow : this.nodeFlows.get(node)) {
1234             if (flow.getFlowName().equals(flowName)) {
1235                 FlowEntry currentFlowEntry = flow.getOriginal();
1236                 FlowEntry newFlowEntry = currentFlowEntry.clone();
1237                 for (NodeConnector dstPort : portList) {
1238                     newFlowEntry.getFlow().addAction(new Output(dstPort));
1239                 }
1240                 Status error = modifyEntry(currentFlowEntry, newFlowEntry, false);
1241                 if (error.isSuccess()) {
1242                     log.info("Ports {} added to FlowEntry {}", portList, flowName);
1243                 } else {
1244                     log.warn("Failed to add ports {} to Flow entry {}. The failure is: {}", portList,
1245                             currentFlowEntry.toString(), error.getDescription());
1246                 }
1247                 return;
1248             }
1249         }
1250         log.warn("Failed to add ports to Flow {} on Node {}: Entry Not Found", flowName, node);
1251     }
1252
1253     @Override
1254     public void removeOutputPort(Node node, String flowName, List<NodeConnector> portList) {
1255         for (FlowEntryInstall index : this.nodeFlows.get(node)) {
1256             FlowEntryInstall flow = this.installedSwView.get(index);
1257             if (flow.getFlowName().equals(flowName)) {
1258                 FlowEntry currentFlowEntry = flow.getOriginal();
1259                 FlowEntry newFlowEntry = currentFlowEntry.clone();
1260                 for (NodeConnector dstPort : portList) {
1261                     Action action = new Output(dstPort);
1262                     newFlowEntry.getFlow().removeAction(action);
1263                 }
1264                 Status status = modifyEntry(currentFlowEntry, newFlowEntry, false);
1265                 if (status.isSuccess()) {
1266                     log.info("Ports {} removed from FlowEntry {}", portList, flowName);
1267                 } else {
1268                     log.warn("Failed to remove ports {} from Flow entry {}. The failure is: {}", portList,
1269                             currentFlowEntry.toString(), status.getDescription());
1270                 }
1271                 return;
1272             }
1273         }
1274         log.warn("Failed to remove ports from Flow {} on Node {}: Entry Not Found", flowName, node);
1275     }
1276
1277     /*
1278      * This function assumes the target flow has only one output port
1279      */
1280     @Override
1281     public void replaceOutputPort(Node node, String flowName, NodeConnector outPort) {
1282         FlowEntry currentFlowEntry = null;
1283         FlowEntry newFlowEntry = null;
1284
1285         // Find the flow
1286         for (FlowEntryInstall index : this.nodeFlows.get(node)) {
1287             FlowEntryInstall flow = this.installedSwView.get(index);
1288             if (flow.getFlowName().equals(flowName)) {
1289                 currentFlowEntry = flow.getOriginal();
1290                 break;
1291             }
1292         }
1293         if (currentFlowEntry == null) {
1294             log.warn("Failed to replace output port for flow {} on node {}: Entry Not Found", flowName, node);
1295             return;
1296         }
1297
1298         // Create a flow copy with the new output port
1299         newFlowEntry = currentFlowEntry.clone();
1300         Action target = null;
1301         for (Action action : newFlowEntry.getFlow().getActions()) {
1302             if (action.getType() == ActionType.OUTPUT) {
1303                 target = action;
1304                 break;
1305             }
1306         }
1307         newFlowEntry.getFlow().removeAction(target);
1308         newFlowEntry.getFlow().addAction(new Output(outPort));
1309
1310         // Modify on network node
1311         Status status = modifyEntry(currentFlowEntry, newFlowEntry, false);
1312
1313         if (status.isSuccess()) {
1314             log.info("Output port replaced with {} for flow {} on node {}", outPort, flowName, node);
1315         } else {
1316             log.warn("Failed to replace output port for flow {} on node {}. The failure is: {}", flowName, node,
1317                     status.getDescription());
1318         }
1319         return;
1320     }
1321
1322     @Override
1323     public NodeConnector getOutputPort(Node node, String flowName) {
1324         for (FlowEntryInstall index : this.nodeFlows.get(node)) {
1325             FlowEntryInstall flow = this.installedSwView.get(index);
1326             if (flow.getFlowName().equals(flowName)) {
1327                 for (Action action : flow.getOriginal().getFlow().getActions()) {
1328                     if (action.getType() == ActionType.OUTPUT) {
1329                         return ((Output) action).getPort();
1330                     }
1331                 }
1332             }
1333         }
1334         return null;
1335     }
1336
1337     private void cacheStartup() {
1338         allocateCaches();
1339         retrieveCaches();
1340     }
1341
1342     private void allocateCaches() {
1343         if (this.clusterContainerService == null) {
1344             log.warn("Un-initialized clusterContainerService, can't create cache");
1345             return;
1346         }
1347
1348         log.debug("Allocating caches for Container {}", container.getName());
1349
1350         try {
1351             clusterContainerService.createCache("frm.originalSwView",
1352                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1353
1354             clusterContainerService.createCache("frm.installedSwView",
1355                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1356
1357             clusterContainerService.createCache("frm.inactiveFlows",
1358                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1359
1360             clusterContainerService.createCache("frm.nodeFlows",
1361                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1362
1363             clusterContainerService.createCache("frm.groupFlows",
1364                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1365
1366             clusterContainerService.createCache("frm.staticFlows",
1367                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1368
1369             clusterContainerService.createCache("frm.flowsSaveEvent",
1370                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1371
1372             clusterContainerService.createCache("frm.staticFlowsOrdinal",
1373                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1374
1375             clusterContainerService.createCache("frm.portGroupConfigs",
1376                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1377
1378             clusterContainerService.createCache("frm.portGroupData",
1379                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1380
1381             clusterContainerService.createCache("frm.TSPolicies",
1382                     EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
1383
1384             clusterContainerService.createCache(WORKSTATUSCACHE,
1385  EnumSet.of(IClusterServices.cacheMode.NON_TRANSACTIONAL));
1386
1387             clusterContainerService.createCache(WORKORDERCACHE,
1388  EnumSet.of(IClusterServices.cacheMode.NON_TRANSACTIONAL));
1389
1390         } catch (CacheConfigException cce) {
1391             log.error("CacheConfigException");
1392         } catch (CacheExistException cce) {
1393             log.error("CacheExistException");
1394         }
1395     }
1396
1397     @SuppressWarnings({ "unchecked" })
1398     private void retrieveCaches() {
1399         ConcurrentMap<?, ?> map;
1400
1401         if (this.clusterContainerService == null) {
1402             log.warn("un-initialized clusterContainerService, can't retrieve cache");
1403             nonClusterObjectCreate();
1404             return;
1405         }
1406
1407         log.debug("Retrieving Caches for Container {}", container.getName());
1408
1409         map = clusterContainerService.getCache("frm.originalSwView");
1410         if (map != null) {
1411             originalSwView = (ConcurrentMap<FlowEntry, FlowEntry>) map;
1412         } else {
1413             log.error("Retrieval of frm.originalSwView cache failed for Container {}", container.getName());
1414         }
1415
1416         map = clusterContainerService.getCache("frm.installedSwView");
1417         if (map != null) {
1418             installedSwView = (ConcurrentMap<FlowEntryInstall, FlowEntryInstall>) map;
1419         } else {
1420             log.error("Retrieval of frm.installedSwView cache failed for Container {}", container.getName());
1421         }
1422
1423         map = clusterContainerService.getCache("frm.inactiveFlows");
1424         if (map != null) {
1425             inactiveFlows = (ConcurrentMap<FlowEntry, FlowEntry>) map;
1426         } else {
1427             log.error("Retrieval of frm.inactiveFlows cache failed for Container {}", container.getName());
1428         }
1429
1430         map = clusterContainerService.getCache("frm.nodeFlows");
1431         if (map != null) {
1432             nodeFlows = (ConcurrentMap<Node, List<FlowEntryInstall>>) map;
1433         } else {
1434             log.error("Retrieval of cache failed for Container {}", container.getName());
1435         }
1436
1437         map = clusterContainerService.getCache("frm.groupFlows");
1438         if (map != null) {
1439             groupFlows = (ConcurrentMap<String, List<FlowEntryInstall>>) map;
1440         } else {
1441             log.error("Retrieval of frm.groupFlows cache failed for Container {}", container.getName());
1442         }
1443
1444         map = clusterContainerService.getCache("frm.staticFlows");
1445         if (map != null) {
1446             staticFlows = (ConcurrentMap<Integer, FlowConfig>) map;
1447         } else {
1448             log.error("Retrieval of frm.staticFlows cache failed for Container {}", container.getName());
1449         }
1450
1451         map = clusterContainerService.getCache("frm.staticFlowsOrdinal");
1452         if (map != null) {
1453             staticFlowsOrdinal = (ConcurrentMap<Integer, Integer>) map;
1454         } else {
1455             log.error("Retrieval of frm.staticFlowsOrdinal cache failed for Container {}", container.getName());
1456         }
1457
1458         map = clusterContainerService.getCache("frm.portGroupConfigs");
1459         if (map != null) {
1460             portGroupConfigs = (ConcurrentMap<String, PortGroupConfig>) map;
1461         } else {
1462             log.error("Retrieval of frm.portGroupConfigs cache failed for Container {}", container.getName());
1463         }
1464
1465         map = clusterContainerService.getCache("frm.portGroupData");
1466         if (map != null) {
1467             portGroupData = (ConcurrentMap<PortGroupConfig, Map<Node, PortGroup>>) map;
1468         } else {
1469             log.error("Retrieval of frm.portGroupData allocation failed for Container {}", container.getName());
1470         }
1471
1472         map = clusterContainerService.getCache("frm.TSPolicies");
1473         if (map != null) {
1474             TSPolicies = (ConcurrentMap<String, Object>) map;
1475         } else {
1476             log.error("Retrieval of frm.TSPolicies cache failed for Container {}", container.getName());
1477         }
1478
1479         map = clusterContainerService.getCache(WORKORDERCACHE);
1480         if (map != null) {
1481             workOrder = (ConcurrentMap<FlowEntryDistributionOrder, FlowEntryInstall>) map;
1482         } else {
1483             log.error("Retrieval of " + WORKORDERCACHE + " cache failed for Container {}", container.getName());
1484         }
1485
1486         map = clusterContainerService.getCache(WORKSTATUSCACHE);
1487         if (map != null) {
1488             workStatus = (ConcurrentMap<FlowEntryDistributionOrder, Status>) map;
1489         } else {
1490             log.error("Retrieval of " + WORKSTATUSCACHE + " cache failed for Container {}", container.getName());
1491         }
1492     }
1493
1494     private boolean flowConfigExists(FlowConfig config) {
1495         // Flow name has to be unique on per node id basis
1496         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1497             if (entry.getValue().isByNameAndNodeIdEqual(config)) {
1498                 return true;
1499             }
1500         }
1501         return false;
1502     }
1503
1504     @Override
1505     public Status addStaticFlow(FlowConfig config) {
1506         // Configuration object validation
1507         Status status = config.validate(container);
1508         if (!status.isSuccess()) {
1509             log.warn("Invalid Configuration for flow {}. The failure is {}", config, status.getDescription());
1510             String error = "Invalid Configuration (" + status.getDescription() + ")";
1511             config.setStatus(error);
1512             return new Status(StatusCode.BADREQUEST, error);
1513         }
1514         return addStaticFlowInternal(config, false);
1515     }
1516
1517     /**
1518      * Private method to add a static flow configuration which does not run any
1519      * validation on the passed FlowConfig object. If restore is set to true,
1520      * configuration is stored in configuration database regardless the
1521      * installation on the network node was successful. This is useful at boot
1522      * when static flows are present in startup configuration and are read
1523      * before the switches connects.
1524      *
1525      * @param config
1526      *            The static flow configuration
1527      * @param restore
1528      *            if true, the configuration is stored regardless the
1529      *            installation on the network node was successful
1530      * @return The status of this request
1531      */
1532     private Status addStaticFlowInternal(FlowConfig config, boolean restore) {
1533         boolean multipleFlowPush = false;
1534         String error;
1535         Status status;
1536         config.setStatus(SUCCESS);
1537
1538         // Presence check
1539         if (flowConfigExists(config)) {
1540             error = "Entry with this name on specified switch already exists";
1541             log.warn("Entry with this name on specified switch already exists: {}", config);
1542             config.setStatus(error);
1543             return new Status(StatusCode.CONFLICT, error);
1544         }
1545
1546         if ((config.getIngressPort() == null) && config.getPortGroup() != null) {
1547             for (String portGroupName : portGroupConfigs.keySet()) {
1548                 if (portGroupName.equalsIgnoreCase(config.getPortGroup())) {
1549                     multipleFlowPush = true;
1550                     break;
1551                 }
1552             }
1553             if (!multipleFlowPush) {
1554                 log.warn("Invalid Configuration(Invalid PortGroup Name) for flow {}", config);
1555                 error = "Invalid Configuration (Invalid PortGroup Name)";
1556                 config.setStatus(error);
1557                 return new Status(StatusCode.BADREQUEST, error);
1558             }
1559         }
1560
1561         /*
1562          * If requested program the entry in hardware first before updating the
1563          * StaticFlow DB
1564          */
1565         if (!multipleFlowPush) {
1566             // Program hw
1567             if (config.installInHw()) {
1568                 FlowEntry entry = config.getFlowEntry();
1569                 status = this.installFlowEntry(entry);
1570                 if (!status.isSuccess()) {
1571                     config.setStatus(status.getDescription());
1572                     if (!restore) {
1573                         return status;
1574                     }
1575                 }
1576             }
1577         }
1578
1579         /*
1580          * When the control reaches this point, either of the following
1581          * conditions is true 1. This is a single entry configuration (non
1582          * PortGroup) and the hardware installation is successful 2. This is a
1583          * multiple entry configuration (PortGroup) and hardware installation is
1584          * NOT done directly on this event. 3. The User prefers to retain the
1585          * configuration in Controller and skip hardware installation.
1586          *
1587          * Hence it is safe to update the StaticFlow DB at this point.
1588          *
1589          * Note : For the case of PortGrouping, it is essential to have this DB
1590          * populated before the PortGroupListeners can query for the DB
1591          * triggered using portGroupChanged event...
1592          */
1593         Integer ordinal = staticFlowsOrdinal.get(0);
1594         staticFlowsOrdinal.put(0, ++ordinal);
1595         staticFlows.put(ordinal, config);
1596
1597         if (multipleFlowPush) {
1598             PortGroupConfig pgconfig = portGroupConfigs.get(config.getPortGroup());
1599             Map<Node, PortGroup> existingData = portGroupData.get(pgconfig);
1600             if (existingData != null) {
1601                 portGroupChanged(pgconfig, existingData, true);
1602             }
1603         }
1604         return new Status(StatusCode.SUCCESS);
1605     }
1606
1607     private void addStaticFlowsToSwitch(Node node) {
1608         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1609             FlowConfig config = entry.getValue();
1610             if (config.isPortGroupEnabled()) {
1611                 continue;
1612             }
1613             if (config.getNode().equals(node)) {
1614                 if (config.installInHw() && !config.getStatus().equals(SUCCESS)) {
1615                     Status status = this.installFlowEntryAsync(config.getFlowEntry());
1616                     config.setStatus(status.getDescription());
1617                 }
1618             }
1619         }
1620         // Update cluster cache
1621         refreshClusterStaticFlowsStatus(node);
1622     }
1623
1624     private void updateStaticFlowConfigsOnNodeDown(Node node) {
1625         log.trace("Updating Static Flow configs on node down: {}", node);
1626
1627         List<Integer> toRemove = new ArrayList<Integer>();
1628         for (Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1629
1630             FlowConfig config = entry.getValue();
1631
1632             if (config.isPortGroupEnabled()) {
1633                 continue;
1634             }
1635
1636             if (config.installInHw() && config.getNode().equals(node)) {
1637                 if (config.isInternalFlow()) {
1638                     // Take note of this controller generated static flow
1639                     toRemove.add(entry.getKey());
1640                 } else {
1641                     config.setStatus(NODEDOWN);
1642                 }
1643             }
1644         }
1645         // Remove controller generated static flows for this node
1646         for (Integer index : toRemove) {
1647             staticFlows.remove(index);
1648         }
1649         // Update cluster cache
1650         refreshClusterStaticFlowsStatus(node);
1651
1652     }
1653
1654     private void updateStaticFlowConfigsOnContainerModeChange(UpdateType update) {
1655         log.trace("Updating Static Flow configs on container mode change: {}", update);
1656
1657         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1658             FlowConfig config = entry.getValue();
1659             if (config.isPortGroupEnabled()) {
1660                 continue;
1661             }
1662             if (config.installInHw() && !config.isInternalFlow()) {
1663                 switch (update) {
1664                 case ADDED:
1665                     config.setStatus("Removed from node because in container mode");
1666                     break;
1667                 case REMOVED:
1668                     config.setStatus(SUCCESS);
1669                     break;
1670                 default:
1671                 }
1672             }
1673         }
1674         // Update cluster cache
1675         refreshClusterStaticFlowsStatus(null);
1676     }
1677
1678     @Override
1679     public Status removeStaticFlow(FlowConfig config) {
1680         /*
1681          * No config.isInternal() check as NB does not take this path and GUI
1682          * cannot issue a delete on an internal generated flow. We need this
1683          * path to be accessible when switch mode is changed from proactive to
1684          * reactive, so that we can remove the internal generated LLDP and ARP
1685          * punt flows
1686          */
1687
1688         // Look for the target configuration entry
1689         Integer key = 0;
1690         FlowConfig target = null;
1691         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1692             if (entry.getValue().isByNameAndNodeIdEqual(config)) {
1693                 key = entry.getKey();
1694                 target = entry.getValue();
1695                 break;
1696             }
1697         }
1698         if (target == null) {
1699             return new Status(StatusCode.NOTFOUND, "Entry Not Present");
1700         }
1701
1702         // Program the network node
1703         Status status = this.uninstallFlowEntry(config.getFlowEntry());
1704
1705         // Update configuration database if programming was successful
1706         if (status.isSuccess()) {
1707             staticFlows.remove(key);
1708         }
1709
1710         return status;
1711     }
1712
1713     @Override
1714     public Status removeStaticFlow(String name, Node node) {
1715         // Look for the target configuration entry
1716         Integer key = 0;
1717         FlowConfig target = null;
1718         for (ConcurrentMap.Entry<Integer, FlowConfig> mapEntry : staticFlows.entrySet()) {
1719             if (mapEntry.getValue().isByNameAndNodeIdEqual(name, node)) {
1720                 key = mapEntry.getKey();
1721                 target = mapEntry.getValue();
1722                 break;
1723             }
1724         }
1725         if (target == null) {
1726             return new Status(StatusCode.NOTFOUND, "Entry Not Present");
1727         }
1728
1729         // Validity check for api3 entry point
1730         if (target.isInternalFlow()) {
1731             String msg = "Invalid operation: Controller generated flow cannot be deleted";
1732             String logMsg = msg + ": {}";
1733             log.warn(logMsg, name);
1734             return new Status(StatusCode.NOTACCEPTABLE, msg);
1735         }
1736
1737         if (target.isPortGroupEnabled()) {
1738             String msg = "Invalid operation: Port Group flows cannot be deleted through this API";
1739             String logMsg = msg + ": {}";
1740             log.warn(logMsg, name);
1741             return new Status(StatusCode.NOTACCEPTABLE, msg);
1742         }
1743
1744         // Program the network node
1745         Status status = this.removeEntry(target.getFlowEntry(), false);
1746
1747         // Update configuration database if programming was successful
1748         if (status.isSuccess()) {
1749             staticFlows.remove(key);
1750         }
1751
1752         return status;
1753     }
1754
1755     @Override
1756     public Status modifyStaticFlow(FlowConfig newFlowConfig) {
1757         // Validity check for api3 entry point
1758         if (newFlowConfig.isInternalFlow()) {
1759             String msg = "Invalid operation: Controller generated flow cannot be modified";
1760             String logMsg = msg + ": {}";
1761             log.warn(logMsg, newFlowConfig);
1762             return new Status(StatusCode.NOTACCEPTABLE, msg);
1763         }
1764
1765         // Validity Check
1766         Status status = newFlowConfig.validate(container);
1767         if (!status.isSuccess()) {
1768             String msg = "Invalid Configuration (" + status.getDescription() + ")";
1769             newFlowConfig.setStatus(msg);
1770             log.warn("Invalid Configuration for flow {}. The failure is {}", newFlowConfig, status.getDescription());
1771             return new Status(StatusCode.BADREQUEST, msg);
1772         }
1773
1774         FlowConfig oldFlowConfig = null;
1775         Integer index = null;
1776         for (ConcurrentMap.Entry<Integer, FlowConfig> mapEntry : staticFlows.entrySet()) {
1777             FlowConfig entry = mapEntry.getValue();
1778             if (entry.isByNameAndNodeIdEqual(newFlowConfig.getName(), newFlowConfig.getNode())) {
1779                 oldFlowConfig = entry;
1780                 index = mapEntry.getKey();
1781                 break;
1782             }
1783         }
1784
1785         if (oldFlowConfig == null) {
1786             String msg = "Attempt to modify a non existing static flow";
1787             String logMsg = msg + ": {}";
1788             log.warn(logMsg, newFlowConfig);
1789             return new Status(StatusCode.NOTFOUND, msg);
1790         }
1791
1792         // Do not attempt to reinstall the flow, warn user
1793         if (newFlowConfig.equals(oldFlowConfig)) {
1794             String msg = "No modification detected";
1795             log.info("Static flow modification skipped. New flow and old flow are the same: {}", newFlowConfig);
1796             return new Status(StatusCode.SUCCESS, msg);
1797         }
1798
1799         // If flow is installed, program the network node
1800         status = new Status(StatusCode.SUCCESS, "Saved in config");
1801         if (oldFlowConfig.installInHw()) {
1802             status = this.modifyFlowEntry(oldFlowConfig.getFlowEntry(), newFlowConfig.getFlowEntry());
1803         }
1804
1805         // Update configuration database if programming was successful
1806         if (status.isSuccess()) {
1807             newFlowConfig.setStatus(status.getDescription());
1808             staticFlows.put(index, newFlowConfig);
1809         }
1810
1811         return status;
1812     }
1813
1814     @Override
1815     public Status toggleStaticFlowStatus(String name, Node node) {
1816         return toggleStaticFlowStatus(getStaticFlow(name, node));
1817     }
1818
1819     @Override
1820     public Status toggleStaticFlowStatus(FlowConfig config) {
1821         if (config == null) {
1822             String msg = "Invalid request: null flow config";
1823             log.warn(msg);
1824             return new Status(StatusCode.BADREQUEST, msg);
1825         }
1826         // Validity check for api3 entry point
1827         if (config.isInternalFlow()) {
1828             String msg = "Invalid operation: Controller generated flow cannot be modified";
1829             String logMsg = msg + ": {}";
1830             log.warn(logMsg, config);
1831             return new Status(StatusCode.NOTACCEPTABLE, msg);
1832         }
1833
1834         // Find the config entry
1835         Integer key = 0;
1836         FlowConfig target = null;
1837         for (Map.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1838             FlowConfig conf = entry.getValue();
1839             if (conf.isByNameAndNodeIdEqual(config)) {
1840                 key = entry.getKey();
1841                 target = conf;
1842                 break;
1843             }
1844         }
1845         if (target != null) {
1846             Status status = target.validate(container);
1847             if (!status.isSuccess()) {
1848                 log.warn(status.getDescription());
1849                 return status;
1850             }
1851             status = (target.installInHw()) ? this.uninstallFlowEntry(target.getFlowEntry()) : this
1852                                     .installFlowEntry(target.getFlowEntry());
1853             if (status.isSuccess()) {
1854                 // Update Configuration database
1855                 target.setStatus(SUCCESS);
1856                 target.toggleInstallation();
1857                 staticFlows.put(key, target);
1858             }
1859             return status;
1860         }
1861
1862         return new Status(StatusCode.NOTFOUND, "Unable to locate the entry. Failed to toggle status");
1863     }
1864
1865     /**
1866      * Reinsert all static flows entries in the cache to force cache updates in
1867      * the cluster. This is useful when only some parameters were changed in the
1868      * entries, like the status.
1869      *
1870      * @param node
1871      *            The node for which the static flow configurations have to be
1872      *            refreshed. If null, all nodes static flows will be refreshed.
1873      */
1874     private void refreshClusterStaticFlowsStatus(Node node) {
1875         // Refresh cluster cache
1876         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1877             if (node == null || entry.getValue().getNode().equals(node)) {
1878                 staticFlows.put(entry.getKey(), entry.getValue());
1879             }
1880         }
1881     }
1882
1883     /**
1884      * Uninstall all the non-internal Flow Entries present in the software view.
1885      * If requested, a copy of each original flow entry will be stored in the
1886      * inactive list so that it can be re-applied when needed (This is typically
1887      * the case when running in the default container and controller moved to
1888      * container mode)
1889      *
1890      * @param preserveFlowEntries
1891      *            if true, a copy of each original entry is stored in the
1892      *            inactive list
1893      */
1894     private void uninstallAllFlowEntries(boolean preserveFlowEntries) {
1895         log.info("Uninstalling all non-internal flows");
1896
1897         List<FlowEntryInstall> toRemove = new ArrayList<FlowEntryInstall>();
1898
1899         // Store entries / create target list
1900         for (ConcurrentMap.Entry<FlowEntryInstall, FlowEntryInstall> mapEntry : installedSwView.entrySet()) {
1901             FlowEntryInstall flowEntries = mapEntry.getValue();
1902             // Skip internal generated static flows
1903             if (!flowEntries.isInternal()) {
1904                 toRemove.add(flowEntries);
1905                 // Store the original entries if requested
1906                 if (preserveFlowEntries) {
1907                     inactiveFlows.put(flowEntries.getOriginal(), flowEntries.getOriginal());
1908                 }
1909             }
1910         }
1911
1912         // Now remove the entries
1913         for (FlowEntryInstall flowEntryHw : toRemove) {
1914             Status status = this.removeEntryInternal(flowEntryHw, false);
1915             if (!status.isSuccess()) {
1916                 log.warn("Failed to remove entry: {}. The failure is: {}", flowEntryHw, status.getDescription());
1917             }
1918         }
1919     }
1920
1921     /**
1922      * Re-install all the Flow Entries present in the inactive list The inactive
1923      * list will be empty at the end of this call This function is called on the
1924      * default container instance of FRM only when the last container is deleted
1925      */
1926     private void reinstallAllFlowEntries() {
1927         log.info("Reinstalling all inactive flows");
1928
1929         for (FlowEntry flowEntry : this.inactiveFlows.keySet()) {
1930             this.addEntry(flowEntry, false);
1931         }
1932
1933         // Empty inactive list in any case
1934         inactiveFlows.clear();
1935     }
1936
1937     @Override
1938     public List<FlowConfig> getStaticFlows() {
1939         return getStaticFlowsOrderedList(staticFlows, staticFlowsOrdinal.get(0).intValue());
1940     }
1941
1942     // TODO: need to come out with a better algorithm for maintaining the order
1943     // of the configuration entries
1944     // with actual one, index associated to deleted entries cannot be reused and
1945     // map grows...
1946     private List<FlowConfig> getStaticFlowsOrderedList(ConcurrentMap<Integer, FlowConfig> flowMap, int maxKey) {
1947         List<FlowConfig> orderedList = new ArrayList<FlowConfig>();
1948         for (int i = 0; i <= maxKey; i++) {
1949             FlowConfig entry = flowMap.get(i);
1950             if (entry != null) {
1951                 orderedList.add(entry);
1952             }
1953         }
1954         return orderedList;
1955     }
1956
1957     @Override
1958     public FlowConfig getStaticFlow(String name, Node node) {
1959         ConcurrentMap.Entry<Integer, FlowConfig> entry = getStaticFlowEntry(name, node);
1960         if(entry != null) {
1961             return entry.getValue();
1962         }
1963         return null;
1964     }
1965
1966     @Override
1967     public List<FlowConfig> getStaticFlows(Node node) {
1968         List<FlowConfig> list = new ArrayList<FlowConfig>();
1969         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1970             if (entry.getValue().onNode(node)) {
1971                 list.add(entry.getValue());
1972             }
1973         }
1974         return list;
1975     }
1976
1977     @Override
1978     public List<String> getStaticFlowNamesForNode(Node node) {
1979         List<String> list = new ArrayList<String>();
1980         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1981             if (entry.getValue().onNode(node)) {
1982                 list.add(entry.getValue().getName());
1983             }
1984         }
1985         return list;
1986     }
1987
1988     @Override
1989     public List<Node> getListNodeWithConfiguredFlows() {
1990         Set<Node> set = new HashSet<Node>();
1991         for (ConcurrentMap.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
1992             set.add(entry.getValue().getNode());
1993         }
1994         return new ArrayList<Node>(set);
1995     }
1996
1997     @SuppressWarnings("unchecked")
1998     private void loadFlowConfiguration() {
1999         ObjectReader objReader = new ObjectReader();
2000         ConcurrentMap<Integer, FlowConfig> confList = (ConcurrentMap<Integer, FlowConfig>) objReader.read(this,
2001                 frmFileName);
2002
2003         ConcurrentMap<String, PortGroupConfig> pgConfig = (ConcurrentMap<String, PortGroupConfig>) objReader.read(this,
2004                 portGroupFileName);
2005
2006         if (pgConfig != null) {
2007             for (ConcurrentMap.Entry<String, PortGroupConfig> entry : pgConfig.entrySet()) {
2008                 addPortGroupConfig(entry.getKey(), entry.getValue().getMatchString(), true);
2009             }
2010         }
2011
2012         if (confList == null) {
2013             return;
2014         }
2015
2016         int maxKey = 0;
2017         for (Integer key : confList.keySet()) {
2018             if (key.intValue() > maxKey) {
2019                 maxKey = key.intValue();
2020             }
2021         }
2022
2023         for (FlowConfig conf : getStaticFlowsOrderedList(confList, maxKey)) {
2024             addStaticFlowInternal(conf, true);
2025         }
2026     }
2027
2028     @Override
2029     public Object readObject(ObjectInputStream ois) throws FileNotFoundException, IOException, ClassNotFoundException {
2030         return ois.readObject();
2031     }
2032
2033     @Override
2034     public Status saveConfig() {
2035         return saveConfigInternal();
2036     }
2037
2038     private Status saveConfigInternal() {
2039         ObjectWriter objWriter = new ObjectWriter();
2040         ConcurrentMap<Integer, FlowConfig> nonDynamicFlows = new ConcurrentHashMap<Integer, FlowConfig>();
2041         for (Integer ordinal : staticFlows.keySet()) {
2042             FlowConfig config = staticFlows.get(ordinal);
2043             // Do not save dynamic and controller generated static flows
2044             if (config.isDynamic() || config.isInternalFlow()) {
2045                 continue;
2046             }
2047             nonDynamicFlows.put(ordinal, config);
2048         }
2049         objWriter.write(nonDynamicFlows, frmFileName);
2050         objWriter.write(new ConcurrentHashMap<String, PortGroupConfig>(portGroupConfigs), portGroupFileName);
2051         return new Status(StatusCode.SUCCESS, null);
2052     }
2053
2054     @Override
2055     public void subnetNotify(Subnet sub, boolean add) {
2056     }
2057
2058     private void installImplicitARPReplyPunt(Node node) {
2059
2060         if (node == null) {
2061             return;
2062         }
2063
2064         List<String> puntAction = new ArrayList<String>();
2065         puntAction.add(ActionType.CONTROLLER.toString());
2066
2067         FlowConfig allowARP = new FlowConfig();
2068         allowARP.setInstallInHw(true);
2069         allowARP.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Punt ARP Reply" + FlowConfig.INTERNALSTATICFLOWEND);
2070         allowARP.setPriority("500");
2071         allowARP.setNode(node);
2072         allowARP.setEtherType("0x" + Integer.toHexString(EtherTypes.ARP.intValue()).toUpperCase());
2073         allowARP.setDstMac(HexEncode.bytesToHexString(switchManager.getControllerMAC()));
2074         allowARP.setActions(puntAction);
2075         addStaticFlowInternal(allowARP, true); // skip validation on internal static flow name
2076     }
2077
2078     /**
2079      * (non-Javadoc)
2080      *
2081      * @see org.opendaylight.controller.switchmanager.ISwitchManagerAware#modeChangeNotify(org.opendaylight.controller.sal.core.Node,
2082      *      boolean)
2083      *
2084      *      This method can be called from within the OSGi framework context,
2085      *      given the programming operation can take sometime, it not good
2086      *      pratice to have in it's context operations that can take time,
2087      *      hence moving off to a different thread for async processing.
2088      */
2089     private ExecutorService executor;
2090     @Override
2091     public void modeChangeNotify(final Node node, final boolean proactive) {
2092         Callable<Status> modeChangeCallable = new Callable<Status>() {
2093             @Override
2094             public Status call() throws Exception {
2095                 List<FlowConfig> defaultConfigs = new ArrayList<FlowConfig>();
2096
2097                 List<String> puntAction = new ArrayList<String>();
2098                 puntAction.add(ActionType.CONTROLLER.toString());
2099
2100                 FlowConfig allowARP = new FlowConfig();
2101                 allowARP.setInstallInHw(true);
2102                 allowARP.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Punt ARP" + FlowConfig.INTERNALSTATICFLOWEND);
2103                 allowARP.setPriority("1");
2104                 allowARP.setNode(node);
2105                 allowARP.setEtherType("0x" + Integer.toHexString(EtherTypes.ARP.intValue())
2106                         .toUpperCase());
2107                 allowARP.setActions(puntAction);
2108                 defaultConfigs.add(allowARP);
2109
2110                 FlowConfig allowLLDP = new FlowConfig();
2111                 allowLLDP.setInstallInHw(true);
2112                 allowLLDP.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Punt LLDP" + FlowConfig.INTERNALSTATICFLOWEND);
2113                 allowLLDP.setPriority("1");
2114                 allowLLDP.setNode(node);
2115                 allowLLDP.setEtherType("0x" + Integer.toHexString(EtherTypes.LLDP.intValue())
2116                         .toUpperCase());
2117                 allowLLDP.setActions(puntAction);
2118                 defaultConfigs.add(allowLLDP);
2119
2120                 List<String> dropAction = new ArrayList<String>();
2121                 dropAction.add(ActionType.DROP.toString());
2122
2123                 FlowConfig dropAllConfig = new FlowConfig();
2124                 dropAllConfig.setInstallInHw(true);
2125                 dropAllConfig.setName(FlowConfig.INTERNALSTATICFLOWBEGIN + "Catch-All Drop"
2126                         + FlowConfig.INTERNALSTATICFLOWEND);
2127                 dropAllConfig.setPriority("0");
2128                 dropAllConfig.setNode(node);
2129                 dropAllConfig.setActions(dropAction);
2130                 defaultConfigs.add(dropAllConfig);
2131
2132                 log.info("Forwarding mode for node {} set to {}", node, (proactive ? "proactive" : "reactive"));
2133                 for (FlowConfig fc : defaultConfigs) {
2134                     Status status = (proactive) ? addStaticFlowInternal(fc, false) : removeStaticFlow(fc);
2135                     if (status.isSuccess()) {
2136                         log.info("{} Proactive Static flow: {}", (proactive ? "Installed" : "Removed"), fc.getName());
2137                     } else {
2138                         log.warn("Failed to {} Proactive Static flow: {}", (proactive ? "install" : "remove"),
2139                                 fc.getName());
2140                     }
2141                 }
2142                 return new Status(StatusCode.SUCCESS);
2143             }
2144         };
2145
2146         /*
2147          * Execute the work outside the caller context, this could be an
2148          * expensive operation and we don't want to block the caller for it.
2149          */
2150         this.executor.submit(modeChangeCallable);
2151     }
2152
2153     /**
2154      * Remove from the databases all the flows installed on the node
2155      *
2156      * @param node
2157      */
2158     private void cleanDatabaseForNode(Node node) {
2159         log.info("Cleaning Flow database for Node {}", node);
2160         if (nodeFlows.containsKey(node)) {
2161             List<FlowEntryInstall> toRemove = new ArrayList<FlowEntryInstall>(nodeFlows.get(node));
2162
2163             for (FlowEntryInstall entry : toRemove) {
2164                 updateLocalDatabase(entry, false);
2165             }
2166         }
2167     }
2168
2169     private boolean doesFlowContainNodeConnector(Flow flow, NodeConnector nc) {
2170         if (nc == null) {
2171             return false;
2172         }
2173
2174         Match match = flow.getMatch();
2175         if (match.isPresent(MatchType.IN_PORT)) {
2176             NodeConnector matchPort = (NodeConnector) match.getField(MatchType.IN_PORT).getValue();
2177             if (matchPort.equals(nc)) {
2178                 return true;
2179             }
2180         }
2181         List<Action> actionsList = flow.getActions();
2182         if (actionsList != null) {
2183             for (Action action : actionsList) {
2184                 if (action instanceof Output) {
2185                     NodeConnector actionPort = ((Output) action).getPort();
2186                     if (actionPort.equals(nc)) {
2187                         return true;
2188                     }
2189                 }
2190             }
2191         }
2192         return false;
2193     }
2194
2195     @Override
2196     public void notifyNode(Node node, UpdateType type, Map<String, Property> propMap) {
2197         this.pendingEvents.offer(new NodeUpdateEvent(type, node));
2198     }
2199
2200     @Override
2201     public void notifyNodeConnector(NodeConnector nodeConnector, UpdateType type, Map<String, Property> propMap) {
2202         boolean updateStaticFlowCluster = false;
2203
2204         switch (type) {
2205         case ADDED:
2206             break;
2207         case CHANGED:
2208             Config config = (propMap == null) ? null : (Config) propMap.get(Config.ConfigPropName);
2209             if (config != null) {
2210                 switch (config.getValue()) {
2211                 case Config.ADMIN_DOWN:
2212                     log.trace("Port {} is administratively down: uninstalling interested flows", nodeConnector);
2213                     updateStaticFlowCluster = removeFlowsOnNodeConnectorDown(nodeConnector);
2214                     break;
2215                 case Config.ADMIN_UP:
2216                     log.trace("Port {} is administratively up: installing interested flows", nodeConnector);
2217                     updateStaticFlowCluster = installFlowsOnNodeConnectorUp(nodeConnector);
2218                     break;
2219                 case Config.ADMIN_UNDEF:
2220                     break;
2221                 default:
2222                 }
2223             }
2224             break;
2225         case REMOVED:
2226             // This is the case where a switch port is removed from the SDN agent space
2227             log.trace("Port {} was removed from our control: uninstalling interested flows", nodeConnector);
2228             updateStaticFlowCluster = removeFlowsOnNodeConnectorDown(nodeConnector);
2229             break;
2230         default:
2231
2232         }
2233
2234         if (updateStaticFlowCluster) {
2235             refreshClusterStaticFlowsStatus(nodeConnector.getNode());
2236         }
2237     }
2238
2239     /*
2240      * It goes through the static flows configuration, it identifies the ones
2241      * which have the specified node connector as input or output port and
2242      * install them on the network node if they are marked to be installed in
2243      * hardware and their status shows they were not installed yet
2244      */
2245     private boolean installFlowsOnNodeConnectorUp(NodeConnector nodeConnector) {
2246         boolean updated = false;
2247         List<FlowConfig> flowConfigForNode = getStaticFlows(nodeConnector.getNode());
2248         for (FlowConfig flowConfig : flowConfigForNode) {
2249             if (doesFlowContainNodeConnector(flowConfig.getFlow(), nodeConnector)) {
2250                 if (flowConfig.installInHw() && !flowConfig.getStatus().equals(SUCCESS)) {
2251                     Status status = this.installFlowEntry(flowConfig.getFlowEntry());
2252                     if (!status.isSuccess()) {
2253                         flowConfig.setStatus(status.getDescription());
2254                     } else {
2255                         flowConfig.setStatus(SUCCESS);
2256                     }
2257                     updated = true;
2258                 }
2259             }
2260         }
2261         return updated;
2262     }
2263
2264     /*
2265      * Remove from the network node all the flows which have the specified node
2266      * connector as input or output port. If any of the flow entry is a static
2267      * flow, it updates the correspondent configuration.
2268      */
2269     private boolean removeFlowsOnNodeConnectorDown(NodeConnector nodeConnector) {
2270         boolean updated = false;
2271         List<FlowEntryInstall> nodeFlowEntries = nodeFlows.get(nodeConnector.getNode());
2272         if (nodeFlowEntries == null) {
2273             return updated;
2274         }
2275         for (FlowEntryInstall fei : new ArrayList<FlowEntryInstall>(nodeFlowEntries)) {
2276             if (doesFlowContainNodeConnector(fei.getInstall().getFlow(), nodeConnector)) {
2277                 Status status = this.removeEntryInternal(fei, true);
2278                 if (!status.isSuccess()) {
2279                     continue;
2280                 }
2281                 /*
2282                  * If the flow entry is a static flow, then update its
2283                  * configuration
2284                  */
2285                 if (fei.getGroupName().equals(FlowConfig.STATICFLOWGROUP)) {
2286                     FlowConfig flowConfig = getStaticFlow(fei.getFlowName(), fei.getNode());
2287                     if (flowConfig != null) {
2288                         flowConfig.setStatus(PORTREMOVED);
2289                         updated = true;
2290                     }
2291                 }
2292             }
2293         }
2294         return updated;
2295     }
2296
2297     private FlowConfig getDerivedFlowConfig(FlowConfig original, String configName, Short port) {
2298         FlowConfig derivedFlow = new FlowConfig(original);
2299         derivedFlow.setDynamic(true);
2300         derivedFlow.setPortGroup(null);
2301         derivedFlow.setName(original.getName() + "_" + configName + "_" + port);
2302         derivedFlow.setIngressPort(port + "");
2303         return derivedFlow;
2304     }
2305
2306     private void addPortGroupFlows(PortGroupConfig config, Node node, PortGroup data) {
2307         for (FlowConfig staticFlow : staticFlows.values()) {
2308             if (staticFlow.getPortGroup() == null) {
2309                 continue;
2310             }
2311             if ((staticFlow.getNode().equals(node)) && (staticFlow.getPortGroup().equals(config.getName()))) {
2312                 for (Short port : data.getPorts()) {
2313                     FlowConfig derivedFlow = getDerivedFlowConfig(staticFlow, config.getName(), port);
2314                     addStaticFlowInternal(derivedFlow, false);
2315                 }
2316             }
2317         }
2318     }
2319
2320     private void removePortGroupFlows(PortGroupConfig config, Node node, PortGroup data) {
2321         for (FlowConfig staticFlow : staticFlows.values()) {
2322             if (staticFlow.getPortGroup() == null) {
2323                 continue;
2324             }
2325             if (staticFlow.getNode().equals(node) && staticFlow.getPortGroup().equals(config.getName())) {
2326                 for (Short port : data.getPorts()) {
2327                     FlowConfig derivedFlow = getDerivedFlowConfig(staticFlow, config.getName(), port);
2328                     removeStaticFlow(derivedFlow);
2329                 }
2330             }
2331         }
2332     }
2333
2334     @Override
2335     public void portGroupChanged(PortGroupConfig config, Map<Node, PortGroup> data, boolean add) {
2336         log.info("PortGroup Changed for: {} Data: {}", config, portGroupData);
2337         Map<Node, PortGroup> existingData = portGroupData.get(config);
2338         if (existingData != null) {
2339             for (Map.Entry<Node, PortGroup> entry : data.entrySet()) {
2340                 PortGroup existingPortGroup = existingData.get(entry.getKey());
2341                 if (existingPortGroup == null) {
2342                     if (add) {
2343                         existingData.put(entry.getKey(), entry.getValue());
2344                         addPortGroupFlows(config, entry.getKey(), entry.getValue());
2345                     }
2346                 } else {
2347                     if (add) {
2348                         existingPortGroup.getPorts().addAll(entry.getValue().getPorts());
2349                         addPortGroupFlows(config, entry.getKey(), entry.getValue());
2350                     } else {
2351                         existingPortGroup.getPorts().removeAll(entry.getValue().getPorts());
2352                         removePortGroupFlows(config, entry.getKey(), entry.getValue());
2353                     }
2354                 }
2355             }
2356         } else {
2357             if (add) {
2358                 portGroupData.put(config, data);
2359                 for (Node swid : data.keySet()) {
2360                     addPortGroupFlows(config, swid, data.get(swid));
2361                 }
2362             }
2363         }
2364     }
2365
2366     @Override
2367     public boolean addPortGroupConfig(String name, String regex, boolean restore) {
2368         PortGroupConfig config = portGroupConfigs.get(name);
2369         if (config != null) {
2370             return false;
2371         }
2372
2373         if ((portGroupProvider == null) && !restore) {
2374             return false;
2375         }
2376         if ((portGroupProvider != null) && (!portGroupProvider.isMatchCriteriaSupported(regex))) {
2377             return false;
2378         }
2379
2380         config = new PortGroupConfig(name, regex);
2381         portGroupConfigs.put(name, config);
2382         if (portGroupProvider != null) {
2383             portGroupProvider.createPortGroupConfig(config);
2384         }
2385         return true;
2386     }
2387
2388     @Override
2389     public boolean delPortGroupConfig(String name) {
2390         PortGroupConfig config = portGroupConfigs.get(name);
2391         if (config == null) {
2392             return false;
2393         }
2394
2395         if (portGroupProvider != null) {
2396             portGroupProvider.deletePortGroupConfig(config);
2397         }
2398         portGroupConfigs.remove(name);
2399         return true;
2400     }
2401
2402     private void usePortGroupConfig(String name) {
2403         PortGroupConfig config = portGroupConfigs.get(name);
2404         if (config == null) {
2405             return;
2406         }
2407         if (portGroupProvider != null) {
2408             Map<Node, PortGroup> data = portGroupProvider.getPortGroupData(config);
2409             portGroupData.put(config, data);
2410         }
2411     }
2412
2413     @Override
2414     public Map<String, PortGroupConfig> getPortGroupConfigs() {
2415         return portGroupConfigs;
2416     }
2417
2418     public boolean isPortGroupSupported() {
2419         if (portGroupProvider == null) {
2420             return false;
2421         }
2422         return true;
2423     }
2424
2425     public void setIContainer(IContainer s) {
2426         this.container = s;
2427     }
2428
2429     public void unsetIContainer(IContainer s) {
2430         if (this.container == s) {
2431             this.container = null;
2432         }
2433     }
2434
2435     @Override
2436     public PortGroupProvider getPortGroupProvider() {
2437         return portGroupProvider;
2438     }
2439
2440     public void unsetPortGroupProvider(PortGroupProvider portGroupProvider) {
2441         this.portGroupProvider = null;
2442     }
2443
2444     public void setPortGroupProvider(PortGroupProvider portGroupProvider) {
2445         this.portGroupProvider = portGroupProvider;
2446         portGroupProvider.registerPortGroupChange(this);
2447         for (PortGroupConfig config : portGroupConfigs.values()) {
2448             portGroupProvider.createPortGroupConfig(config);
2449         }
2450     }
2451
2452     public void setFrmAware(IForwardingRulesManagerAware obj) {
2453         this.frmAware.add(obj);
2454     }
2455
2456     public void unsetFrmAware(IForwardingRulesManagerAware obj) {
2457         this.frmAware.remove(obj);
2458     }
2459
2460     void setClusterContainerService(IClusterContainerServices s) {
2461         log.debug("Cluster Service set");
2462         this.clusterContainerService = s;
2463     }
2464
2465     void unsetClusterContainerService(IClusterContainerServices s) {
2466         if (this.clusterContainerService == s) {
2467             log.debug("Cluster Service removed!");
2468             this.clusterContainerService = null;
2469         }
2470     }
2471
2472     private String getContainerName() {
2473         if (container == null) {
2474             return GlobalConstants.DEFAULT.toString();
2475         }
2476         return container.getName();
2477     }
2478
2479     /**
2480      * Function called by the dependency manager when all the required
2481      * dependencies are satisfied
2482      *
2483      */
2484     void init() {
2485         frmFileName = GlobalConstants.STARTUPHOME.toString() + "frm_staticflows_" + this.getContainerName() + ".conf";
2486         portGroupFileName = GlobalConstants.STARTUPHOME.toString() + "portgroup_" + this.getContainerName() + ".conf";
2487
2488         inContainerMode = false;
2489
2490         if (portGroupProvider != null) {
2491             portGroupProvider.registerPortGroupChange(this);
2492         }
2493
2494         cacheStartup();
2495
2496         registerWithOSGIConsole();
2497
2498         /*
2499          * If we are not the first cluster node to come up, do not initialize
2500          * the static flow entries ordinal
2501          */
2502         if (staticFlowsOrdinal.size() == 0) {
2503             staticFlowsOrdinal.put(0, Integer.valueOf(0));
2504         }
2505
2506         pendingEvents = new LinkedBlockingQueue<FRMEvent>();
2507
2508         // Initialize the event handler thread
2509         frmEventHandler = new Thread(new Runnable() {
2510             @Override
2511             public void run() {
2512                 while (!stopping) {
2513                     try {
2514                         FRMEvent event = pendingEvents.take();
2515                         if (event == null) {
2516                             log.warn("Dequeued null event");
2517                             continue;
2518                         }
2519                         if (event instanceof NodeUpdateEvent) {
2520                             NodeUpdateEvent update = (NodeUpdateEvent) event;
2521                             Node node = update.getNode();
2522                             switch (update.getUpdateType()) {
2523                             case ADDED:
2524                                 addStaticFlowsToSwitch(node);
2525                                 break;
2526                             case REMOVED:
2527                                 cleanDatabaseForNode(node);
2528                                 updateStaticFlowConfigsOnNodeDown(node);
2529                                 break;
2530                             default:
2531                             }
2532                         } else if (event instanceof ErrorReportedEvent) {
2533                             ErrorReportedEvent errEvent = (ErrorReportedEvent) event;
2534                             processErrorEvent(errEvent);
2535                         } else if (event instanceof WorkOrderEvent) {
2536                             /*
2537                              * Take care of handling the remote Work request
2538                              */
2539                             WorkOrderEvent work = (WorkOrderEvent) event;
2540                             FlowEntryDistributionOrder fe = work.getFe();
2541                             if (fe != null) {
2542                                 logsync.trace("Executing the workOrder {}", fe);
2543                                 Status gotStatus = null;
2544                                 FlowEntryInstall feiCurrent = fe.getEntry();
2545                                 FlowEntryInstall feiNew = workOrder.get(fe.getEntry());
2546                                 switch (fe.getUpType()) {
2547                                 case ADDED:
2548                                     /*
2549                                      * TODO: Not still sure how to handle the
2550                                      * sync entries
2551                                      */
2552                                     gotStatus = addEntriesInternal(feiCurrent, true);
2553                                     break;
2554                                 case CHANGED:
2555                                     gotStatus = modifyEntryInternal(feiCurrent, feiNew, true);
2556                                     break;
2557                                 case REMOVED:
2558                                     gotStatus = removeEntryInternal(feiCurrent, true);
2559                                     break;
2560                                 }
2561                                 // Remove the Order
2562                                 workOrder.remove(fe);
2563                                 logsync.trace(
2564                                         "The workOrder has been executed and now the status is being returned {}", fe);
2565                                 // Place the status
2566                                 workStatus.put(fe, gotStatus);
2567                             } else {
2568                                 log.warn("Not expected null WorkOrder", work);
2569                             }
2570                         } else if (event instanceof WorkStatusCleanup) {
2571                             /*
2572                              * Take care of handling the remote Work request
2573                              */
2574                             WorkStatusCleanup work = (WorkStatusCleanup) event;
2575                             FlowEntryDistributionOrder fe = work.getFe();
2576                             if (fe != null) {
2577                                 logsync.trace("The workStatus {} is being removed", fe);
2578                                 workStatus.remove(fe);
2579                             } else {
2580                                 log.warn("Not expected null WorkStatus", work);
2581                             }
2582                         }  else if (event instanceof ContainerFlowChangeEvent) {
2583                             /*
2584                              * Whether it is an addition or removal, we have to
2585                              * recompute the merged flows entries taking into
2586                              * account all the current container flows because
2587                              * flow merging is not an injective function
2588                              */
2589                             updateFlowsContainerFlow();
2590                         } else {
2591                             log.warn("Dequeued unknown event {}", event.getClass()
2592                                     .getSimpleName());
2593                         }
2594                     } catch (InterruptedException e) {
2595                         // clear pending events
2596                         pendingEvents.clear();
2597                     }
2598                 }
2599             }
2600         }, "FRM EventHandler Collector");
2601     }
2602
2603     /**
2604      * Function called by the dependency manager when at least one dependency
2605      * become unsatisfied or when the component is shutting down because for
2606      * example bundle is being stopped.
2607      *
2608      */
2609     void destroy() {
2610         // Interrupt the thread
2611         frmEventHandler.interrupt();
2612         // Clear the pendingEvents queue
2613         pendingEvents.clear();
2614         frmAware.clear();
2615         workMonitor.clear();
2616     }
2617
2618     /**
2619      * Function called by dependency manager after "init ()" is called and after
2620      * the services provided by the class are registered in the service registry
2621      *
2622      */
2623     void start() {
2624         // Initialize graceful stop flag
2625         stopping = false;
2626
2627         // Allocate the executor service
2628         this.executor = Executors.newSingleThreadExecutor();
2629
2630         // Start event handler thread
2631         frmEventHandler.start();
2632
2633         /*
2634          * Read startup and build database if we have not already gotten the
2635          * configurations synced from another node
2636          */
2637         if (staticFlows.isEmpty()) {
2638             loadFlowConfiguration();
2639         }
2640     }
2641
2642     /**
2643      * Function called by the dependency manager before the services exported by
2644      * the component are unregistered, this will be followed by a "destroy ()"
2645      * calls
2646      */
2647     void stop() {
2648         stopping = true;
2649         uninstallAllFlowEntries(false);
2650         // Shutdown executor
2651         this.executor.shutdownNow();
2652     }
2653
2654     public void setFlowProgrammerService(IFlowProgrammerService service) {
2655         this.programmer = service;
2656     }
2657
2658     public void unsetFlowProgrammerService(IFlowProgrammerService service) {
2659         if (this.programmer == service) {
2660             this.programmer = null;
2661         }
2662     }
2663
2664     public void setSwitchManager(ISwitchManager switchManager) {
2665         this.switchManager = switchManager;
2666     }
2667
2668     public void unsetSwitchManager(ISwitchManager switchManager) {
2669         if (this.switchManager == switchManager) {
2670             this.switchManager = null;
2671         }
2672     }
2673
2674     @Override
2675     public void tagUpdated(String containerName, Node n, short oldTag, short newTag, UpdateType t) {
2676         if (!container.getName().equals(containerName)) {
2677             return;
2678         }
2679     }
2680
2681     @Override
2682     public void containerFlowUpdated(String containerName, ContainerFlow previous, ContainerFlow current, UpdateType t) {
2683         if (!container.getName().equals(containerName)) {
2684             return;
2685         }
2686         log.trace("Container {}: Updating installed flows because of container flow change: {} {}",
2687                 container.getName(), t, current);
2688         ContainerFlowChangeEvent ev = new ContainerFlowChangeEvent(previous, current, t);
2689         pendingEvents.offer(ev);
2690     }
2691
2692     @Override
2693     public void nodeConnectorUpdated(String containerName, NodeConnector nc, UpdateType t) {
2694         if (!container.getName().equals(containerName)) {
2695             return;
2696         }
2697
2698         boolean updateStaticFlowCluster = false;
2699
2700         switch (t) {
2701         case REMOVED:
2702             log.trace("Port {} was removed from container: uninstalling interested flows", nc);
2703             updateStaticFlowCluster = removeFlowsOnNodeConnectorDown(nc);
2704             break;
2705         case ADDED:
2706             log.trace("Port {} was added to container: reinstall interested flows", nc);
2707             updateStaticFlowCluster = installFlowsOnNodeConnectorUp(nc);
2708
2709             break;
2710         case CHANGED:
2711             break;
2712         default:
2713         }
2714
2715         if (updateStaticFlowCluster) {
2716             refreshClusterStaticFlowsStatus(nc.getNode());
2717         }
2718     }
2719
2720     @Override
2721     public void containerModeUpdated(UpdateType update) {
2722         // Only default container instance reacts on this event
2723         if (!container.getName().equals(GlobalConstants.DEFAULT.toString())) {
2724             return;
2725         }
2726         switch (update) {
2727         case ADDED:
2728             /*
2729              * Controller is moving to container mode. We are in the default
2730              * container context, we need to remove all our non-internal flows
2731              * to prevent any container isolation breakage. We also need to
2732              * preserve our flow so that they can be re-installed if we move
2733              * back to non container mode (no containers).
2734              */
2735             this.inContainerMode = true;
2736             this.uninstallAllFlowEntries(true);
2737             break;
2738         case REMOVED:
2739             this.inContainerMode = false;
2740             this.reinstallAllFlowEntries();
2741             break;
2742         default:
2743         }
2744
2745         // Update our configuration DB
2746         updateStaticFlowConfigsOnContainerModeChange(update);
2747     }
2748
2749     protected abstract class FRMEvent {
2750
2751     }
2752
2753     private class NodeUpdateEvent extends FRMEvent {
2754         private final Node node;
2755         private final UpdateType update;
2756
2757         public NodeUpdateEvent(UpdateType update, Node node) {
2758             this.update = update;
2759             this.node = node;
2760         }
2761
2762         public UpdateType getUpdateType() {
2763             return update;
2764         }
2765
2766         public Node getNode() {
2767             return node;
2768         }
2769     }
2770
2771     private class ErrorReportedEvent extends FRMEvent {
2772         private final long rid;
2773         private final Node node;
2774         private final Object error;
2775
2776         public ErrorReportedEvent(long rid, Node node, Object error) {
2777             this.rid = rid;
2778             this.node = node;
2779             this.error = error;
2780         }
2781
2782         public long getRequestId() {
2783             return rid;
2784         }
2785
2786         public Object getError() {
2787             return error;
2788         }
2789
2790         public Node getNode() {
2791             return node;
2792         }
2793     }
2794
2795     private class WorkOrderEvent extends FRMEvent {
2796         private FlowEntryDistributionOrder fe;
2797         private FlowEntryInstall newEntry;
2798
2799         /**
2800          * @param fe
2801          * @param newEntry
2802          */
2803         WorkOrderEvent(FlowEntryDistributionOrder fe, FlowEntryInstall newEntry) {
2804             this.fe = fe;
2805             this.newEntry = newEntry;
2806         }
2807
2808         /**
2809          * @return the fe
2810          */
2811         public FlowEntryDistributionOrder getFe() {
2812             return fe;
2813         }
2814
2815         /**
2816          * @return the newEntry
2817          */
2818         public FlowEntryInstall getNewEntry() {
2819             return newEntry;
2820         }
2821     }
2822     private class ContainerFlowChangeEvent extends FRMEvent {
2823         private final ContainerFlow previous;
2824         private final ContainerFlow current;
2825         private final UpdateType type;
2826
2827         public ContainerFlowChangeEvent(ContainerFlow previous, ContainerFlow current, UpdateType type) {
2828             this.previous = previous;
2829             this.current = current;
2830             this.type = type;
2831         }
2832
2833         public ContainerFlow getPrevious() {
2834             return this.previous;
2835         }
2836
2837         public ContainerFlow getCurrent() {
2838             return this.current;
2839         }
2840
2841         public UpdateType getType() {
2842             return this.type;
2843         }
2844     }
2845
2846
2847     private class WorkStatusCleanup extends FRMEvent {
2848         private FlowEntryDistributionOrder fe;
2849
2850         /**
2851          * @param fe
2852          */
2853         WorkStatusCleanup(FlowEntryDistributionOrder fe) {
2854             this.fe = fe;
2855         }
2856
2857         /**
2858          * @return the fe
2859          */
2860         public FlowEntryDistributionOrder getFe() {
2861             return fe;
2862         }
2863     }
2864
2865     /*
2866      * OSGI COMMANDS
2867      */
2868     @Override
2869     public String getHelp() {
2870         StringBuffer help = new StringBuffer();
2871         help.append("---FRM Matrix Application---\n");
2872         help.append("\t printMatrixData        - Prints the Matrix Configs\n");
2873         help.append("\t addMatrixConfig <name> <regex>\n");
2874         help.append("\t delMatrixConfig <name>\n");
2875         help.append("\t useMatrixConfig <name>\n");
2876         return help.toString();
2877     }
2878
2879     public void _printMatrixData(CommandInterpreter ci) {
2880         ci.println("Configs : ");
2881         ci.println("---------");
2882         ci.println(portGroupConfigs);
2883
2884         ci.println("Data : ");
2885         ci.println("------");
2886         ci.println(portGroupData);
2887     }
2888
2889     public void _addMatrixConfig(CommandInterpreter ci) {
2890         String name = ci.nextArgument();
2891         String regex = ci.nextArgument();
2892         addPortGroupConfig(name, regex, false);
2893     }
2894
2895     public void _delMatrixConfig(CommandInterpreter ci) {
2896         String name = ci.nextArgument();
2897         delPortGroupConfig(name);
2898     }
2899
2900     public void _useMatrixConfig(CommandInterpreter ci) {
2901         String name = ci.nextArgument();
2902         usePortGroupConfig(name);
2903     }
2904
2905     public void _arpPunt(CommandInterpreter ci) {
2906         String switchId = ci.nextArgument();
2907         long swid = HexEncode.stringToLong(switchId);
2908         Node node = NodeCreator.createOFNode(swid);
2909         installImplicitARPReplyPunt(node);
2910     }
2911
2912     public void _frmaddflow(CommandInterpreter ci) throws UnknownHostException {
2913         Node node = null;
2914         String nodeId = ci.nextArgument();
2915         if (nodeId == null) {
2916             ci.print("Node id not specified");
2917             return;
2918         }
2919         try {
2920             node = NodeCreator.createOFNode(Long.valueOf(nodeId));
2921         } catch (NumberFormatException e) {
2922             ci.print("Node id not a number");
2923             return;
2924         }
2925         ci.println(this.programmer.addFlow(node, getSampleFlow(node)));
2926     }
2927
2928     public void _frmremoveflow(CommandInterpreter ci) throws UnknownHostException {
2929         Node node = null;
2930         String nodeId = ci.nextArgument();
2931         if (nodeId == null) {
2932             ci.print("Node id not specified");
2933             return;
2934         }
2935         try {
2936             node = NodeCreator.createOFNode(Long.valueOf(nodeId));
2937         } catch (NumberFormatException e) {
2938             ci.print("Node id not a number");
2939             return;
2940         }
2941         ci.println(this.programmer.removeFlow(node, getSampleFlow(node)));
2942     }
2943
2944     private Flow getSampleFlow(Node node) throws UnknownHostException {
2945         NodeConnector port = NodeConnectorCreator.createOFNodeConnector((short) 24, node);
2946         NodeConnector oport = NodeConnectorCreator.createOFNodeConnector((short) 30, node);
2947         byte srcMac[] = { (byte) 0x12, (byte) 0x34, (byte) 0x56, (byte) 0x78, (byte) 0x9a, (byte) 0xbc };
2948         byte dstMac[] = { (byte) 0x1a, (byte) 0x2b, (byte) 0x3c, (byte) 0x4d, (byte) 0x5e, (byte) 0x6f };
2949         InetAddress srcIP = InetAddress.getByName("172.28.30.50");
2950         InetAddress dstIP = InetAddress.getByName("171.71.9.52");
2951         InetAddress ipMask = InetAddress.getByName("255.255.255.0");
2952         InetAddress ipMask2 = InetAddress.getByName("255.0.0.0");
2953         short ethertype = EtherTypes.IPv4.shortValue();
2954         short vlan = (short) 27;
2955         byte vlanPr = 3;
2956         Byte tos = 4;
2957         byte proto = IPProtocols.TCP.byteValue();
2958         short src = (short) 55000;
2959         short dst = 80;
2960
2961         /*
2962          * Create a SAL Flow aFlow
2963          */
2964         Match match = new Match();
2965         match.setField(MatchType.IN_PORT, port);
2966         match.setField(MatchType.DL_SRC, srcMac);
2967         match.setField(MatchType.DL_DST, dstMac);
2968         match.setField(MatchType.DL_TYPE, ethertype);
2969         match.setField(MatchType.DL_VLAN, vlan);
2970         match.setField(MatchType.DL_VLAN_PR, vlanPr);
2971         match.setField(MatchType.NW_SRC, srcIP, ipMask);
2972         match.setField(MatchType.NW_DST, dstIP, ipMask2);
2973         match.setField(MatchType.NW_TOS, tos);
2974         match.setField(MatchType.NW_PROTO, proto);
2975         match.setField(MatchType.TP_SRC, src);
2976         match.setField(MatchType.TP_DST, dst);
2977
2978         List<Action> actions = new ArrayList<Action>();
2979         actions.add(new Output(oport));
2980         actions.add(new PopVlan());
2981         actions.add(new Flood());
2982         actions.add(new Controller());
2983         return new Flow(match, actions);
2984     }
2985
2986     @Override
2987     public Status saveConfiguration() {
2988         return saveConfig();
2989     }
2990
2991     public void _frmNodeFlows(CommandInterpreter ci) {
2992         String nodeId = ci.nextArgument();
2993         Node node = Node.fromString(nodeId);
2994         if (node == null) {
2995             ci.println("frmNodeFlows <node> [verbose]");
2996             return;
2997         }
2998         boolean verbose = false;
2999         String verboseCheck = ci.nextArgument();
3000         if (verboseCheck != null) {
3001             verbose = verboseCheck.equals("true");
3002         }
3003
3004         if (!nodeFlows.containsKey(node)) {
3005             return;
3006         }
3007         // Dump per node database
3008         for (FlowEntryInstall entry : nodeFlows.get(node)) {
3009             if (!verbose) {
3010                 ci.println(node + " " + installedSwView.get(entry).getFlowName());
3011             } else {
3012                 ci.println(node + " " + installedSwView.get(entry).toString());
3013             }
3014         }
3015     }
3016
3017     public void _frmGroupFlows(CommandInterpreter ci) {
3018         String group = ci.nextArgument();
3019         if (group == null) {
3020             ci.println("frmGroupFlows <group> [verbose]");
3021             return;
3022         }
3023         boolean verbose = false;
3024         String verboseCheck = ci.nextArgument();
3025         if (verboseCheck != null) {
3026             verbose = verboseCheck.equalsIgnoreCase("true");
3027         }
3028
3029         if (!groupFlows.containsKey(group)) {
3030             return;
3031         }
3032         // Dump per node database
3033         ci.println("Group " + group + ":\n");
3034         for (FlowEntryInstall flowEntry : groupFlows.get(group)) {
3035             if (!verbose) {
3036                 ci.println(flowEntry.getNode() + " " + flowEntry.getFlowName());
3037             } else {
3038                 ci.println(flowEntry.getNode() + " " + flowEntry.toString());
3039             }
3040         }
3041     }
3042
3043     public void _frmProcessErrorEvent(CommandInterpreter ci) throws UnknownHostException {
3044         Node node = null;
3045         long reqId = 0L;
3046         String nodeId = ci.nextArgument();
3047         if (nodeId == null) {
3048             ci.print("Node id not specified");
3049             return;
3050         }
3051         String requestId = ci.nextArgument();
3052         if (requestId == null) {
3053             ci.print("Request id not specified");
3054             return;
3055         }
3056         try {
3057             node = NodeCreator.createOFNode(Long.valueOf(nodeId));
3058         } catch (NumberFormatException e) {
3059             ci.print("Node id not a number");
3060             return;
3061         }
3062         try {
3063             reqId = Long.parseLong(requestId);
3064         } catch (NumberFormatException e) {
3065             ci.print("Request id not a number");
3066             return;
3067         }
3068         // null for error object is good enough for now
3069         ErrorReportedEvent event = new ErrorReportedEvent(reqId, node, null);
3070         this.processErrorEvent(event);
3071     }
3072
3073     @Override
3074     public void flowRemoved(Node node, Flow flow) {
3075         log.trace("Received flow removed notification on {} for {}", node, flow);
3076
3077         // For flow entry identification, only node, match and priority matter
3078         FlowEntryInstall test = new FlowEntryInstall(new FlowEntry("", "", flow, node), null);
3079         FlowEntryInstall installedEntry = this.installedSwView.get(test);
3080         if (installedEntry == null) {
3081             log.trace("Entry is not known to us");
3082             return;
3083         }
3084
3085         // Update Static flow status
3086         Integer key = 0;
3087         FlowConfig target = null;
3088         for (Map.Entry<Integer, FlowConfig> entry : staticFlows.entrySet()) {
3089             FlowConfig conf = entry.getValue();
3090             if (conf.isByNameAndNodeIdEqual(installedEntry.getFlowName(), node)) {
3091                 key = entry.getKey();
3092                 target = conf;
3093                 break;
3094             }
3095         }
3096         if (target != null) {
3097             // Update Configuration database
3098             target.toggleInstallation();
3099             target.setStatus(SUCCESS);
3100             staticFlows.put(key, target);
3101         }
3102
3103         // Update software views
3104         this.updateLocalDatabase(installedEntry, false);
3105     }
3106
3107     @Override
3108     public void flowErrorReported(Node node, long rid, Object err) {
3109         log.trace("Got error {} for message rid {} from node {}", new Object[] { err, rid, node });
3110         pendingEvents.offer(new ErrorReportedEvent(rid, node, err));
3111     }
3112
3113     private void processErrorEvent(ErrorReportedEvent event) {
3114         Node node = event.getNode();
3115         long rid = event.getRequestId();
3116         Object error = event.getError();
3117         String errorString = (error == null) ? "Not provided" : error.toString();
3118         /*
3119          * If this was for a flow install, remove the corresponding entry from
3120          * the software view. If it was a Looking for the rid going through the
3121          * software database. TODO: A more efficient rid <-> FlowEntryInstall
3122          * mapping will have to be added in future
3123          */
3124         FlowEntryInstall target = null;
3125         List<FlowEntryInstall> flowEntryInstallList = nodeFlows.get(node);
3126         // flowEntryInstallList could be null.
3127         // so check for it.
3128         if(flowEntryInstallList != null) {
3129             for (FlowEntryInstall index : flowEntryInstallList) {
3130                 FlowEntryInstall entry = installedSwView.get(index);
3131                 if(entry != null) {
3132                     if (entry.getRequestId() == rid) {
3133                         target = entry;
3134                         break;
3135                     }
3136                 }
3137             }
3138         }
3139         if (target != null) {
3140             // This was a flow install, update database
3141             this.updateLocalDatabase(target, false);
3142             // also update the config
3143             if(FlowConfig.STATICFLOWGROUP.equals(target.getGroupName())) {
3144                 ConcurrentMap.Entry<Integer, FlowConfig> staticFlowEntry = getStaticFlowEntry(target.getFlowName(),target.getNode());
3145                 // staticFlowEntry should never be null.
3146                 // the null check is just an extra defensive check.
3147                 if(staticFlowEntry != null) {
3148                     staticFlows.remove(staticFlowEntry.getKey());
3149                 }
3150             }
3151         }
3152
3153         // Notify listeners
3154         if (frmAware != null) {
3155             synchronized (frmAware) {
3156                 for (IForwardingRulesManagerAware frma : frmAware) {
3157                     try {
3158                         frma.requestFailed(rid, errorString);
3159                     } catch (Exception e) {
3160                         log.warn("Failed to notify {}", frma);
3161                     }
3162                 }
3163             }
3164         }
3165     }
3166
3167     @Override
3168     public Status solicitStatusResponse(Node node, boolean blocking) {
3169         Status rv = new Status(StatusCode.INTERNALERROR);
3170
3171         if (this.programmer != null) {
3172             if (blocking) {
3173                 rv = programmer.syncSendBarrierMessage(node);
3174             } else {
3175                 rv = programmer.asyncSendBarrierMessage(node);
3176             }
3177         }
3178
3179         return rv;
3180     }
3181
3182     public void unsetIConnectionManager(IConnectionManager s) {
3183         if (s == this.connectionManager) {
3184             this.connectionManager = null;
3185         }
3186     }
3187
3188     public void setIConnectionManager(IConnectionManager s) {
3189         this.connectionManager = s;
3190     }
3191
3192     @Override
3193     public void entryCreated(Object key, String cacheName, boolean originLocal) {
3194         /*
3195          * Do nothing
3196          */
3197     }
3198
3199     @Override
3200     public void entryUpdated(Object key, Object new_value, String cacheName, boolean originLocal) {
3201         if (originLocal) {
3202             /*
3203              * Local updates are of no interest
3204              */
3205             return;
3206         }
3207         if (cacheName.equals(WORKORDERCACHE)) {
3208             logsync.trace("Got a WorkOrderCacheUpdate for {}", key);
3209             /*
3210              * This is the case of one workOrder becoming available, so we need
3211              * to dispatch the work to the appropriate handler
3212              */
3213             FlowEntryDistributionOrder fe = (FlowEntryDistributionOrder) key;
3214             FlowEntryInstall fei = fe.getEntry();
3215             if (fei == null) {
3216                 return;
3217             }
3218             Node n = fei.getNode();
3219             if (connectionManager.getLocalityStatus(n) == ConnectionLocality.LOCAL) {
3220                 logsync.trace("workOrder for fe {} processed locally", fe);
3221                 // I'm the controller in charge for the request, queue it for
3222                 // processing
3223                 pendingEvents.offer(new WorkOrderEvent(fe, (FlowEntryInstall) new_value));
3224             }
3225         } else if (cacheName.equals(WORKSTATUSCACHE)) {
3226             logsync.trace("Got a WorkStatusCacheUpdate for {}", key);
3227             /*
3228              * This is the case of one workOrder being completed and a status
3229              * returned
3230              */
3231             FlowEntryDistributionOrder fe = (FlowEntryDistributionOrder) key;
3232             /*
3233              * Check if the order was initiated by this controller in that case
3234              * we need to actually look at the status returned
3235              */
3236             if (fe.getRequestorController()
3237                     .equals(clusterContainerService.getMyAddress())) {
3238                 FlowEntryDistributionOrderFutureTask fet = workMonitor.remove(fe);
3239                 if (fet != null) {
3240                     logsync.trace("workStatus response is for us {}", fe);
3241                     // Signal we got the status
3242                     fet.gotStatus(fe, workStatus.get(fe));
3243                     pendingEvents.offer(new WorkStatusCleanup(fe));
3244                 }
3245             }
3246         }
3247     }
3248
3249     @Override
3250     public void entryDeleted(Object key, String cacheName, boolean originLocal) {
3251         /*
3252          * Do nothing
3253          */
3254     }
3255 }