Move adsal into its own subdirectory.

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

diff --git a/opendaylight/adsal/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IListenTopoUpdates.java b/opendaylight/adsal/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IListenTopoUpdates.java
new file mode 100644 (file)
index 0000000..6850cc6
--- /dev/null
+++ b/opendaylight/adsal/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IListenTopoUpdates.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.controller.sal.topology;
+
+import java.util.List;
+
+import org.opendaylight.controller.sal.core.Edge;
+
+/**
+ * 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 topoedgeupdateList
+     *            List of topoedgeupdates Each topoedgeupdate includes edge, its
+     *            Properties ( BandWidth and/or Latency etc) and update type.
+     */
+    public void edgeUpdate(List<TopoEdgeUpdate> topoedgeupdateList);
+
+    /**
+     * 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
+     */
+    public void edgeOverUtilized(Edge edge);
+
+    /**
+     * Called when the Edge utilization is back to normal, below the safety
+     * threshold level configured on the controller
+     *
+     * @param edge
+     *            The edge which bandwidth usage is back to normal
+     */
+    public void edgeUtilBackToNormal(Edge edge);
+}