opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/inventory/IInventoryService.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.concurrent.ConcurrentMap;
  14
  15 import org.opendaylight.controller.sal.core.Node;
  16 import org.opendaylight.controller.sal.core.NodeConnector;
  17 import org.opendaylight.controller.sal.core.Property;
  18
  19 /**
  20  * Interface class that describes methods invoked from application toward SAL to
  21  * solicit existing inventory data
  22  */
  23 public interface IInventoryService {
  24     /**
  25      * The method retrieves all the existing nodes and properties attached
  26      *
  27      * @return map of {@link org.opendaylight.controller.sal.core.Node} and {@link org.opendaylight.controller.sal.core.Property}
  28      */
  29     public ConcurrentMap<Node, Map<String, Property>> getNodeProps();
  30
  31     /**
  32      * The method retrieve all the existing nodeConnectors and their properties
  33      *
  34      * @return map of {@link org.opendaylight.controller.sal.core.NodeConnector} and {@link org.opendaylight.controller.sal.core.Property}
  35      */
  36     public ConcurrentMap<NodeConnector, Map<String, Property>> getNodeConnectorProps();
  37 }