opendaylight/adsal/sal/api/src/main/java/org/opendaylight/controller/sal/inventory/IPluginInInventoryService.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.Map;
  13 import java.util.Set;
  14 import java.util.concurrent.ConcurrentMap;
  15
  16 import org.opendaylight.controller.sal.core.Node;
  17 import org.opendaylight.controller.sal.core.NodeConnector;
  18 import org.opendaylight.controller.sal.core.Property;
  19
  20 /**
  21  * The Interface describes methods invoked from SAL toward the protocol plugin
  22  * to solicit existing inventory data.
  23  */
  24 public interface IPluginInInventoryService {
  25     /**
  26      * The method retrieves all the existing nodes and properties attached
  27      *
  28      * @return map of {@link org.opendaylight.controller.sal.core.Node} and {@link org.opendaylight.controller.sal.core.Property}
  29      */
  30     public ConcurrentMap<Node, Map<String, Property>> getNodeProps();
  31
  32     /**
  33      * The method retrieve all the existing nodeConnectors and their properties
  34      *
  35      * @param refresh true if it needs to solicit Openflow core; otherwise, retrieve from local cache.
  36      * @return map of {@link org.opendaylight.controller.sal.core.NodeConnector} and {@link org.opendaylight.controller.sal.core.Property}
  37      */
  38     public ConcurrentMap<NodeConnector, Map<String, Property>> getNodeConnectorProps(
  39             Boolean refresh);
  40
  41     /**
  42      * The method retrieves all the configured nodes that are not connected to
  43      * the controller
  44      *
  45      * @return Set of {@link org.opendaylight.controller.sal.core.Node}
  46      */
  47     public Set<Node> getConfiguredNotConnectedNodes();
  48 }