opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/inventory/IListenInventoryUpdates.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.sal.inventory;
  11
  12 import java.util.Set;
  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  * The interface provides the methods to notify the upper applications in
  21  * regards to any inventory changes.
  22  */
  23 public interface IListenInventoryUpdates {
  24     /**
  25      * This method is called when some properties of a node are added/deleted/changed.
  26      *
  27      * @param node                      {@link org.opendaylight.controller.sal.core.Node} being updated
  28      * @param type              {@link org.opendaylight.controller.sal.core.UpdateType}
  29      * @param props             set of {@link org.opendaylight.controller.sal.core.Property} such as
  30      *                                          {@link org.opendaylight.controller.sal.core.Description} and/or
  31      *                                          {@link org.opendaylight.controller.sal.core.Tier} etc.
  32      */
  33     public void updateNode(Node node, UpdateType type, Set<Property> props);
  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 props             set 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 updateNodeConnector(NodeConnector nodeConnector,
  45             UpdateType type, Set<Property> props);
  46 }