org.opendaylight.controller.containermanager

Class ContainerConfig

java.lang.Object

org.opendaylight.controller.configuration.ConfigurationObject

org.opendaylight.controller.containermanager.ContainerConfig

All Implemented Interfaces:

Serializable

public class ContainerConfig
extends org.opendaylight.controller.configuration.ConfigurationObject
implements Serializable

Container Configuration Java Object for Container Manager Represents a container configuration information for Container Manager. Objects of this class are also serialized to and deserialized from binary files through java serialization API when saving to/reading from Container Manager startup configuration file.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContainerConfig() Default constructor needed by Gson.
ContainerConfig(ContainerConfig config)
ContainerConfig(String container, String vlan, List<String> portList, List<ContainerFlowConfig> containerFlows) Constructor for the ContainerConfig.

Method Summary

Methods

Modifier and Type	Method and Description
org.opendaylight.controller.sal.utils.Status	addContainerFlows(List<ContainerFlowConfig> containerFlowConfigs) Add the proposed list of container flow configurations to this container configuration.
org.opendaylight.controller.sal.utils.Status	addNodeConnectors(List<String> ncList)
boolean	equals(Object obj)
String	getContainer()
String	getContainerAdminRole() Return the well known administrator role for this container
ContainerFlowConfig	getContainerFlowConfig(String name)
List<ContainerFlowConfig>	getContainerFlowConfigs() Returns the list of container flows configured for this container
List<ContainerFlowConfig>	getContainerFlowConfigs(Set<String> names)
List<String>	getContainerFlowConfigsNames()
List<ContainerFlowConfig>	getContainerFlows()
List<org.opendaylight.controller.sal.core.ContainerFlow>	getContainerFlowSpecs()
String	getContainerGroupName()
String	getContainerName() Returns the container name.
String	getContainerOperatorRole() Return the well known operator role for this container
List<org.opendaylight.controller.sal.core.NodeConnector>	getPortList() Parse the port list in several NodeConnector descriptor.
List<String>	getPorts() Returns the configured ports.
static String	getRegexname()
static long	getSerialversionuid()
String	getStaticVlan()
short	getStaticVlanValue() Returns Vlan value in short
String	getVlanTag() Returns the Vlan tag.
boolean	hasFlowSpecs() Returns whether this Container configuration object has any flow specs specified
int	hashCode()
boolean	hasNodeConnectors() Returns whether this Container configuration object has any ports specified
boolean	matchName(String name) Matches container name against passed parameter.
static List<org.opendaylight.controller.sal.core.NodeConnector>	nodeConnectorsFromString(List<String> nodeConnectorStrings)
org.opendaylight.controller.sal.utils.Status	removeContainerFlows(List<ContainerFlowConfig> containerFlowConfigs)
org.opendaylight.controller.sal.utils.Status	removeContainerFlows(Set<String> names)
org.opendaylight.controller.sal.utils.Status	removeNodeConnectors(List<String> ncList)
void	setContainer(String container)
void	setContainerFlows(List<ContainerFlowConfig> containerFlows)
void	setPorts(List<String> ports)
void	setStaticVlan(String staticVlan)
String	toString()
org.opendaylight.controller.sal.utils.Status	validate() Checks if this is a valid container configuration
org.opendaylight.controller.sal.utils.Status	validateContainerFlowModify(List<ContainerFlowConfig> cFlowConfigs, boolean delete)
static org.opendaylight.controller.sal.utils.Status	validateNodeConnectors(List<String> connectorList)

Methods inherited from class org.opendaylight.controller.configuration.ConfigurationObject

getRegularExpression, isValidResourceName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContainerConfig

public ContainerConfig()

Default constructor needed by Gson.

ContainerConfig

public ContainerConfig(String container,
               String vlan,
               List<String> portList,
               List<ContainerFlowConfig> containerFlows)

Constructor for the ContainerConfig.

Parameters:

container - Name of the container in this configuration

vlan - vlan assigned to this container

nodeName - the name of the node assigned to the container from this configuration

ports - the list of NodeConnectors on the Node belonging to the container

ContainerConfig

public ContainerConfig(ContainerConfig config)

