opendaylight/adsal/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IListenTopoUpdates.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.sal.topology;
  10
  11 import java.util.List;
  12
  13 import org.opendaylight.controller.sal.core.Edge;
  14
  15 /**
  16  * This interface defines the methods for topology notifications provided by SAL
  17  * toward the application. For example an application that wants to keep up to
  18  * date with the updates coming from SAL it will register in the OSGi service
  19  * registry. This interface (on a per-container base) and SAL will call it
  20  * providing the update.
  21  */
  22 @Deprecated
  23 public interface IListenTopoUpdates {
  24     /**
  25      * Called to update on Edge in the topology graph
  26      *
  27      * @param topoedgeupdateList
  28      *            List of topoedgeupdates Each topoedgeupdate includes edge, its
  29      *            Properties ( BandWidth and/or Latency etc) and update type.
  30      */
  31     public void edgeUpdate(List<TopoEdgeUpdate> topoedgeupdateList);
  32
  33     /**
  34      * Called when an Edge utilization is above the safety threshold configured
  35      * on the controller
  36      *
  37      * @param edge
  38      *            The edge which bandwidth usage is above the safety level
  39      */
  40     public void edgeOverUtilized(Edge edge);
  41
  42     /**
  43      * Called when the Edge utilization is back to normal, below the safety
  44      * threshold level configured on the controller
  45      *
  46      * @param edge
  47      *            The edge which bandwidth usage is back to normal
  48      */
  49     public void edgeUtilBackToNormal(Edge edge);
  50 }