3 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
11 * @file IContainer.java
13 * @brief Interface used to retrieve the status of a given Container
18 package org.opendaylight.controller.sal.core;
20 import java.util.List;
25 * Interface used to retrieve the status of a given Container
27 public interface IContainer {
29 * Returns the Name of the container described
31 * @return the container Name
33 public String getName();
36 * The list of container flows associated with a container
38 * @return The list of FlowSpecs associated with the container
40 public List<ContainerFlow> getContainerFlows();
43 * Return the tag on which a Node is expected to receive traffic
44 * for a given container.
46 * @param n The node for which we want to get the Tag
48 * @return the tag on which we expect to receive traffic on a
49 * given Node for a given container
51 public short getTag(Node n);
54 * Return an array of all the NodeConnectors that are part of the
57 * @return The array of nodeConnectors part of the container
59 public Set<NodeConnector> getNodeConnectors();
62 * Return an array of all the Nodes that are part of a container
64 * @return The array of Nodes that are part of the container
66 public Set<Node> getNodes();