Bug 1227: Removed #close() from Write Transactions.

[controller.git] / opendaylight / sal / api / src / main / java / org / opendaylight / controller / sal / topology / IListenTopoUpdates.java

diff --git a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IListenTopoUpdates.java b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IListenTopoUpdates.java
index 8a640f1e9bec8c2a2c6b34d1d358e11fcf0054ad..6850cc6373d0263fdb108bf35b652667c56fa1e0 100644 (file)
--- a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IListenTopoUpdates.java
+++ b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IListenTopoUpdates.java
@@ -1,4 +1,3 @@
-
 /*
  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
  *
@@ -9,42 +8,33 @@
 
 package org.opendaylight.controller.sal.topology;
 
-import java.util.Set;
+import java.util.List;
 
 import org.opendaylight.controller.sal.core.Edge;
-import org.opendaylight.controller.sal.core.Property;
-import org.opendaylight.controller.sal.core.UpdateType;
-
-/**
- * @file   IListenTopoUpdates.java
- *
- * @brief  Topology notifications provided by SAL toward the application
- *
- * For example an application that wants to keep up to date with the
- * updates coming from SAL it will register in the OSGi service
- * registry this interface (on a per-container base) and SAL will call it
- * providing the update
- */
 
 /**
- * Topology notifications provided by SAL toward the application
- *
+ * This interface defines the methods for topology notifications provided by SAL
+ * toward the application. For example an application that wants to keep up to
+ * date with the updates coming from SAL it will register in the OSGi service
+ * registry. This interface (on a per-container base) and SAL will call it
+ * providing the update.
  */
 public interface IListenTopoUpdates {
     /**
      * Called to update on Edge in the topology graph
      *
-     * @param e Edge being updated
-     * @param type Type of update
-     * @param props Properties of the edge, like BandWidth and/or Latency etc.
+     * @param topoedgeupdateList
+     *            List of topoedgeupdates Each topoedgeupdate includes edge, its
+     *            Properties ( BandWidth and/or Latency etc) and update type.
      */
-    public void edgeUpdate(Edge e, UpdateType type, Set<Property> props);
+    public void edgeUpdate(List<TopoEdgeUpdate> topoedgeupdateList);
 
     /**
-     * Called when an Edge utilization is above the safety threshold
-     * configured on the controller
+     * Called when an Edge utilization is above the safety threshold configured
+     * on the controller
      *
-     * @param edge The edge which bandwidth usage is above the safety level
+     * @param edge
+     *            The edge which bandwidth usage is above the safety level
      */
     public void edgeOverUtilized(Edge edge);
 
@@ -53,6 +43,7 @@ public interface IListenTopoUpdates {
      * threshold level configured on the controller
      *
      * @param edge
+     *            The edge which bandwidth usage is back to normal
      */
     public void edgeUtilBackToNormal(Edge edge);
 }