Method Detail

getContainer

public String getContainer()

setContainer

public void setContainer(String container)

getStaticVlan

public String getStaticVlan()

setStaticVlan

public void setStaticVlan(String staticVlan)

getContainerFlows

public List<ContainerFlowConfig> getContainerFlows()

setContainerFlows

public void setContainerFlows(List<ContainerFlowConfig> containerFlows)

getSerialversionuid

public static long getSerialversionuid()

getRegexname

public static String getRegexname()

setPorts

public void setPorts(List<String> ports)

getContainerName

public String getContainerName()

Returns the container name.

Returns:

the container name

getVlanTag

public String getVlanTag()

Returns the Vlan tag.

Returns:

the Vlan Tag configured for this container configuration

getPorts

public List<String> getPorts()

Returns the configured ports.

Returns:

the string with the list of ports associated to the container on this configuration

getContainerFlowConfigs

public List<ContainerFlowConfig> getContainerFlowConfigs()

Returns the list of container flows configured for this container

Returns:

matchName

public boolean matchName(String name)

Matches container name against passed parameter.

Parameters:

name - name of the container to be matched

Returns:

true if the passed argument correspond with the container name in the configuration

getPortList

public List<org.opendaylight.controller.sal.core.NodeConnector> getPortList()

Parse the port list in several NodeConnector descriptor.

Returns:

the list of NodeConnector corresponding to the ports configured on this configuration

validate

public org.opendaylight.controller.sal.utils.Status validate()

Checks if this is a valid container configuration

Returns:

true, if is valid container configuration, false otherwise

validateNodeConnectors

public static org.opendaylight.controller.sal.utils.Status validateNodeConnectors(List<String> connectorList)

nodeConnectorsFromString

public static List<org.opendaylight.controller.sal.core.NodeConnector> nodeConnectorsFromString(List<String> nodeConnectorStrings)

getStaticVlanValue

public short getStaticVlanValue()

Returns Vlan value in short

Returns:

the Vlan tag

addNodeConnectors

public org.opendaylight.controller.sal.utils.Status addNodeConnectors(List<String> ncList)

removeNodeConnectors

public org.opendaylight.controller.sal.utils.Status removeNodeConnectors(List<String> ncList)

validateContainerFlowModify

public org.opendaylight.controller.sal.utils.Status validateContainerFlowModify(List<ContainerFlowConfig> cFlowConfigs,
                                                                       boolean delete)

getContainerFlowConfig

public ContainerFlowConfig getContainerFlowConfig(String name)

getContainerFlowConfigsNames

public List<String> getContainerFlowConfigsNames()

addContainerFlows

public org.opendaylight.controller.sal.utils.Status addContainerFlows(List<ContainerFlowConfig> containerFlowConfigs)

Add the proposed list of container flow configurations to this container configuration. A validation check on the operation is first run.

Parameters:

containerFlowConfigs - the proposed list of container flow configuration objects to add to this container configuration object

Returns:

the result of this request as Status object

removeContainerFlows

public org.opendaylight.controller.sal.utils.Status removeContainerFlows(List<ContainerFlowConfig> containerFlowConfigs)

removeContainerFlows

public org.opendaylight.controller.sal.utils.Status removeContainerFlows(Set<String> names)

getContainerFlowConfigs

public List<ContainerFlowConfig> getContainerFlowConfigs(Set<String> names)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hasNodeConnectors

public boolean hasNodeConnectors()

Returns whether this Container configuration object has any ports specified

Returns:

true if any port is specified, false otherwise

hasFlowSpecs

public boolean hasFlowSpecs()

Returns whether this Container configuration object has any flow specs specified

Returns:

true if any flow spec is specified, false otherwise

getContainerFlowSpecs

public List<org.opendaylight.controller.sal.core.ContainerFlow> getContainerFlowSpecs()

getContainerAdminRole

public String getContainerAdminRole()

Return the well known administrator role for this container

Returns:

The administrator role for this container

getContainerOperatorRole

public String getContainerOperatorRole()

Return the well known operator role for this container

Returns:

The operator role for this container

getContainerGroupName

public String getContainerGroupName()