opendaylight/adsal/sal/api/src/main/java/org/opendaylight/controller/sal/core/IContainer.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 /**
  11  * @file   IContainer.java
  12  *
  13  * @brief  Interface used to retrieve the status of a given Container
  14  *
  15  *
  16  */
  17
  18 package org.opendaylight.controller.sal.core;
  19
  20 import java.util.List;
  21 import java.util.Set;
  22
  23 /**
  24  *
  25  * Interface used to retrieve the status of a given Container
  26  */
  27 @Deprecated
  28 public interface IContainer {
  29     /**
  30      * Returns the Name of the container described
  31      *
  32      * @return the container Name
  33      */
  34     public String getName();
  35
  36     /**
  37      * The list of container flows associated with a container
  38      *
  39      * @return The list of FlowSpecs associated with the container
  40      */
  41     public List<ContainerFlow> getContainerFlows();
  42
  43     /**
  44      * Return the tag on which a Node is expected to receive traffic
  45      * for a given container.
  46      *
  47      * @param n The node for which we want to get the Tag
  48      *
  49      * @return the tag on which we expect to receive traffic on a
  50      * given Node for a given container
  51      */
  52     public short getTag(Node n);
  53
  54     /**
  55      * Return an array of all the NodeConnectors that are part of the
  56      * container
  57      *
  58      * @return The array of nodeConnectors part of the container
  59      */
  60     public Set<NodeConnector> getNodeConnectors();
  61
  62     /**
  63      * Return an array of all the Nodes that are part of a container
  64      *
  65      * @return The array of Nodes that are part of the container
  66      */
  67     public Set<Node> getNodes();
  68
  69     /**
  70      * Return the well known administrator role for this container
  71      *
  72      * @return The administrator role for this container
  73      */
  74     public String getContainerAdminRole();
  75
  76     /**
  77      * Return the well known operator role for this container
  78      *
  79      * @return The operator role for this container
  80      */
  81     public String getContainerOperatorRole();
  82 }