opendaylight/adsal/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IPluginOutTopologyService.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 import org.opendaylight.controller.sal.core.Edge;
  13
  14 /**
  15  * This interface defines the methods that are invoked from Protocol Plugin
  16  * toward SAL. Every time a protocol plugin update the topology, it will call
  17  * this service provided by SAL so the update can migrate upward toward the
  18  * applications.
  19  */
  20 public interface IPluginOutTopologyService {
  21
  22     /**
  23      * Called to update on Edge in the topology graph
  24      *
  25      * @param topoedgeupdateList
  26      *            List of topoedgeupdates Each topoedgeupdate includes edge, its
  27      *            Properties ( BandWidth and/or Latency etc) and update type.
  28      */
  29     public void edgeUpdate(List<TopoEdgeUpdate> topoedgeupdateList);
  30
  31     /**
  32      * Called when an Edge utilization is above the safety threshold configured
  33      * on the controller
  34      *
  35      * @param edge
  36       *            The edge which bandwidth usage is above the safety level
  37     */
  38     public void edgeOverUtilized(Edge edge);
  39
  40     /**
  41      * Called when the Edge utilization is back to normal, below the safety
  42      * threshold level configured on the controller
  43      *
  44      * @param edge
  45      *            The edge which bandwidth usage is back to normal
  46      */
  47     public void edgeUtilBackToNormal(Edge edge);
  48 }