opendaylight/switchmanager/api/src/main/java/org/opendaylight/controller/switchmanager/IInventoryListener.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9
  10 package org.opendaylight.controller.switchmanager;
  11
  12 import java.util.Map;
  13
  14 import org.opendaylight.controller.sal.core.Node;
  15 import org.opendaylight.controller.sal.core.NodeConnector;
  16 import org.opendaylight.controller.sal.core.Property;
  17 import org.opendaylight.controller.sal.core.UpdateType;
  18
  19 /**
  20  * Primary purpose of this interface is to provide methods to listen to inventory changes
  21  */
  22 public interface IInventoryListener {
  23     /**
  24      * This method is called when some properties of a node are added/deleted/changed.
  25      *
  26      * @param node                      {@link org.opendaylight.controller.sal.core.Node} being updated
  27      * @param type              {@link org.opendaylight.controller.sal.core.UpdateType}
  28      * @param propMap           map of {@link org.opendaylight.controller.sal.core.Property} such as
  29      *                                          {@link org.opendaylight.controller.sal.core.Description} and/or
  30      *                                          {@link org.opendaylight.controller.sal.core.Tier} etc.
  31      */
  32     public void notifyNode(Node node, UpdateType type,
  33             Map<String, Property> propMap);
  34
  35     /**
  36      * This method is called when some properties of a node connector are added/deleted/changed.
  37      *
  38      * @param nodeConnector {@link org.opendaylight.controller.sal.core.NodeConnector} being updated
  39      * @param type              {@link org.opendaylight.controller.sal.core.UpdateType}
  40      * @param propMap           map of {@link org.opendaylight.controller.sal.core.Property} such as
  41      *                                          {@link org.opendaylight.controller.sal.core.Description} and/or
  42      *                                          {@link org.opendaylight.controller.sal.core.State} etc.
  43      */
  44     public void notifyNodeConnector(NodeConnector nodeConnector,
  45             UpdateType type, Map<String, Property> propMap);
  46 }